From bf25694ccddc48c9b14c540bae95249fdef56a15 Mon Sep 17 00:00:00 2001 From: Russell Cohen Date: Wed, 22 Jun 2022 16:15:35 -0400 Subject: [PATCH] Release 6/22 (#1486) * Update models * Update versions --- .../customize/route53/Route53Decorator.kt | 3 +- aws/sdk/aws-models/application-insights.json | 241 +- aws/sdk/aws-models/auditmanager.json | 31 +- aws/sdk/aws-models/backup-gateway.json | 168 +- aws/sdk/aws-models/budgets.json | 96 +- aws/sdk/aws-models/ce.json | 536 +- aws/sdk/aws-models/chime-sdk-meetings.json | 269 +- aws/sdk/aws-models/chime-sdk-messaging.json | 294 +- aws/sdk/aws-models/codeartifact.json | 242 +- aws/sdk/aws-models/cognito-idp.json | 72 +- aws/sdk/aws-models/connect.json | 2069 ++++++- aws/sdk/aws-models/connectcampaigns.json | 2419 ++++++++ aws/sdk/aws-models/dms.json | 1255 +++- aws/sdk/aws-models/drs.json | 1027 +++- aws/sdk/aws-models/ds.json | 400 +- aws/sdk/aws-models/dynamodb.json | 54 +- aws/sdk/aws-models/ec2.json | 43 +- aws/sdk/aws-models/ecs.json | 177 +- aws/sdk/aws-models/finspace-data.json | 533 +- aws/sdk/aws-models/forecast.json | 114 +- aws/sdk/aws-models/frauddetector.json | 13 +- aws/sdk/aws-models/guardduty.json | 489 +- aws/sdk/aws-models/iam.json | 238 +- aws/sdk/aws-models/iotsitewise.json | 36 +- aws/sdk/aws-models/kafka.json | 8 +- aws/sdk/aws-models/kendra.json | 310 +- aws/sdk/aws-models/lookoutmetrics.json | 183 +- aws/sdk/aws-models/m2.json | 5175 +++++++++++++++++ aws/sdk/aws-models/mediaconvert.json | 35 +- aws/sdk/aws-models/neptune.json | 613 +- aws/sdk/aws-models/outposts.json | 297 + aws/sdk/aws-models/proton.json | 1494 ++++- aws/sdk/aws-models/redshift-data.json | 82 +- aws/sdk/aws-models/redshift.json | 82 +- aws/sdk/aws-models/redshiftserverless.json | 4023 +++++++++++++ aws/sdk/aws-models/route53.json | 1804 ++++-- aws/sdk/aws-models/sagemaker.json | 2 +- aws/sdk/aws-models/secretsmanager.json | 6 +- aws/sdk/aws-models/securityhub.json | 2316 +++++++- .../servicecatalog-appregistry.json | 144 +- aws/sdk/aws-models/streams.dynamodb.json | 38 +- aws/sdk/aws-models/transcribe.json | 975 ++-- aws/sdk/aws-models/voice-id.json | 107 +- aws/sdk/aws-models/wellarchitected.json | 93 +- aws/sdk/aws-models/workspaces.json | 34 +- gradle.properties | 4 +- 46 files changed, 26099 insertions(+), 2545 deletions(-) create mode 100644 aws/sdk/aws-models/connectcampaigns.json create mode 100644 aws/sdk/aws-models/m2.json create mode 100644 aws/sdk/aws-models/redshiftserverless.json diff --git a/aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/customize/route53/Route53Decorator.kt b/aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/customize/route53/Route53Decorator.kt index 09c59daab..17c0c3233 100644 --- a/aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/customize/route53/Route53Decorator.kt +++ b/aws/sdk-codegen/src/main/kotlin/software/amazon/smithy/rustsdk/customize/route53/Route53Decorator.kt @@ -32,6 +32,7 @@ class Route53Decorator : RustCodegenDecorator { override val name: String = "Route53" override val order: Byte = 0 private val logger: Logger = Logger.getLogger(javaClass.name) + private val resourceShapes = setOf(ShapeId.from("com.amazonaws.route53#ResourceId"), ShapeId.from("com.amazonaws.route53#ChangeId")) private fun applies(service: ServiceShape) = service.id == Route53 @@ -59,7 +60,7 @@ class Route53Decorator : RustCodegenDecorator { } private fun isResourceId(shape: Shape): Boolean { - return (shape is MemberShape && shape.target == ShapeId.from("com.amazonaws.route53#ResourceId")) && shape.hasTrait() + return (shape is MemberShape && resourceShapes.contains(shape.target)) && shape.hasTrait() } } diff --git a/aws/sdk/aws-models/application-insights.json b/aws/sdk/aws-models/application-insights.json index 6a1f64bbd..473ab4006 100644 --- a/aws/sdk/aws-models/application-insights.json +++ b/aws/sdk/aws-models/application-insights.json @@ -41,7 +41,7 @@ "code": "AccessDeniedException", "httpResponseCode": 403 }, - "smithy.api#documentation": "

\n User does not have permissions to perform this action.\n

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

User does not have permissions to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -71,19 +71,19 @@ "ComponentRemarks": { "target": "com.amazonaws.applicationinsights#Remarks", "traits": { - "smithy.api#documentation": "

\n If logging is supported for the resource type, indicates whether the component has configured logs to be monitored.\n

" + "smithy.api#documentation": "

If logging is supported for the resource type, indicates whether the component has\n configured logs to be monitored.

" } }, "ResourceType": { "target": "com.amazonaws.applicationinsights#ResourceType", "traits": { - "smithy.api#documentation": "

The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

" + "smithy.api#documentation": "

The resource type. Supported resource types include EC2 instances, Auto Scaling group,\n Classic ELB, Application ELB, and SQS Queue.

" } }, "OsType": { "target": "com.amazonaws.applicationinsights#OsType", "traits": { - "smithy.api#documentation": "

\n The operating system of the component.\n

" + "smithy.api#documentation": "

The operating system of the component.

" } }, "Tier": { @@ -101,12 +101,12 @@ "DetectedWorkload": { "target": "com.amazonaws.applicationinsights#DetectedWorkload", "traits": { - "smithy.api#documentation": "

\n Workloads detected in the application component. \n

" + "smithy.api#documentation": "

Workloads detected in the application component.

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

Describes a standalone resource or similarly grouped resources that the application is made\n up of.

" + "smithy.api#documentation": "

Describes a standalone resource or similarly grouped resources that the application is\n made up of.

" } }, "com.amazonaws.applicationinsights#ApplicationComponentList": { @@ -133,19 +133,19 @@ "OpsItemSNSTopicArn": { "target": "com.amazonaws.applicationinsights#OpsItemSNSTopicArn", "traits": { - "smithy.api#documentation": "

\n The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications\n for opsItem updates.\n

" + "smithy.api#documentation": "

The SNS topic provided to Application Insights that is associated to the created\n opsItems to receive SNS notifications for opsItem updates.

" } }, "OpsCenterEnabled": { "target": "com.amazonaws.applicationinsights#OpsCenterEnabled", "traits": { - "smithy.api#documentation": "

\n Indicates whether Application Insights will create opsItems for any problem detected by Application\n Insights for an application.\n

" + "smithy.api#documentation": "

Indicates whether Application Insights will create opsItems for any problem detected by\n Application Insights for an application.

" } }, "CWEMonitorEnabled": { "target": "com.amazonaws.applicationinsights#CWEMonitorEnabled", "traits": { - "smithy.api#documentation": "

\n Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.\n

" + "smithy.api#documentation": "

Indicates whether Application Insights can listen to CloudWatch events for the\n application resources, such as instance terminated, failed\n deployment, and others.

" } }, "Remarks": { @@ -155,10 +155,16 @@ } }, "AutoConfigEnabled": { - "target": "com.amazonaws.applicationinsights#AutoConfigEnabled" + "target": "com.amazonaws.applicationinsights#AutoConfigEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether auto-configuration is turned on for this application.

" + } }, "DiscoveryType": { - "target": "com.amazonaws.applicationinsights#DiscoveryType" + "target": "com.amazonaws.applicationinsights#DiscoveryType", + "traits": { + "smithy.api#documentation": "

\n The method used by Application Insights to onboard your resources.\n

" + } } }, "traits": { @@ -276,42 +282,42 @@ "MonitoredResourceARN": { "target": "com.amazonaws.applicationinsights#ConfigurationEventMonitoredResourceARN", "traits": { - "smithy.api#documentation": "

\n The resource monitored by Application Insights.\n

" + "smithy.api#documentation": "

The resource monitored by Application Insights.

" } }, "EventStatus": { "target": "com.amazonaws.applicationinsights#ConfigurationEventStatus", "traits": { - "smithy.api#documentation": "

\n The status of the configuration update event. Possible values include INFO, WARN, and ERROR.\n

" + "smithy.api#documentation": "

The status of the configuration update event. Possible values include INFO, WARN, and\n ERROR.

" } }, "EventResourceType": { "target": "com.amazonaws.applicationinsights#ConfigurationEventResourceType", "traits": { - "smithy.api#documentation": "

\n The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM.\n

" + "smithy.api#documentation": "

The resource type that Application Insights attempted to configure, for example,\n CLOUDWATCH_ALARM.

" } }, "EventTime": { "target": "com.amazonaws.applicationinsights#ConfigurationEventTime", "traits": { - "smithy.api#documentation": "

\n The timestamp of the event. \n

" + "smithy.api#documentation": "

The timestamp of the event.

" } }, "EventDetail": { "target": "com.amazonaws.applicationinsights#ConfigurationEventDetail", "traits": { - "smithy.api#documentation": "

\n The details of the event in plain text. \n

" + "smithy.api#documentation": "

The details of the event in plain text.

" } }, "EventResourceName": { "target": "com.amazonaws.applicationinsights#ConfigurationEventResourceName", "traits": { - "smithy.api#documentation": "

\n The name of the resource Application Insights attempted to configure. \n

" + "smithy.api#documentation": "

The name of the resource Application Insights attempted to configure.

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

\n The event information.\n

" + "smithy.api#documentation": "

The event information.

" } }, "com.amazonaws.applicationinsights#ConfigurationEventDetail": { @@ -418,32 +424,44 @@ "OpsCenterEnabled": { "target": "com.amazonaws.applicationinsights#OpsCenterEnabled", "traits": { - "smithy.api#documentation": "

\n When set to true, creates opsItems for any problems detected on an application.\n

" + "smithy.api#documentation": "

When set to true, creates opsItems for any problems detected on an\n application.

" } }, "CWEMonitorEnabled": { "target": "com.amazonaws.applicationinsights#CWEMonitorEnabled", "traits": { - "smithy.api#documentation": "

\n Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.\n

" + "smithy.api#documentation": "

Indicates whether Application Insights can listen to CloudWatch events for the\n application resources, such as instance terminated, failed\n deployment, and others.

" } }, "OpsItemSNSTopicArn": { "target": "com.amazonaws.applicationinsights#OpsItemSNSTopicArn", "traits": { - "smithy.api#documentation": "

\n The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to\n receive notifications for updates to the opsItem.\n

" + "smithy.api#documentation": "

The SNS topic provided to Application Insights that is associated to the created\n opsItem. Allows you to receive notifications for updates to the opsItem.

" } }, "Tags": { "target": "com.amazonaws.applicationinsights#TagList", "traits": { - "smithy.api#documentation": "

List of tags to add to the application.\n tag key (Key) and an associated tag value (Value). The maximum\n length of a tag key is 128 characters. The maximum length of a tag value is 256\n characters.

" + "smithy.api#documentation": "

List of tags to add to the application. tag key (Key) and an associated tag\n value (Value). The maximum length of a tag key is 128 characters. The maximum\n length of a tag value is 256 characters.

" } }, "AutoConfigEnabled": { - "target": "com.amazonaws.applicationinsights#AutoConfigEnabled" + "target": "com.amazonaws.applicationinsights#AutoConfigEnabled", + "traits": { + "smithy.api#documentation": "

Indicates whether Application Insights automatically configures unmonitored resources\n in the resource group.

" + } }, "AutoCreate": { - "target": "com.amazonaws.applicationinsights#AutoCreate" + "target": "com.amazonaws.applicationinsights#AutoCreate", + "traits": { + "smithy.api#documentation": "

Configures all of the resources in the resource group by applying the recommended\n configurations.

" + } + }, + "GroupingType": { + "target": "com.amazonaws.applicationinsights#GroupingType", + "traits": { + "smithy.api#documentation": "

Application Insights can create applications based on a resource group or on an account.\n To create an account-based application using all of the resources in the account, set this parameter to ACCOUNT_BASED.\n

" + } } } }, @@ -567,14 +585,14 @@ "Pattern": { "target": "com.amazonaws.applicationinsights#LogPatternRegex", "traits": { - "smithy.api#documentation": "

The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

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

The log pattern. The pattern must be DFA compatible. Patterns that utilize forward\n lookahead or backreference constructions are not supported.

", "smithy.api#required": {} } }, "Rank": { "target": "com.amazonaws.applicationinsights#LogPatternRank", "traits": { - "smithy.api#documentation": "

Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank.\n Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.\n

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

Rank of the log pattern. Must be a value between 1 and\n 1,000,000. The patterns are sorted by rank, so we recommend that you set\n your highest priority patterns with the lowest rank. A pattern of rank 1 will\n be the first to get matched to a log line. A pattern of rank 1,000,000 will be\n last to get matched. When you configure custom log patterns from the console, a\n Low severity pattern translates to a 750,000 rank. A\n Medium severity pattern translates to a 500,000 rank. And a\n High severity pattern translates to a 250,000 rank. Rank\n values less than 1 or greater than 1,000,000 are reserved for\n AWS-provided patterns.

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

Removes the specified application from monitoring. Does not delete the application.

" + "smithy.api#documentation": "

Removes the specified application from monitoring. Does not delete the\n application.

" } }, "com.amazonaws.applicationinsights#DeleteApplicationRequest": { @@ -669,7 +687,7 @@ } ], "traits": { - "smithy.api#documentation": "

Ungroups a custom component. When you ungroup custom components, all applicable\n monitors that are set up for the component are removed and the instances revert to their standalone status.

" + "smithy.api#documentation": "

Ungroups a custom component. When you ungroup custom components, all applicable monitors\n that are set up for the component are removed and the instances revert to their standalone\n status.

" } }, "com.amazonaws.applicationinsights#DeleteComponentRequest": { @@ -817,7 +835,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a component and lists the resources that are grouped together in a component.

" + "smithy.api#documentation": "

Describes a component and lists the resources that are grouped together in a\n component.

" } }, "com.amazonaws.applicationinsights#DescribeComponentConfiguration": { @@ -886,7 +904,7 @@ "Tier": { "target": "com.amazonaws.applicationinsights#Tier", "traits": { - "smithy.api#documentation": "

The tier of the application component. Supported tiers include\n DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER,\n and DEFAULT.

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

The tier of the application component.

", "smithy.api#required": {} } } @@ -898,7 +916,7 @@ "ComponentConfiguration": { "target": "com.amazonaws.applicationinsights#ComponentConfiguration", "traits": { - "smithy.api#documentation": "

The recommended configuration settings of the component. The value is the escaped JSON of the configuration.

" + "smithy.api#documentation": "

The recommended configuration settings of the component. The value is the escaped JSON\n of the configuration.

" } } } @@ -934,13 +952,13 @@ "Tier": { "target": "com.amazonaws.applicationinsights#Tier", "traits": { - "smithy.api#documentation": "

The tier of the application component. Supported tiers include\n DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB,\n SQL_SERVER, and DEFAULT\n

" + "smithy.api#documentation": "

The tier of the application component. Supported tiers include\n DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB,\n SQL_SERVER, and DEFAULT\n

" } }, "ComponentConfiguration": { "target": "com.amazonaws.applicationinsights#ComponentConfiguration", "traits": { - "smithy.api#documentation": "

The configuration settings of the component. The value is the escaped JSON of the configuration.

" + "smithy.api#documentation": "

The configuration settings of the component. The value is the escaped JSON of the\n configuration.

" } } } @@ -1220,7 +1238,7 @@ "name": "applicationinsights" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon CloudWatch Application Insights\n

Amazon CloudWatch Application Insights is a service that\n helps you detect common problems with your applications. It\n enables you to pinpoint the source of issues in your applications (built with technologies\n such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into\n detected problems.

\n

After you onboard your application, CloudWatch Application Insights identifies, \n recommends, and sets up metrics and logs. It continuously analyzes and\n correlates your metrics and logs for unusual behavior to surface actionable problems with\n your application. For example, if your application is slow and unresponsive and leading to\n HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you\n that a memory pressure problem with your SQL Server database is occurring. It bases this\n analysis on impactful metrics and log errors.

", + "smithy.api#documentation": "Amazon CloudWatch Application Insights\n

Amazon CloudWatch Application Insights is a service that helps you detect common\n problems with your applications. It enables you to pinpoint the source of issues in your\n applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL\n Server), by providing key insights into detected problems.

\n

After you onboard your application, CloudWatch Application Insights identifies,\n recommends, and sets up metrics and logs. It continuously analyzes and correlates your\n metrics and logs for unusual behavior to surface actionable problems with your application.\n For example, if your application is slow and unresponsive and leading to HTTP 500 errors in\n your Application Load Balancer (ALB), Application Insights informs you that a memory\n pressure problem with your SQL Server database is occurring. It bases this analysis on\n impactful metrics and log errors.

", "smithy.api#title": "Amazon CloudWatch Application Insights" }, "version": "2018-11-25", @@ -1377,6 +1395,17 @@ ] } }, + "com.amazonaws.applicationinsights#GroupingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACCOUNT_BASED", + "name": "ACCOUNT_BASED" + } + ] + } + }, "com.amazonaws.applicationinsights#HealthEventArn": { "type": "string" }, @@ -1569,7 +1598,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:\n

\n
    \n
  • \n

    INFO: creating a new alarm or updating an alarm threshold.

    \n
    • \n
  • \n

    WARN: alarm not created due to insufficient data points used to predict thresholds.

    \n
    • \n
  • \n

    ERROR: alarm not created due to permission errors or exceeding quotas.

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

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by\n Application Insights. Examples of events represented are:

\n
    \n
  • \n

    INFO: creating a new alarm or updating an alarm threshold.

    \n
    • \n
  • \n

    WARN: alarm not created due to insufficient data points used to predict\n thresholds.

    \n
    • \n
  • \n

    ERROR: alarm not created due to permission errors or exceeding quotas.

    \n
    • \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1601,7 +1630,7 @@ "EventStatus": { "target": "com.amazonaws.applicationinsights#ConfigurationEventStatus", "traits": { - "smithy.api#documentation": "

The status of the configuration update event. Possible values include INFO, WARN, and ERROR.

" + "smithy.api#documentation": "

The status of the configuration update event. Possible values include INFO, WARN, and\n ERROR.

" } }, "MaxResults": { @@ -1613,7 +1642,7 @@ "NextToken": { "target": "com.amazonaws.applicationinsights#PaginationToken", "traits": { - "smithy.api#documentation": "

The NextToken value returned from a previous paginated ListConfigurationHistory request where\n MaxResults was used and the results exceeded the value of that parameter. Pagination\n continues from the end of the previous results that returned the NextToken value. This\n value is null when there are no more results to return.

" + "smithy.api#documentation": "

The NextToken value returned from a previous paginated\n ListConfigurationHistory request where MaxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the NextToken value. This value is\n null when there are no more results to return.

" } } } @@ -1831,7 +1860,7 @@ "StartTime": { "target": "com.amazonaws.applicationinsights#StartTime", "traits": { - "smithy.api#documentation": "

The time when the problem was detected, in epoch\n seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.

" + "smithy.api#documentation": "

The time when the problem was detected, in epoch seconds. If you don't specify a time\n frame for the request, problems within the past seven days are returned.

" } }, "EndTime": { @@ -1853,7 +1882,10 @@ } }, "ComponentName": { - "target": "com.amazonaws.applicationinsights#ComponentName" + "target": "com.amazonaws.applicationinsights#ComponentName", + "traits": { + "smithy.api#documentation": "

The name of the component.

" + } } } }, @@ -1873,7 +1905,10 @@ } }, "ResourceGroupName": { - "target": "com.amazonaws.applicationinsights#ResourceGroupName" + "target": "com.amazonaws.applicationinsights#ResourceGroupName", + "traits": { + "smithy.api#documentation": "

The name of the resource group.

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

Retrieve a list of the tags (keys and values) that are associated with a specified\n application. A tag is a label that you optionally define and associate\n with an application. Each tag consists of a required tag key and an\n optional associated tag value. A tag key is a general label that\n acts as a category for more specific tag values. A tag value acts as a descriptor within\n a tag key.

" + "smithy.api#documentation": "

Retrieve a list of the tags (keys and values) that are associated with a specified\n application. A tag is a label that you optionally define and associate\n with an application. Each tag consists of a required tag key and an\n optional associated tag value. A tag key is a general label that acts\n as a category for more specific tag values. A tag value acts as a descriptor within a tag\n key.

" } }, "com.amazonaws.applicationinsights#ListTagsForResourceRequest": { @@ -1915,7 +1950,7 @@ "Tags": { "target": "com.amazonaws.applicationinsights#TagList", "traits": { - "smithy.api#documentation": "

An array that lists all the tags that are associated with the application. Each tag\n consists of a required tag key (Key) and an associated tag value\n (Value).

" + "smithy.api#documentation": "

An array that lists all the tags that are associated with the application. Each tag\n consists of a required tag key (Key) and an associated tag value\n (Value).

" } } } @@ -1948,30 +1983,30 @@ "PatternSetName": { "target": "com.amazonaws.applicationinsights#LogPatternSetName", "traits": { - "smithy.api#documentation": "

The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot\n be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

" + "smithy.api#documentation": "

The name of the log pattern. A log pattern name can contain as many as 30 characters,\n and it cannot be empty. The characters can be Unicode letters, digits, or one of the\n following symbols: period, dash, underscore.

" } }, "PatternName": { "target": "com.amazonaws.applicationinsights#LogPatternName", "traits": { - "smithy.api#documentation": "

The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot\n be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

" + "smithy.api#documentation": "

The name of the log pattern. A log pattern name can contain as many as 50 characters,\n and it cannot be empty. The characters can be Unicode letters, digits, or one of the\n following symbols: period, dash, underscore.

" } }, "Pattern": { "target": "com.amazonaws.applicationinsights#LogPatternRegex", "traits": { - "smithy.api#documentation": "

A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot\n be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

" + "smithy.api#documentation": "

A regular expression that defines the log pattern. A log pattern can contain as many as\n 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that\n utilize forward lookahead or backreference constructions are not supported.

" } }, "Rank": { "target": "com.amazonaws.applicationinsights#LogPatternRank", "traits": { - "smithy.api#documentation": "

Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank.\n Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.\n

" + "smithy.api#documentation": "

Rank of the log pattern. Must be a value between 1 and\n 1,000,000. The patterns are sorted by rank, so we recommend that you set\n your highest priority patterns with the lowest rank. A pattern of rank 1 will\n be the first to get matched to a log line. A pattern of rank 1,000,000 will be\n last to get matched. When you configure custom log patterns from the console, a\n Low severity pattern translates to a 750,000 rank. A\n Medium severity pattern translates to a 500,000 rank. And a\n High severity pattern translates to a 250,000 rank. Rank\n values less than 1 or greater than 1,000,000 are reserved for\n AWS-provided patterns.

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

An object that defines the log patterns that belongs to a LogPatternSet.

" + "smithy.api#documentation": "

An object that defines the log patterns that belongs to a\n LogPatternSet.

" } }, "com.amazonaws.applicationinsights#LogPatternList": { @@ -2062,7 +2097,7 @@ "StartTime": { "target": "com.amazonaws.applicationinsights#StartTime", "traits": { - "smithy.api#documentation": "

The time when the observation was first detected, in epoch seconds.

" + "smithy.api#documentation": "

The time when the observation was first detected, in epoch seconds.

" } }, "EndTime": { @@ -2092,7 +2127,7 @@ "LineTime": { "target": "com.amazonaws.applicationinsights#LineTime", "traits": { - "smithy.api#documentation": "

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

" + "smithy.api#documentation": "

The timestamp in the CloudWatch Logs that specifies when the matched line\n occurred.

" } }, "LogText": { @@ -2134,7 +2169,7 @@ "CloudWatchEventId": { "target": "com.amazonaws.applicationinsights#CloudWatchEventId", "traits": { - "smithy.api#documentation": "

The ID of the CloudWatch Event-based observation related to the detected problem.

" + "smithy.api#documentation": "

The ID of the CloudWatch Event-based observation related to the detected problem.\n

" } }, "CloudWatchEventSource": { @@ -2176,151 +2211,151 @@ "HealthEventDescription": { "target": "com.amazonaws.applicationinsights#HealthEventDescription", "traits": { - "smithy.api#documentation": "

The description of the AWS Health event provided by the service, such as Amazon EC2.

" + "smithy.api#documentation": "

The description of the AWS Health event provided by the service, such as Amazon EC2.\n

" } }, "CodeDeployDeploymentId": { "target": "com.amazonaws.applicationinsights#CodeDeployDeploymentId", "traits": { - "smithy.api#documentation": "

The deployment ID of the CodeDeploy-based observation related to the detected problem.

" + "smithy.api#documentation": "

The deployment ID of the CodeDeploy-based observation related to the detected problem.\n

" } }, "CodeDeployDeploymentGroup": { "target": "com.amazonaws.applicationinsights#CodeDeployDeploymentGroup", "traits": { - "smithy.api#documentation": "

\n The deployment group to which the CodeDeploy deployment belongs.\n

" + "smithy.api#documentation": "

The deployment group to which the CodeDeploy deployment belongs.

" } }, "CodeDeployState": { "target": "com.amazonaws.applicationinsights#CodeDeployState", "traits": { - "smithy.api#documentation": "

\n The status of the CodeDeploy deployment, for example SUCCESS or FAILURE. \n

" + "smithy.api#documentation": "

The status of the CodeDeploy deployment, for example SUCCESS or \n FAILURE.

" } }, "CodeDeployApplication": { "target": "com.amazonaws.applicationinsights#CodeDeployApplication", "traits": { - "smithy.api#documentation": "

\n The CodeDeploy application to which the deployment belongs.\n

" + "smithy.api#documentation": "

The CodeDeploy application to which the deployment belongs.

" } }, "CodeDeployInstanceGroupId": { "target": "com.amazonaws.applicationinsights#CodeDeployInstanceGroupId", "traits": { - "smithy.api#documentation": "

\n The instance group to which the CodeDeploy instance belongs. \n

" + "smithy.api#documentation": "

The instance group to which the CodeDeploy instance belongs.

" } }, "Ec2State": { "target": "com.amazonaws.applicationinsights#Ec2State", "traits": { - "smithy.api#documentation": "

\n The state of the instance, such as STOPPING or TERMINATING.\n

" + "smithy.api#documentation": "

The state of the instance, such as STOPPING or TERMINATING.\n

" } }, "RdsEventCategories": { "target": "com.amazonaws.applicationinsights#RdsEventCategories", "traits": { - "smithy.api#documentation": "

\n The category of an RDS event.\n

" + "smithy.api#documentation": "

The category of an RDS event.

" } }, "RdsEventMessage": { "target": "com.amazonaws.applicationinsights#RdsEventMessage", "traits": { - "smithy.api#documentation": "

\n The message of an RDS event.\n

" + "smithy.api#documentation": "

The message of an RDS event.

" } }, "S3EventName": { "target": "com.amazonaws.applicationinsights#S3EventName", "traits": { - "smithy.api#documentation": "

\n The name of the S3 CloudWatch Event-based observation.\n

" + "smithy.api#documentation": "

The name of the S3 CloudWatch Event-based observation.

" } }, "StatesExecutionArn": { "target": "com.amazonaws.applicationinsights#StatesExecutionArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the step function execution-based observation.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the step function execution-based observation.\n

" } }, "StatesArn": { "target": "com.amazonaws.applicationinsights#StatesArn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the step function-based observation.\n

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the step function-based observation.

" } }, "StatesStatus": { "target": "com.amazonaws.applicationinsights#StatesStatus", "traits": { - "smithy.api#documentation": "

\n The status of the step function-related observation.\n

" + "smithy.api#documentation": "

The status of the step function-related observation.

" } }, "StatesInput": { "target": "com.amazonaws.applicationinsights#StatesInput", "traits": { - "smithy.api#documentation": "

\n The input to the step function-based observation.\n

" + "smithy.api#documentation": "

The input to the step function-based observation.

" } }, "EbsEvent": { "target": "com.amazonaws.applicationinsights#EbsEvent", "traits": { - "smithy.api#documentation": "

\n The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.\n

" + "smithy.api#documentation": "

The type of EBS CloudWatch event, such as createVolume,\n deleteVolume or attachVolume.

" } }, "EbsResult": { "target": "com.amazonaws.applicationinsights#EbsResult", "traits": { - "smithy.api#documentation": "

\n The result of an EBS CloudWatch event, such as failed or succeeded.\n

" + "smithy.api#documentation": "

The result of an EBS CloudWatch event, such as failed or\n succeeded.

" } }, "EbsCause": { "target": "com.amazonaws.applicationinsights#EbsCause", "traits": { - "smithy.api#documentation": "

\n The cause of an EBS CloudWatch event.\n

" + "smithy.api#documentation": "

The cause of an EBS CloudWatch event.

" } }, "EbsRequestId": { "target": "com.amazonaws.applicationinsights#EbsRequestId", "traits": { - "smithy.api#documentation": "

\n The request ID of an EBS CloudWatch event.\n

" + "smithy.api#documentation": "

The request ID of an EBS CloudWatch event.

" } }, "XRayFaultPercent": { "target": "com.amazonaws.applicationinsights#XRayFaultPercent", "traits": { - "smithy.api#documentation": "

\n The X-Ray request fault percentage for this node.\n

" + "smithy.api#documentation": "

The X-Ray request fault percentage for this node.

" } }, "XRayThrottlePercent": { "target": "com.amazonaws.applicationinsights#XRayThrottlePercent", "traits": { - "smithy.api#documentation": "

\n The X-Ray request throttle percentage for this node.\n

" + "smithy.api#documentation": "

The X-Ray request throttle percentage for this node.

" } }, "XRayErrorPercent": { "target": "com.amazonaws.applicationinsights#XRayErrorPercent", "traits": { - "smithy.api#documentation": "

\n The X-Ray request error percentage for this node.\n

" + "smithy.api#documentation": "

The X-Ray request error percentage for this node.

" } }, "XRayRequestCount": { "target": "com.amazonaws.applicationinsights#XRayRequestCount", "traits": { - "smithy.api#documentation": "

\n The X-Ray request count for this node.\n

" + "smithy.api#documentation": "

The X-Ray request count for this node.

" } }, "XRayRequestAverageLatency": { "target": "com.amazonaws.applicationinsights#XRayRequestAverageLatency", "traits": { - "smithy.api#documentation": "

\n The X-Ray node request average latency for this node.\n

" + "smithy.api#documentation": "

The X-Ray node request average latency for this node.

" } }, "XRayNodeName": { "target": "com.amazonaws.applicationinsights#XRayNodeName", "traits": { - "smithy.api#documentation": "

\n The name of the X-Ray node.\n

" + "smithy.api#documentation": "

The name of the X-Ray node.

" } }, "XRayNodeType": { "target": "com.amazonaws.applicationinsights#XRayNodeType", "traits": { - "smithy.api#documentation": "

\n The type of the X-Ray node.

" + "smithy.api#documentation": "

The type of the X-Ray node.

" } } }, @@ -2449,10 +2484,16 @@ } }, "RecurringCount": { - "target": "com.amazonaws.applicationinsights#RecurringCount" + "target": "com.amazonaws.applicationinsights#RecurringCount", + "traits": { + "smithy.api#documentation": "

The number of times that the same problem reoccurred after the first time it was\n resolved.

" + } }, "LastRecurrenceTime": { - "target": "com.amazonaws.applicationinsights#LastRecurrenceTime" + "target": "com.amazonaws.applicationinsights#LastRecurrenceTime", + "traits": { + "smithy.api#documentation": "

The last time that the problem reoccurred after its last resolution.

" + } } }, "traits": { @@ -2587,6 +2628,10 @@ "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "Informative", + "name": "Informative" + }, { "value": "Low", "name": "Low" @@ -2652,7 +2697,7 @@ "Key": { "target": "com.amazonaws.applicationinsights#TagKey", "traits": { - "smithy.api#documentation": "

One part of a key-value pair that defines a tag. The maximum length of a tag key is\n 128 characters. The minimum length is 1 character.

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

One part of a key-value pair that defines a tag. The maximum length of a tag key is 128\n characters. The minimum length is 1 character.

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

An object that defines the tags associated with an application.\n A tag is a label that you optionally define and associate with\n an application. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for a more specific tag value. A tag value acts as\n a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag\n value can contain as many as 256 characters. The characters can be Unicode letters,\n digits, white space, or one of the following symbols: _ . : / = + -. The following\n additional restrictions apply to tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only\n one value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by AWS; you can’t use it in\n any tag keys or values that you define. In addition, you can't edit or remove\n tag keys or values that use this prefix.

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

An object that defines the tags associated with an application. A\n tag is a label that you optionally define and associate with an\n application. Tags can help you categorize and manage resources in different ways, such as\n by purpose, owner, environment, or other criteria.

\n

Each tag consists of a required tag key and an associated\n tag value, both of which you define. A tag key is a general label\n that acts as a category for a more specific tag value. A tag value acts as a descriptor\n within a tag key. A tag key can contain as many as 128 characters. A tag value can contain\n as many as 256 characters. The characters can be Unicode letters, digits, white space, or\n one of the following symbols: _ . : / = + -. The following additional restrictions apply to\n tags:

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    For each associated resource, each tag key must be unique and it can have only one\n value.

    \n
    • \n
  • \n

    The aws: prefix is reserved for use by AWS; you can’t use it in any\n tag keys or values that you define. In addition, you can't edit or remove tag keys or\n values that use this prefix.

    \n
    • \n
" } }, "com.amazonaws.applicationinsights#TagKey": { @@ -2722,7 +2767,7 @@ } ], "traits": { - "smithy.api#documentation": "

Add one or more tags (keys and values) to a specified application. A\n tag is a label that you optionally define and associate with an\n application. Tags can help you categorize and manage application in different ways, such as\n by purpose, owner, environment, or other criteria.

\n

Each tag consists of a required tag key and an\n associated tag value, both of which you define. A tag key is a\n general label that acts as a category for more specific tag values. A tag value acts as\n a descriptor within a tag key.

" + "smithy.api#documentation": "

Add one or more tags (keys and values) to a specified application. A\n tag is a label that you optionally define and associate with an\n application. Tags can help you categorize and manage application in different ways, such as\n by purpose, owner, environment, or other criteria.

\n

Each tag consists of a required tag key and an associated\n tag value, both of which you define. A tag key is a general label\n that acts as a category for more specific tag values. A tag value acts as a descriptor\n within a tag key.

" } }, "com.amazonaws.applicationinsights#TagResourceRequest": { @@ -2731,14 +2776,14 @@ "ResourceARN": { "target": "com.amazonaws.applicationinsights#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.

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

The Amazon Resource Name (ARN) of the application that you want to add one or more tags\n to.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.applicationinsights#TagList", "traits": { - "smithy.api#documentation": "

A list of tags that to add to the application. A tag consists of a required\n tag key (Key) and an associated tag value (Value). The maximum\n length of a tag key is 128 characters. The maximum length of a tag value is 256\n characters.

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

A list of tags that to add to the application. A tag consists of a required tag key\n (Key) and an associated tag value (Value). The maximum length\n of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

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

The number of the provided tags is beyond the limit, or\n the number of total tags you are trying to attach to the specified resource exceeds the limit.

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

The number of the provided tags is beyond the limit, or the number of total tags you are\n trying to attach to the specified resource exceeds the limit.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2905,7 +2950,7 @@ "ResourceARN": { "target": "com.amazonaws.applicationinsights#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.

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

The Amazon Resource Name (ARN) of the application that you want to remove one or more\n tags from.

", "smithy.api#required": {} } }, @@ -2958,29 +3003,32 @@ "OpsCenterEnabled": { "target": "com.amazonaws.applicationinsights#OpsCenterEnabled", "traits": { - "smithy.api#documentation": "

\n When set to true, creates opsItems for any problems detected on an application.\n

" + "smithy.api#documentation": "

When set to true, creates opsItems for any problems detected on an\n application.

" } }, "CWEMonitorEnabled": { "target": "com.amazonaws.applicationinsights#CWEMonitorEnabled", "traits": { - "smithy.api#documentation": "

\n Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.\n

" + "smithy.api#documentation": "

Indicates whether Application Insights can listen to CloudWatch events for the\n application resources, such as instance terminated, failed\n deployment, and others.

" } }, "OpsItemSNSTopicArn": { "target": "com.amazonaws.applicationinsights#OpsItemSNSTopicArn", "traits": { - "smithy.api#documentation": "

\n The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to\n receive notifications for updates to the opsItem.

" + "smithy.api#documentation": "

The SNS topic provided to Application Insights that is associated to the created\n opsItem. Allows you to receive notifications for updates to the opsItem.

" } }, "RemoveSNSTopic": { "target": "com.amazonaws.applicationinsights#RemoveSNSTopic", "traits": { - "smithy.api#documentation": "

\n Disassociates the SNS topic from the opsItem created for detected problems.

" + "smithy.api#documentation": "

Disassociates the SNS topic from the opsItem created for detected problems.

" } }, "AutoConfigEnabled": { - "target": "com.amazonaws.applicationinsights#AutoConfigEnabled" + "target": "com.amazonaws.applicationinsights#AutoConfigEnabled", + "traits": { + "smithy.api#documentation": "

Turns auto-configuration on or off.

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

Updates the monitoring configurations for the component. The configuration input parameter\n is an escaped JSON of the configuration and should match the schema of what is returned\n by DescribeComponentConfigurationRecommendation.

" + "smithy.api#documentation": "

Updates the monitoring configurations for the component. The configuration input\n parameter is an escaped JSON of the configuration and should match the schema of what is\n returned by DescribeComponentConfigurationRecommendation.

" } }, "com.amazonaws.applicationinsights#UpdateComponentConfigurationRequest": { @@ -3070,17 +3118,20 @@ "Tier": { "target": "com.amazonaws.applicationinsights#Tier", "traits": { - "smithy.api#documentation": "

The tier of the application component. Supported tiers include DOT_NET_WORKER,\n DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT.

" + "smithy.api#documentation": "

The tier of the application component.

" } }, "ComponentConfiguration": { "target": "com.amazonaws.applicationinsights#ComponentConfiguration", "traits": { - "smithy.api#documentation": "

The configuration settings of the component. The value is the escaped JSON of the configuration. For\n more information about the JSON format, see Working with JSON.\n You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete\n format of the component configuration file, see Component Configuration.

" + "smithy.api#documentation": "

The configuration settings of the component. The value is the escaped JSON of the\n configuration. For more information about the JSON format, see Working with JSON. You can send a request to\n DescribeComponentConfigurationRecommendation to see the recommended\n configuration for a component. For the complete format of the component configuration file,\n see Component Configuration.

" } }, "AutoConfigEnabled": { - "target": "com.amazonaws.applicationinsights#AutoConfigEnabled" + "target": "com.amazonaws.applicationinsights#AutoConfigEnabled", + "traits": { + "smithy.api#documentation": "

Automatically configures the component by applying the recommended configurations.\n

" + } } } }, @@ -3176,13 +3227,13 @@ "Pattern": { "target": "com.amazonaws.applicationinsights#LogPatternRegex", "traits": { - "smithy.api#documentation": "

The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

" + "smithy.api#documentation": "

The log pattern. The pattern must be DFA compatible. Patterns that utilize forward\n lookahead or backreference constructions are not supported.

" } }, "Rank": { "target": "com.amazonaws.applicationinsights#LogPatternRank", "traits": { - "smithy.api#documentation": "

Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank.\n Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.\n

" + "smithy.api#documentation": "

Rank of the log pattern. Must be a value between 1 and\n 1,000,000. The patterns are sorted by rank, so we recommend that you set\n your highest priority patterns with the lowest rank. A pattern of rank 1 will\n be the first to get matched to a log line. A pattern of rank 1,000,000 will be\n last to get matched. When you configure custom log patterns from the console, a\n Low severity pattern translates to a 750,000 rank. A\n Medium severity pattern translates to a 500,000 rank. And a\n High severity pattern translates to a 250,000 rank. Rank\n values less than 1 or greater than 1,000,000 are reserved for\n AWS-provided patterns.

" } } } diff --git a/aws/sdk/aws-models/auditmanager.json b/aws/sdk/aws-models/auditmanager.json index 603c85617..5bfa55b90 100644 --- a/aws/sdk/aws-models/auditmanager.json +++ b/aws/sdk/aws-models/auditmanager.json @@ -461,7 +461,7 @@ "evidenceByTypeConfigurationDataCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "

The number of evidence that falls under the configuration data category. This\n evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.

" + "smithy.api#documentation": "

The number of evidence that falls under the configuration data category. This\n evidence is collected from configuration snapshots of other Amazon Web Services such as Amazon EC2, Amazon S3, or IAM.

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

Returns a list of the in-scope Amazon Web Services services for the specified\n assessment.

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

Returns a list of the in-scope Amazon Web Services for the specified\n assessment.

", "smithy.api#http": { "method": "GET", "uri": "/services", @@ -6274,6 +6274,9 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ThrottlingException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } @@ -6437,13 +6440,15 @@ "roleType": { "target": "com.amazonaws.auditmanager#RoleType", "traits": { - "smithy.api#documentation": "

The type of customer persona.

\n \n

In CreateAssessment, roleType can only be\n PROCESS_OWNER.

\n

In UpdateSettings, roleType can only be\n PROCESS_OWNER.

\n

In BatchCreateDelegationByAssessment, roleType can only be\n RESOURCE_OWNER.

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

The type of customer persona.

\n \n

In CreateAssessment, roleType can only be\n PROCESS_OWNER.

\n

In UpdateSettings, roleType can only be\n PROCESS_OWNER.

\n

In BatchCreateDelegationByAssessment, roleType can only be\n RESOURCE_OWNER.

\n ", + "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.auditmanager#IamArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role.

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

Creates a share request for a custom framework in Audit Manager.

\n

The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.

\n \n

When you invoke the StartAssessmentFrameworkShare API, you are about to\n share a custom framework with another Amazon Web Services account. You may not share a\n custom framework that is derived from a standard framework if the standard framework is\n designated as not eligible for sharing by Amazon Web Services, unless you have obtained\n permission to do so from the owner of the standard framework. To learn more about which\n standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User\n Guide.

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

Creates a share request for a custom framework in Audit Manager.

\n

The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.

\n

When you create a share request, Audit Manager stores a snapshot of your custom\n framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also\n stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.

\n

Audit Manager deletes the snapshot and the backup snapshot when one of the following\n events occurs:

\n
    \n
  • \n

    The sender revokes the share request.

    \n
    • \n
  • \n

    The recipient declines the share request.

    \n
    • \n
  • \n

    The recipient encounters an error and doesn't successfully accept the share\n request.

    \n
    • \n
  • \n

    The share request expires before the recipient responds to the request.

    \n
    • \n
\n

When a sender resends a share request, the snapshot is replaced with an updated version that\n corresponds with the latest version of the custom framework.

\n

When a recipient accepts a share request, the snapshot is replicated into their\n Amazon Web Services account under the Amazon Web Services Region that was specified in the share request.

\n \n

When you invoke the StartAssessmentFrameworkShare API, you are about to\n share a custom framework with another Amazon Web Services account. You may not share a\n custom framework that is derived from a standard framework if the standard framework is\n designated as not eligible for sharing by Amazon Web Services, unless you have obtained\n permission to do so from the owner of the standard framework. To learn more about which\n standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User\n Guide.

\n ", "smithy.api#http": { "method": "POST", "uri": "/assessmentFrameworks/{frameworkId}/shareRequests", @@ -7002,6 +7007,22 @@ "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" } }, + "com.amazonaws.auditmanager#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.auditmanager#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.auditmanager#Timestamp": { "type": "timestamp" }, diff --git a/aws/sdk/aws-models/backup-gateway.json b/aws/sdk/aws-models/backup-gateway.json index dc93ffd85..b190d148d 100644 --- a/aws/sdk/aws-models/backup-gateway.json +++ b/aws/sdk/aws-models/backup-gateway.json @@ -427,6 +427,56 @@ "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\\/[a-zA-Z-0-9]+$" } }, + "com.amazonaws.backupgateway#GatewayDetails": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n gateway. Use the ListGateways operation\n to return a list of gateways for your account and \n Amazon Web Services Region.

" + } + }, + "GatewayDisplayName": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "

The display name of the gateway.

" + } + }, + "GatewayType": { + "target": "com.amazonaws.backupgateway#GatewayType", + "traits": { + "smithy.api#documentation": "

The type of the gateway type.

" + } + }, + "HypervisorId": { + "target": "com.amazonaws.backupgateway#HypervisorId", + "traits": { + "smithy.api#documentation": "

The hypervisor ID of the gateway.

" + } + }, + "LastSeenTime": { + "target": "com.amazonaws.backupgateway#Time", + "traits": { + "smithy.api#documentation": "

Details showing the last time Backup gateway communicated\n with the cloud, in Unix format and UTC time.

" + } + }, + "NextUpdateAvailabilityTime": { + "target": "com.amazonaws.backupgateway#Time", + "traits": { + "smithy.api#documentation": "

Details showing the next update availability time of the \n gateway.

" + } + }, + "VpcEndpoint": { + "target": "com.amazonaws.backupgateway#VpcEndpoint", + "traits": { + "smithy.api#documentation": "

The DNS name for the virtual private cloud (VPC) endpoint the gateway \n uses to connect to the cloud for backup gateway.

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

The details of gateway.

" + } + }, "com.amazonaws.backupgateway#GatewayResource": { "type": "resource", "identifiers": { @@ -437,6 +487,9 @@ "create": { "target": "com.amazonaws.backupgateway#CreateGateway" }, + "read": { + "target": "com.amazonaws.backupgateway#GetGateway" + }, "update": { "target": "com.amazonaws.backupgateway#UpdateGatewayInformation" }, @@ -458,6 +511,9 @@ }, { "target": "com.amazonaws.backupgateway#TestHypervisorConfiguration" + }, + { + "target": "com.amazonaws.backupgateway#UpdateGatewaySoftwareNow" } ], "traits": { @@ -483,6 +539,53 @@ "target": "com.amazonaws.backupgateway#Gateway" } }, + "com.amazonaws.backupgateway#GetGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#GetGatewayInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#GetGatewayOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

By providing the ARN (Amazon Resource Name), this\n API returns the gateway.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.backupgateway#GetGatewayInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gateway.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#GetGatewayOutput": { + "type": "structure", + "members": { + "Gateway": { + "target": "com.amazonaws.backupgateway#GatewayDetails", + "traits": { + "smithy.api#documentation": "

By providing the ARN (Amazon Resource Name), this\n API returns the gateway.

" + } + } + } + }, "com.amazonaws.backupgateway#Host": { "type": "string", "traits": { @@ -1123,7 +1226,7 @@ "Value": { "target": "com.amazonaws.backupgateway#TagValue", "traits": { - "smithy.api#documentation": "

The key part of a value's key-value pair.

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

The value part of a tag's key-value pair.

", "smithy.api#required": {} } } @@ -1389,6 +1492,52 @@ } } }, + "com.amazonaws.backupgateway#UpdateGatewaySoftwareNow": { + "type": "operation", + "input": { + "target": "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowInput" + }, + "output": { + "target": "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backupgateway#InternalServerException" + }, + { + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backupgateway#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the gateway virtual machine (VM) software. \n The request immediately triggers the software update.

\n \n

When you make this request, you get a 200 OK\n success response immediately. However, it might take some \n time for the update to complete.

\n " + } + }, + "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowInput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gateway\n to be updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowOutput": { + "type": "structure", + "members": { + "GatewayArn": { + "target": "com.amazonaws.backupgateway#GatewayArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the gateway\n you updated.

" + } + } + } + }, "com.amazonaws.backupgateway#UpdateHypervisor": { "type": "operation", "input": { @@ -1442,6 +1591,12 @@ "traits": { "smithy.api#documentation": "

The updated password for the hypervisor.

" } + }, + "Name": { + "target": "com.amazonaws.backupgateway#Name", + "traits": { + "smithy.api#documentation": "

The updated name for the hypervisor

" + } } } }, @@ -1516,7 +1671,7 @@ "ResourceArn": { "target": "com.amazonaws.backupgateway#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the virtual machine.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the virtual machine. For example,\n arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

" } }, "LastBackupDate": { @@ -1536,6 +1691,15 @@ "target": "com.amazonaws.backupgateway#VirtualMachine" } }, + "com.amazonaws.backupgateway#VpcEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.backupgateway#string": { "type": "string" } diff --git a/aws/sdk/aws-models/budgets.json b/aws/sdk/aws-models/budgets.json index e68b7d0be..a8cd73985 100644 --- a/aws/sdk/aws-models/budgets.json +++ b/aws/sdk/aws-models/budgets.json @@ -43,7 +43,7 @@ "name": "budgets" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

The Amazon Web Services Budgets API enables you to use Amazon Web Services Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Amazon Web Services Budgets.

\n\t\t

Budgets provide you with a way to see the following information:

\n\t\t
    \n
  • \n\t\t\t\t

    How close your plan is to your budgeted amount or to the free tier limits

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Your usage-to-date, including how much you've used of your Reserved Instances (RIs)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    How much of your budget has been used

    \n\t\t\t
    • \n
\n\t\t

Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Cost budgets - Plan how much you want to spend on a service.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Usage budgets - Plan how much you want to use one or more services.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.

    \n\t\t\t
    • \n
\n\t\t

Service Endpoint

\n\t\t

The Amazon Web Services Budgets API provides the following endpoint:

\n\t\t
    \n
  • \n\t\t\t\t

    https://budgets.amazonaws.com

    \n\t\t\t
    • \n
\n\t\t

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

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

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

\n\t\t

Budgets provide you with a way to see the following information:

\n\t\t
    \n
  • \n\t\t\t\t

    How close your plan is to your budgeted amount or to the free tier limits

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Your usage-to-date, including how much you've used of your Reserved Instances (RIs)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    How much of your budget has been used

    \n\t\t\t
    • \n
\n\t\t

Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Cost budgets - Plan how much you want to spend on a service.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Usage budgets - Plan how much you want to use one or more services.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.

    \n\t\t\t
    • \n
\n\t\t

Service Endpoint

\n\t

The Amazon Web Services Budgets API provides the following endpoint:

\n\t\t
    \n
  • \n\t\t\t\t

    https://budgets.amazonaws.com

    \n\t\t\t
    • \n
\n\t

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

", "smithy.api#title": "AWS Budgets" }, "version": "2016-10-20", @@ -848,6 +848,9 @@ }, { "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -880,6 +883,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1033,6 +1039,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1108,6 +1117,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1216,6 +1228,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1245,6 +1260,9 @@ }, { "target": "com.amazonaws.budgets#ResourceLockedException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1347,6 +1365,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1409,6 +1430,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1478,6 +1502,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1504,6 +1531,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1533,6 +1563,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1661,6 +1694,9 @@ }, { "target": "com.amazonaws.budgets#InvalidParameterException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1728,6 +1764,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1804,6 +1843,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1876,6 +1918,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -1992,6 +2037,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -2077,6 +2125,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -2169,6 +2220,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -2242,10 +2296,20 @@ "smithy.api#documentation": "

Response of DescribeSubscribersForNotification

" } }, + "com.amazonaws.budgets#DimensionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2147483647 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, "com.amazonaws.budgets#DimensionValues": { "type": "list", "member": { - "target": "com.amazonaws.budgets#GenericString" + "target": "com.amazonaws.budgets#DimensionValue" } }, "com.amazonaws.budgets#DuplicateRecordException": { @@ -2311,6 +2375,9 @@ }, { "target": "com.amazonaws.budgets#ResourceLockedException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -3004,6 +3071,19 @@ ] } }, + "com.amazonaws.budgets#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.budgets#errorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

\n The number of API requests has exceeded the maximum allowed API request throttling limit for the account.\n

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.budgets#TimePeriod": { "type": "structure", "members": { @@ -3079,6 +3159,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -3108,6 +3191,9 @@ }, { "target": "com.amazonaws.budgets#ResourceLockedException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -3245,6 +3331,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { @@ -3317,6 +3406,9 @@ }, { "target": "com.amazonaws.budgets#NotFoundException" + }, + { + "target": "com.amazonaws.budgets#ThrottlingException" } ], "traits": { diff --git a/aws/sdk/aws-models/ce.json b/aws/sdk/aws-models/ce.json index 9d0feb561..edde716aa 100644 --- a/aws/sdk/aws-models/ce.json +++ b/aws/sdk/aws-models/ce.json @@ -123,6 +123,9 @@ { "target": "com.amazonaws.costexplorer#GetUsageForecast" }, + { + "target": "com.amazonaws.costexplorer#ListCostAllocationTags" + }, { "target": "com.amazonaws.costexplorer#ListCostCategoryDefinitions" }, @@ -144,6 +147,9 @@ { "target": "com.amazonaws.costexplorer#UpdateAnomalySubscription" }, + { + "target": "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatus" + }, { "target": "com.amazonaws.costexplorer#UpdateCostCategoryDefinition" } @@ -201,7 +207,7 @@ "DimensionValue": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The dimension for the anomaly (for example, an Amazon Web Services service in a service\n monitor).

" + "smithy.api#documentation": "

The dimension for the anomaly (for example, an Amazon Web Service in a service\n monitor).

" } }, "RootCauses": { @@ -507,6 +513,132 @@ ] } }, + "com.amazonaws.costexplorer#CostAllocationTag": { + "type": "structure", + "members": { + "TagKey": { + "target": "com.amazonaws.costexplorer#TagKey", + "traits": { + "smithy.api#documentation": "

The key for the cost allocation tag.

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

The type of cost allocation tag. You can use AWSGenerated or\n UserDefined type tags. AWSGenerated type tags are tags\n that Amazon Web Services defines and applies to support Amazon Web Services resources for\n cost allocation purposes. UserDefined type tags are tags that you define,\n create, and apply to resources.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.costexplorer#CostAllocationTagStatus", + "traits": { + "smithy.api#documentation": "

The status of a cost allocation tag.

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

The cost allocation tag structure. This includes detailed metadata for the\n CostAllocationTag object.

" + } + }, + "com.amazonaws.costexplorer#CostAllocationTagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.costexplorer#CostAllocationTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#CostAllocationTag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.costexplorer#CostAllocationTagStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Active", + "name": "ACTIVE" + }, + { + "value": "Inactive", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.costexplorer#CostAllocationTagStatusEntry": { + "type": "structure", + "members": { + "TagKey": { + "target": "com.amazonaws.costexplorer#TagKey", + "traits": { + "smithy.api#documentation": "

The key for the cost allocation tag.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.costexplorer#CostAllocationTagStatus", + "traits": { + "smithy.api#documentation": "

The status of a cost allocation tag.

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

The cost allocation tag status. The status of a key can either be active or inactive.

" + } + }, + "com.amazonaws.costexplorer#CostAllocationTagStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#CostAllocationTagStatusEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.costexplorer#CostAllocationTagType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWSGenerated", + "name": "AWS_GENERATED" + }, + { + "value": "UserDefined", + "name": "USER_DEFINED" + } + ] + } + }, + "com.amazonaws.costexplorer#CostAllocationTagsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.costexplorer#CostCategory": { "type": "structure", "members": { @@ -527,7 +659,7 @@ "EffectiveEnd": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

The effective end data of your Cost Category.

" + "smithy.api#documentation": "

The effective end data of your Cost Category.

" } }, "Name": { @@ -575,7 +707,7 @@ "DimensionName": { "target": "com.amazonaws.costexplorer#CostCategoryInheritedValueDimensionName", "traits": { - "smithy.api#documentation": "

The name of the dimension that's used to group costs.

\n

If you specify LINKED_ACCOUNT_NAME, the cost category value is based on\n account name. If you specify TAG, the cost category value will be based on\n the value of the specified tag key.

" + "smithy.api#documentation": "

The name of the dimension that's used to group costs.

\n

If you specify LINKED_ACCOUNT_NAME, the cost category value is based on\n account name. If you specify TAG, the cost category value is based on the\n value of the specified tag key.

" } }, "DimensionKey": { @@ -586,7 +718,7 @@ } }, "traits": { - "smithy.api#documentation": "

When creating or updating a cost category, you can define the\n CostCategoryRule rule type as INHERITED_VALUE. This rule\n type adds the flexibility of defining a rule that dynamically inherits the cost category\n value from the dimension value defined by\n CostCategoryInheritedValueDimension. For example, if you want to\n dynamically group costs that are based on the value of a specific tag key, first choose\n an inherited value rule type, then choose the tag dimension and specify the tag key to\n use.

" + "smithy.api#documentation": "

When you create or update a cost category, you can define the\n CostCategoryRule rule type as INHERITED_VALUE. This rule\n type adds the flexibility to define a rule that dynamically inherits the cost category\n value from the dimension value that's defined by\n CostCategoryInheritedValueDimension. For example, suppose that you want\n to dynamically group costs that are based on the value of a specific tag key. First,\n choose an inherited value rule type, and then choose the tag dimension and specify the\n tag key to use.

" } }, "com.amazonaws.costexplorer#CostCategoryInheritedValueDimensionName": { @@ -733,7 +865,7 @@ "Type": { "target": "com.amazonaws.costexplorer#CostCategoryRuleType", "traits": { - "smithy.api#documentation": "

You can define the CostCategoryRule rule type as either\n REGULAR or INHERITED_VALUE. The\n INHERITED_VALUE rule type adds the flexibility of defining a rule that\n dynamically inherits the cost category value from the dimension value defined by\n CostCategoryInheritedValueDimension. For example, if you want to\n dynamically group costs based on the value of a specific tag key, first choose an\n inherited value rule type, then choose the tag dimension and specify the tag key to\n use.

" + "smithy.api#documentation": "

You can define the CostCategoryRule rule type as either\n REGULAR or INHERITED_VALUE. The\n INHERITED_VALUE rule type adds the flexibility to define a rule that\n dynamically inherits the cost category value. This value is from the dimension value\n that's defined by CostCategoryInheritedValueDimension. For example, suppose\n that you want to costs to be dynamically grouped based on the value of a specific tag\n key. First, choose an inherited value rule type, and then choose the tag dimension and\n specify the tag key to use.

" } } }, @@ -1153,7 +1285,7 @@ "ResourceTags": { "target": "com.amazonaws.costexplorer#ResourceTagList", "traits": { - "smithy.api#documentation": "

\n An optional list of tags to associate with the specified \n AnomalyMonitor\n . You can use resource tags to control access to your monitor using IAM policies.

\n

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

\n
    \n
  • \n

    Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    \n
    • \n
  • \n

    The maximum length of a key is 128 characters

    \n
    • \n
  • \n

    The maximum length of a value is 256 characters

    \n
    • \n
  • \n

    Valid characters for keys and values are: A-Z, a-z, spaces, _.:/=+-\n

    \n
    • \n
  • \n

    Keys and values are case sensitive

    \n
    • \n
  • \n

    Keys and values are trimmed for any leading or trailing whitespaces

    \n
    • \n
  • \n

    Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

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

An optional list of tags to associate with the specified \n AnomalyMonitor\n . You can use resource tags to control access to your\n monitor using IAM policies.

\n

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

\n
    \n
  • \n

    Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    \n
    • \n
  • \n

    The maximum length of a key is 128 characters

    \n
    • \n
  • \n

    The maximum length of a value is 256 characters

    \n
    • \n
  • \n

    Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-\n

    \n
    • \n
  • \n

    Keys and values are case sensitive

    \n
    • \n
  • \n

    Keys and values are trimmed for any leading or trailing whitespaces

    \n
    • \n
  • \n

    Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

    \n
    • \n
" } } } @@ -1203,7 +1335,7 @@ "ResourceTags": { "target": "com.amazonaws.costexplorer#ResourceTagList", "traits": { - "smithy.api#documentation": "

\n An optional list of tags to associate with the specified \n AnomalySubscription\n . You can use resource tags to control access to your subscription using IAM policies.

\n

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

\n
    \n
  • \n

    Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    \n
    • \n
  • \n

    The maximum length of a key is 128 characters

    \n
    • \n
  • \n

    The maximum length of a value is 256 characters

    \n
    • \n
  • \n

    Valid characters for keys and values are: A-Z, a-z, spaces, _.:/=+-\n

    \n
    • \n
  • \n

    Keys and values are case sensitive

    \n
    • \n
  • \n

    Keys and values are trimmed for any leading or trailing whitespaces

    \n
    • \n
  • \n

    Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

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

An optional list of tags to associate with the specified \n AnomalySubscription\n . You can use resource tags to control access to\n your subscription using IAM policies.

\n

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

\n
    \n
  • \n

    Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    \n
    • \n
  • \n

    The maximum length of a key is 128 characters

    \n
    • \n
  • \n

    The maximum length of a value is 256 characters

    \n
    • \n
  • \n

    Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-\n

    \n
    • \n
  • \n

    Keys and values are case sensitive

    \n
    • \n
  • \n

    Keys and values are trimmed for any leading or trailing whitespaces

    \n
    • \n
  • \n

    Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

    \n
    • \n
" } } } @@ -1274,7 +1406,7 @@ "ResourceTags": { "target": "com.amazonaws.costexplorer#ResourceTagList", "traits": { - "smithy.api#documentation": "

\n An optional list of tags to associate with the specified \n CostCategory\n . You can use resource tags to control access to your cost category using IAM policies.

\n

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

\n
    \n
  • \n

    Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    \n
    • \n
  • \n

    The maximum length of a key is 128 characters

    \n
    • \n
  • \n

    The maximum length of a value is 256 characters

    \n
    • \n
  • \n

    Valid characters for keys and values are: A-Z, a-z, spaces, _.:/=+-\n

    \n
    • \n
  • \n

    Keys and values are case sensitive

    \n
    • \n
  • \n

    Keys and values are trimmed for any leading or trailing whitespaces

    \n
    • \n
  • \n

    Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

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

An optional list of tags to associate with the specified \n CostCategory\n . You can use resource tags to control access to your\n cost category using IAM policies.

\n

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

\n
    \n
  • \n

    Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    \n
    • \n
  • \n

    The maximum length of a key is 128 characters

    \n
    • \n
  • \n

    The maximum length of a value is 256 characters

    \n
    • \n
  • \n

    Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-\n

    \n
    • \n
  • \n

    Keys and values are case sensitive

    \n
    • \n
  • \n

    Keys and values are trimmed for any leading or trailing whitespaces

    \n
    • \n
  • \n

    Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

    \n
    • \n
" } } } @@ -1285,13 +1417,13 @@ "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your newly created Cost Category.\n

" + "smithy.api#documentation": "

The unique identifier for your newly created Cost Category.

" } }, "EffectiveStart": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The Cost Category's effective start date.\n

" + "smithy.api#documentation": "

The Cost Category's effective start date.

" } } } @@ -1332,7 +1464,7 @@ "ReservationCoveredHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The number of hours during the lookback period that's covered by reservations.

" + "smithy.api#documentation": "

The number of hours during the lookback period that's covered by reservations.

" } }, "SavingsPlansCoveredHoursInLookbackPeriod": { @@ -1344,7 +1476,7 @@ "OnDemandHoursInLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The number of hours during the lookback period that's billed at On-Demand\n rates.

" + "smithy.api#documentation": "

The number of hours during the lookback period that's billed at On-Demand\n rates.

" } }, "TotalRunningHoursInLookbackPeriod": { @@ -1362,7 +1494,7 @@ "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this\n instance.

" + "smithy.api#documentation": "

The currency code that Amazon Web Services used to calculate the costs for this\n instance.

" } } }, @@ -1502,7 +1634,7 @@ "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

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

The unique identifier for your Cost Category.

", "smithy.api#required": {} } } @@ -1514,13 +1646,13 @@ "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

" + "smithy.api#documentation": "

The unique identifier for your Cost Category.

" } }, "EffectiveEnd": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The effective end date of the Cost Category as a result of deleting it. No costs after this date will be categorized by the deleted Cost Category.\n

" + "smithy.api#documentation": "

The effective end date of the Cost Category as a result of deleting it. No costs after\n this date is categorized by the deleted Cost Category.

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

Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.

\n

You have the option to use EffectiveOn to return a Cost Category that is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.

" + "smithy.api#documentation": "

Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a\n Cost Category that's defined in the account.

\n

You have the option to use EffectiveOn to return a Cost Category that's\n active on a specific date. If there's no EffectiveOn specified, you see a Cost\n Category that's effective on the current date. If Cost Category is still effective,\n EffectiveEnd is omitted in the response.

" } }, "com.amazonaws.costexplorer#DescribeCostCategoryDefinitionRequest": { @@ -1551,14 +1683,14 @@ "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

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

The unique identifier for your Cost Category.

", "smithy.api#required": {} } }, "EffectiveOn": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The date when the Cost Category was effective.\n

" + "smithy.api#documentation": "

The date when the Cost Category was effective.

" } } } @@ -1764,30 +1896,30 @@ "DiskReadOpsPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum number of read operations per second.

" + "smithy.api#documentation": "

The maximum number of read operations per second.

" } }, "DiskWriteOpsPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum number of write operations per second.

" + "smithy.api#documentation": "

The maximum number of write operations per second.

" } }, "DiskReadBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum read throughput operations per second.

" + "smithy.api#documentation": "

The maximum read throughput operations per second.

" } }, "DiskWriteBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum write throughput operations per second.

" + "smithy.api#documentation": "

The maximum write throughput operations per second.

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

The field that contains a list of disk (local storage) metrics that are associated\n with the current instance.

" + "smithy.api#documentation": "

The field that contains a list of disk (local storage) metrics that are associated\n with the current instance.

" } }, "com.amazonaws.costexplorer#EBSResourceUtilization": { @@ -1932,7 +2064,7 @@ "Vcpu": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The number of VCPU cores in the Amazon Web Services instance type.

" + "smithy.api#documentation": "

The number of VCPU cores in the Amazon Web Services instance type.

" } } }, @@ -1946,19 +2078,19 @@ "MaxCpuUtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum observed or expected CPU utilization of the instance.

" + "smithy.api#documentation": "

The maximum observed or expected CPU utilization of the instance.

" } }, "MaxMemoryUtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum observed or expected memory utilization of the instance.

" + "smithy.api#documentation": "

The maximum observed or expected memory utilization of the instance.

" } }, "MaxStorageUtilizationPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The maximum observed or expected storage utilization of the instance. This doesn't\n include EBS storage.

" + "smithy.api#documentation": "

The maximum observed or expected storage utilization of the instance. This doesn't\n include EBS storage.

" } }, "EBSResourceUtilization": { @@ -1970,18 +2102,18 @@ "DiskResourceUtilization": { "target": "com.amazonaws.costexplorer#DiskResourceUtilization", "traits": { - "smithy.api#documentation": "

The field that contains a list of disk (local storage) metrics that are associated\n with the current instance.

" + "smithy.api#documentation": "

The field that contains a list of disk (local storage) metrics that are associated\n with the current instance.

" } }, "NetworkResourceUtilization": { "target": "com.amazonaws.costexplorer#NetworkResourceUtilization", "traits": { - "smithy.api#documentation": "

The network field that contains a list of network metrics that are associated with\n the current instance.

" + "smithy.api#documentation": "

The network field that contains a list of network metrics that are associated with the\n current instance.

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

Utilization metrics of the instance.

" + "smithy.api#documentation": "

Utilization metrics for the instance.

" } }, "com.amazonaws.costexplorer#EC2Specification": { @@ -2612,7 +2744,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves cost and usage metrics with resources for your account. You can specify which cost and\n\t usage-related metric, such as BlendedCosts or UsageQuantity, that\n\t you want the request to return. You can also filter and group your data by various dimensions,\n\t such as SERVICE or AZ, in a specific time range. For a complete list\n\t of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

\n\t \n

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.

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

Retrieves cost and usage metrics with resources for your account. You can specify which cost and\n\t usage-related metric, such as BlendedCosts or UsageQuantity, that\n\t you want the request to return. You can also filter and group your data by various dimensions,\n\t such as SERVICE or AZ, in a specific time range. For a complete list\n\t of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.

\n\t \n

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings\n page. For information about how to access the Settings page, see Controlling Access for Cost\n Explorer in the Billing and Cost Management User Guide.

\n " } }, "com.amazonaws.costexplorer#GetCostAndUsageWithResourcesRequest": { @@ -2642,7 +2774,7 @@ "Metrics": { "target": "com.amazonaws.costexplorer#MetricNames", "traits": { - "smithy.api#documentation": "

Which metrics are returned in the query. For more information about blended and\n unblended rates, see Why does\n the \"blended\" annotation appear on some line items in my bill?.

\n

Valid values are AmortizedCost, BlendedCost,\n NetAmortizedCost, NetUnblendedCost,\n NormalizedUsageAmount, UnblendedCost, and\n UsageQuantity.

\n \n

If you return the UsageQuantity metric, the service aggregates all usage\n numbers without taking the units into account. For example, if you aggregate\n usageQuantity across all of Amazon EC2, the results aren't meaningful because\n Amazon EC2 compute hours and data transfer are measured in different units (for example, hours\n vs. GB). To get more meaningful UsageQuantity metrics, filter by\n UsageType or UsageTypeGroups.

\n \n

\n Metrics is required for GetCostAndUsageWithResources requests.

" + "smithy.api#documentation": "

Which metrics are returned in the query. For more information about blended and\n unblended rates, see Why does\n the \"blended\" annotation appear on some line items in my bill?.

\n

Valid values are AmortizedCost, BlendedCost,\n NetAmortizedCost, NetUnblendedCost,\n NormalizedUsageAmount, UnblendedCost, and\n UsageQuantity.

\n \n

If you return the UsageQuantity metric, the service aggregates all usage\n numbers without taking the units into account. For example, if you aggregate\n usageQuantity across all of Amazon EC2, the results aren't meaningful because\n Amazon EC2 compute hours and data transfer are measured in different units (for example,\n hour or GB). To get more meaningful UsageQuantity metrics, filter by\n UsageType or UsageTypeGroups.

\n \n

\n Metrics is required for GetCostAndUsageWithResources requests.

" } }, "GroupBy": { @@ -2677,7 +2809,7 @@ "ResultsByTime": { "target": "com.amazonaws.costexplorer#ResultsByTime", "traits": { - "smithy.api#documentation": "

The time period that is covered by the results in the response.

" + "smithy.api#documentation": "

The time period that's covered by the results in the response.

" } }, "DimensionValueAttributes": { @@ -2723,7 +2855,7 @@ "SearchString": { "target": "com.amazonaws.costexplorer#SearchString", "traits": { - "smithy.api#documentation": "

The value that you want to search the filter values for.

\n

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

" + "smithy.api#documentation": "

The value that you want to search the filter values for.

\n

If you don't specify a CostCategoryName, SearchString is used to\n filter Cost Category names that match the SearchString pattern. If you specify a\n CostCategoryName, SearchString is used to filter Cost Category\n values that match the SearchString pattern.

" } }, "TimePeriod": { @@ -2741,19 +2873,19 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinitions", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When using SortBy, NextPageToken and SearchString are not supported.

" + "smithy.api#documentation": "

The value that you sort the data by.

\n

The key represents the cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

The supported key values for the SortOrder value are ASCENDING\n and DESCENDING.

\n

When you use the SortBy value, the NextPageToken and\n SearchString key values aren't supported.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { - "smithy.api#documentation": "

This field is only used when SortBy is provided in the request.

\n

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n

For GetCostCategories, MaxResults has an upper limit of 1000.

" + "smithy.api#documentation": "

This field is only used when the SortBy value is provided in the\n request.

\n

The maximum number of objects that are returned for this request. If\n MaxResults isn't specified with the SortBy value, the request\n returns 1000 results as the default value for this parameter.

\n

For GetCostCategories, MaxResults has an upper quota of 1000.

" } }, "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

" + "smithy.api#documentation": "

If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of\n objects, provide the NextPageToken from the previous call in your next request.

" } } } @@ -2764,7 +2896,7 @@ "NextPageToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

" + "smithy.api#documentation": "

If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of\n objects, provide the marker from the prior call in your next request.

" } }, "CostCategoryNames": { @@ -2776,13 +2908,13 @@ "CostCategoryValues": { "target": "com.amazonaws.costexplorer#CostCategoryValuesList", "traits": { - "smithy.api#documentation": "

The Cost Category values.

\n

\n CostCategoryValues are not returned if CostCategoryName is not specified in the request.

" + "smithy.api#documentation": "

The Cost Category values.

\n

If the CostCategoryName key isn't specified in the request, the\n CostCategoryValues fields aren't returned.

" } }, "ReturnSize": { "target": "com.amazonaws.costexplorer#PageSize", "traits": { - "smithy.api#documentation": "

The number of objects returned.

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

The number of objects that are returned.

", "smithy.api#required": {} } }, @@ -2925,7 +3057,7 @@ "Context": { "target": "com.amazonaws.costexplorer#Context", "traits": { - "smithy.api#documentation": "

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:

    \n

    - Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services services.

    \n

    - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that is an acting reseller for Amazon Web Services services in India.

    \n

    - Amazon Web Services Marketplace: The entity that supports the sale of solutions built on Amazon Web Services by third-party software providers.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are Compute Optimized (C4, C5, C6g, C7g etc.), Memory Optimization (R4, R5n, R5b, R6g etc).

    \n
    • \n
  • \n

    INVOICING_ENTITY - The name of the entity issuing the Amazon Web Services invoice.

    \n
    • \n
  • \n

    LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    OPERATION - The action performed. Examples include RunInstance and CreateBucket.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

    \n
    • \n
  • \n

    RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

    \n
    • \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).

    \n
    • \n
  • \n

    SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
  • \n

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

    \n
    • \n
  • \n

    USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

    \n
    • \n
  • \n

    RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    \n
    • \n
\n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

    \n
    • \n
  • \n

    TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
\n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n
    \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

    \n
    • \n
  • \n

    PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

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

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. \n\t\t\tThe default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values \n\t\t\tcan be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, \n\t\t\tthe resulting dimension values can be used in the GetCostAndUsage operation.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:

    \n

    - Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.

    \n

    - AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an\n acting reseller for Amazon Web Services in India.

    \n

    - Amazon Web Services Marketplace: The entity that supports the sale of solutions that are\n built on Amazon Web Services by third-party software providers.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases.\n Examples are Compute Optimized (for example, C4,\n C5, C6g, and C7g), Memory Optimization\n (for example, R4, R5n, R5b, and\n R6g).

    \n
    • \n
  • \n

    INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services\n invoice.

    \n
    • \n
  • \n

    LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    OPERATION - The action performed. Examples include RunInstance and CreateBucket.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    PURCHASE_TYPE - The reservation type of the purchase that this usage is related to.\n Examples include On-Demand Instances and Standard Reserved Instances.

    \n
    • \n
  • \n

    RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

    \n
    • \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).

    \n
    • \n
  • \n

    SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
  • \n

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

    \n
    • \n
  • \n

    USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    RECORD_TYPE - The different types of charges such as\n Reserved\n Instance (RI) fees, usage costs, tax refunds, and credits.

    \n
    • \n
  • \n

    RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    \n
    • \n
\n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

    \n
    • \n
  • \n

    TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
\n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n
    \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

    \n
    • \n
  • \n

    PAYMENT_OPTION - The payment option for the given Savings Plans (for example, All\n Upfront)

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.

    \n
    • \n
" } }, "Filter": { @@ -2934,13 +3066,13 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinitions", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

" + "smithy.api#documentation": "

The value that you want to sort the data by.

\n

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

The supported values for the SortOrder key are ASCENDING or\n DESCENDING.

\n

When you specify a SortBy paramater, the context must be\n COST_AND_USAGE. Further, when using SortBy,\n NextPageToken and SearchString aren't supported.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { - "smithy.api#documentation": "

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n

For GetDimensionValues, MaxResults has an upper limit of 1000.

" + "smithy.api#documentation": "

This field is only used when SortBy is provided in the request. The maximum number of\n objects that are returned for this request. If MaxResults isn't specified with SortBy, the\n request returns 1000 results as the default value for this parameter.

\n

For GetDimensionValues, MaxResults has an upper limit of 1000.

" } }, "NextPageToken": { @@ -2957,7 +3089,7 @@ "DimensionValues": { "target": "com.amazonaws.costexplorer#DimensionValuesWithAttributesList", "traits": { - "smithy.api#documentation": "

The filters that you used to filter your request. Some dimensions are available only for a specific context.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    OPERATION - The action performed. Examples include RunInstance and CreateBucket.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

    \n
    • \n
  • \n

    SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

    \n
    • \n
  • \n

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

    \n
    • \n
  • \n

    USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

    \n
    • \n
  • \n

    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

    \n
    • \n
  • \n

    RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    \n
    • \n
\n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

    \n
    • \n
  • \n

    TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
\n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n
    \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

    \n
    • \n
  • \n

    PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

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

The filters that you used to filter your request. Some dimensions are available only for a specific context.

\n\t\t

If you set the context to COST_AND_USAGE, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    OPERATION - The action performed. Examples include RunInstance and CreateBucket.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand \n Instances and Standard Reserved Instances.

    \n
    • \n
  • \n

    SERVICE - The Amazon Web Services service such as Amazon DynamoDB.

    \n
    • \n
  • \n

    USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation\n includes a unit attribute. Examples include GB and Hrs.

    \n
    • \n
  • \n

    USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this \n operation includes a unit attribute.

    \n
    • \n
  • \n

    RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

    \n
    • \n
  • \n

    RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

    \n
    • \n
\n

If you set the context to RESERVATIONS, you can use the following \n dimensions for searching:

\n
    \n
  • \n

    AZ - The Availability Zone. An example is us-east-1a.

    \n
    • \n
  • \n

    CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid\n values are SingleAZ and MultiAZ.

    \n
    • \n
  • \n

    INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

    \n
    • \n
  • \n

    TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

    \n
    • \n
  • \n

    TENANCY - The tenancy of a resource. Examples are shared or dedicated.

    \n
    • \n
\n

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

\n
    \n
  • \n

    SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

    \n
    • \n
  • \n

    PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

    \n
    • \n
  • \n

    REGION - The Amazon Web Services Region.

    \n
    • \n
  • \n

    INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

    \n
    • \n
  • \n

    LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value \n field contains the Amazon Web Services ID of the member account.

    \n
    • \n
  • \n

    SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

    \n
    • \n
", "smithy.api#required": {} } }, @@ -3003,7 +3135,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or \n\t\t Amazon Redshift usage is covered by a reservation. An organization's management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions.\n\t\t\tFor any time period, you can filter data about reservation usage by the following dimensions:

\n\t\t
    \n
  • \n

    AZ

    \n
    • \n
  • \n

    CACHE_ENGINE

    \n
    • \n
  • \n

    DATABASE_ENGINE

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION

    \n
    • \n
  • \n

    INSTANCE_TYPE

    \n
    • \n
  • \n

    LINKED_ACCOUNT

    \n
    • \n
  • \n

    OPERATING_SYSTEM

    \n
    • \n
  • \n

    PLATFORM

    \n
    • \n
  • \n

    REGION

    \n
    • \n
  • \n

    SERVICE

    \n
    • \n
  • \n

    TAG

    \n
    • \n
  • \n

    TENANCY

    \n
    • \n
\n\t\t

To determine valid values for a dimension, use the GetDimensionValues operation.

" + "smithy.api#documentation": "

Retrieves the reservation coverage for your account, which you can use to see how much of\n your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or\n Amazon Redshift usage is covered by a reservation. An organization's management account can\n see the coverage of the associated member accounts. This supports dimensions, Cost Categories,\n and nested expressions. For any time period, you can filter data about reservation usage by\n the following dimensions:

\n\t\t
    \n
  • \n

    AZ

    \n
    • \n
  • \n

    CACHE_ENGINE

    \n
    • \n
  • \n

    DATABASE_ENGINE

    \n
    • \n
  • \n

    DEPLOYMENT_OPTION

    \n
    • \n
  • \n

    INSTANCE_TYPE

    \n
    • \n
  • \n

    LINKED_ACCOUNT

    \n
    • \n
  • \n

    OPERATING_SYSTEM

    \n
    • \n
  • \n

    PLATFORM

    \n
    • \n
  • \n

    REGION

    \n
    • \n
  • \n

    SERVICE

    \n
    • \n
  • \n

    TAG

    \n
    • \n
  • \n

    TENANCY

    \n
    • \n
\n\t\t

To determine valid values for a dimension, use the GetDimensionValues operation.

" } }, "com.amazonaws.costexplorer#GetReservationCoverageRequest": { @@ -3056,7 +3188,7 @@ "target": "com.amazonaws.costexplorer#MaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you returned for this request. If more objects are\n available, in the response, Amazon Web Services provides a NextPageToken value that you can use\n in a subsequent call to get the next batch of objects.

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

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. \n\t\t\tReservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

\n\t\t

Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage \n\t\t\tinto categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations \n\t\t\tin each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

\n\t\t

For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region \n\t\t\tand recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance \n\t\t\tin an instance family. This makes it easier to purchase a size-flexible RI. Amazon Web Services also shows the equal number of normalized units \n\t\t\tso that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large \n\t\t\tbecause that is the smallest size instance in the c4 instance family.

" + "smithy.api#documentation": "

Gets recommendations for reservation purchases. These recommendations might help you to\n reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to\n On-Demand pricing.

\n\t\t

Amazon Web Services generates your recommendations by identifying your On-Demand usage\n during a specific time period and collecting your usage into categories that are eligible for\n a reservation. After Amazon Web Services has these categories, it simulates every combination\n of reservations in each category of usage to identify the best number of each type of Reserved\n Instance (RI) to purchase to maximize your estimated savings.

\n\t\t

For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared\n tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy\n size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services\n recommends the smallest size instance in an instance family. This makes it easier to purchase\n a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of\n normalized units. This way, you can purchase any instance size that you want. For this\n example, your RI recommendation is for c4.large because that is the smallest size\n instance in the c4 instance family.

" } }, "com.amazonaws.costexplorer#GetReservationPurchaseRecommendationRequest": { @@ -3117,7 +3249,7 @@ "AccountId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The account ID that is associated with the recommendation.

" + "smithy.api#documentation": "

The account ID that's associated with the recommendation.

" } }, "Service": { @@ -3226,7 +3358,7 @@ "TimePeriod": { "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

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

Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start\n date is inclusive, but the end date is exclusive. For example, if start is\n 2017-01-01 and end is 2017-05-01, then the cost and\n usage data is retrieved from 2017-01-01 up to and including\n 2017-04-30 but not including 2017-05-01.

", "smithy.api#required": {} } }, @@ -3251,7 +3383,7 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n \n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n UtilizationPercentageInUnits\n

    \n
    • \n
  • \n

    \n PurchasedHours\n

    \n
    • \n
  • \n

    \n PurchasedUnits\n

    \n
    • \n
  • \n

    \n TotalActualHours\n

    \n
    • \n
  • \n

    \n TotalActualUnits\n

    \n
    • \n
  • \n

    \n UnusedHours\n

    \n
    • \n
  • \n

    \n UnusedUnits\n

    \n
    • \n
  • \n

    \n OnDemandCostOfRIHoursUsed\n

    \n
    • \n
  • \n

    \n NetRISavings\n

    \n
    • \n
  • \n

    \n TotalPotentialRISavings\n

    \n
    • \n
  • \n

    \n AmortizedUpfrontFee\n

    \n
    • \n
  • \n

    \n AmortizedRecurringFee\n

    \n
    • \n
  • \n

    \n TotalAmortizedFee\n

    \n
    • \n
  • \n

    \n RICostForUnusedHours\n

    \n
    • \n
  • \n

    \n RealizedSavings\n

    \n
    • \n
  • \n

    \n UnrealizedSavings\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value that you want to sort the data by.

\n \n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n UtilizationPercentageInUnits\n

    \n
    • \n
  • \n

    \n PurchasedHours\n

    \n
    • \n
  • \n

    \n PurchasedUnits\n

    \n
    • \n
  • \n

    \n TotalActualHours\n

    \n
    • \n
  • \n

    \n TotalActualUnits\n

    \n
    • \n
  • \n

    \n UnusedHours\n

    \n
    • \n
  • \n

    \n UnusedUnits\n

    \n
    • \n
  • \n

    \n OnDemandCostOfRIHoursUsed\n

    \n
    • \n
  • \n

    \n NetRISavings\n

    \n
    • \n
  • \n

    \n TotalPotentialRISavings\n

    \n
    • \n
  • \n

    \n AmortizedUpfrontFee\n

    \n
    • \n
  • \n

    \n AmortizedRecurringFee\n

    \n
    • \n
  • \n

    \n TotalAmortizedFee\n

    \n
    • \n
  • \n

    \n RICostForUnusedHours\n

    \n
    • \n
  • \n

    \n RealizedSavings\n

    \n
    • \n
  • \n

    \n UnrealizedSavings\n

    \n
    • \n
\n \n

The supported values for SortOrder are ASCENDING and\n DESCENDING.

" } }, "NextPageToken": { @@ -3264,7 +3396,7 @@ "target": "com.amazonaws.costexplorer#MaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

" + "smithy.api#documentation": "

The maximum number of objects that you returned for this request. If more objects are\n available, in the response, Amazon Web Services provides a NextPageToken value that you can use\n in a subsequent call to get the next batch of objects.

" } } } @@ -3275,14 +3407,14 @@ "UtilizationsByTime": { "target": "com.amazonaws.costexplorer#UtilizationsByTime", "traits": { - "smithy.api#documentation": "

The amount of time that you used your RIs.

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

The amount of time that you used your Reserved Instances (RIs).

", "smithy.api#required": {} } }, "Total": { "target": "com.amazonaws.costexplorer#ReservationAggregates", "traits": { - "smithy.api#documentation": "

The total amount of time that you used your RIs.

" + "smithy.api#documentation": "

The total amount of time that you used your Reserved Instances (RIs).

" } }, "NextPageToken": { @@ -3310,7 +3442,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates recommendations that\n help you save cost\n by identifying idle and underutilized Amazon EC2 instances.

\n

Recommendations are generated to either downsize or terminate instances, along with\n providing savings detail and metrics. For details on calculation and function, see\n Optimizing\n Your Cost with Rightsizing\n Recommendations\n in the Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

Creates recommendations that\n help you save cost\n by identifying idle and underutilized Amazon EC2 instances.

\n

Recommendations are generated to either downsize or terminate instances, along with\n providing savings detail and metrics. For more information about calculation and function, see\n Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.

" } }, "com.amazonaws.costexplorer#GetRightsizingRecommendationRequest": { @@ -3322,7 +3454,7 @@ "Configuration": { "target": "com.amazonaws.costexplorer#RightsizingRecommendationConfiguration", "traits": { - "smithy.api#documentation": "

Enables you to customize recommendations across two attributes. You can choose to view\n recommendations for instances within the same instance families or across different instance\n families. You can also choose to view your estimated savings associated with recommendations\n with consideration of existing Savings Plans or RI benefits, or\n neither.

" + "smithy.api#documentation": "

You can use Configuration to customize recommendations across two attributes. You can\n choose to view recommendations for instances within the same instance families or across\n different instance families. You can also choose to view your estimated savings that are\n associated with recommendations with consideration of existing Savings Plans or RI benefits,\n or neither.

" } }, "Service": { @@ -3376,7 +3508,7 @@ "Configuration": { "target": "com.amazonaws.costexplorer#RightsizingRecommendationConfiguration", "traits": { - "smithy.api#documentation": "

Enables you to customize recommendations across two attributes. You can choose to view\n recommendations for instances within the same instance families or across different instance\n families. You can also choose to view your estimated savings associated with recommendations\n with consideration of existing Savings Plans or RI benefits, or\n neither.

" + "smithy.api#documentation": "

You can use Configuration to customize recommendations across two attributes. You can\n choose to view recommendations for instances within the same instance families or across\n different instance families. You can also choose to view your estimated savings that are\n associated with recommendations with consideration of existing Savings Plans or RI benefits,\n or neither.

" } } } @@ -3446,7 +3578,7 @@ "NextToken": { "target": "com.amazonaws.costexplorer#NextPageToken", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has\n more results than the maximum page size.

" } }, "MaxResults": { @@ -3459,7 +3591,7 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The following values are supported for Key:

\n
    \n
  • \n

    \n SpendCoveredBySavingsPlan\n

    \n
    • \n
  • \n

    \n OnDemandCost\n

    \n
    • \n
  • \n

    \n CoveragePercentage\n

    \n
    • \n
  • \n

    \n TotalCost\n

    \n
    • \n
  • \n

    \n InstanceFamily\n

    \n
    • \n
  • \n

    \n Region\n

    \n
    • \n
  • \n

    \n Service\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value that you want to sort the data by.

\n

The following values are supported for Key:

\n
    \n
  • \n

    \n SpendCoveredBySavingsPlan\n

    \n
    • \n
  • \n

    \n OnDemandCost\n

    \n
    • \n
  • \n

    \n CoveragePercentage\n

    \n
    • \n
  • \n

    \n TotalCost\n

    \n
    • \n
  • \n

    \n InstanceFamily\n

    \n
    • \n
  • \n

    \n Region\n

    \n
    • \n
  • \n

    \n Service\n

    \n
    • \n
\n \n

The supported values for SortOrder are ASCENDING and\n DESCENDING.

" } } } @@ -3508,21 +3640,21 @@ "SavingsPlansType": { "target": "com.amazonaws.costexplorer#SupportedSavingsPlansType", "traits": { - "smithy.api#documentation": "

The Savings Plans recommendation type requested.

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

The Savings Plans recommendation type that's requested.

", "smithy.api#required": {} } }, "TermInYears": { "target": "com.amazonaws.costexplorer#TermInYears", "traits": { - "smithy.api#documentation": "

The savings plan recommendation term used to\n generate these\n recommendations.

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

The savings plan recommendation term that's used to generate these recommendations.

", "smithy.api#required": {} } }, "PaymentOption": { "target": "com.amazonaws.costexplorer#PaymentOption", "traits": { - "smithy.api#documentation": "

The payment option used to generate these recommendations.

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

The payment option that's used to generate these recommendations.

", "smithy.api#required": {} } }, @@ -3547,14 +3679,14 @@ "LookbackPeriodInDays": { "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

The lookback period used to generate the recommendation.

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

The lookback period that's used to generate the recommendation.

", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.costexplorer#Expression", "traits": { - "smithy.api#documentation": "

You can filter your recommendations by Account ID with the LINKED_ACCOUNT\n dimension. To filter your recommendations by Account ID, specify Key as\n LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) for\n which you want to see Savings Plans purchase recommendations.

\n

For GetSavingsPlansPurchaseRecommendation, the Filter does not include\n CostCategories or Tags. It only includes Dimensions.\n With Dimensions, Key must be LINKED_ACCOUNT and\n Value can be a single Account ID or multiple comma-separated Account IDs for\n which you want to see Savings Plans Purchase Recommendations. AND and\n OR operators are not supported.

" + "smithy.api#documentation": "

You can filter your recommendations by Account ID with the LINKED_ACCOUNT\n dimension. To filter your recommendations by Account ID, specify Key as\n LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that\n you want to see Savings Plans purchase recommendations for.

\n

For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include\n CostCategories or Tags. It only includes Dimensions.\n With Dimensions, Key must be LINKED_ACCOUNT and\n Value can be a single Account ID or multiple comma-separated Account IDs that\n you want to see Savings Plans Purchase Recommendations for. AND and\n OR operators are not supported.

" } } } @@ -3565,7 +3697,7 @@ "Metadata": { "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationMetadata", "traits": { - "smithy.api#documentation": "

Information regarding this specific recommendation set.

" + "smithy.api#documentation": "

Information that regards this specific recommendation set.

" } }, "SavingsPlansPurchaseRecommendation": { @@ -3599,7 +3731,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

\n\t \n

You cannot group by any dimension values for GetSavingsPlansUtilization.

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

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.

\n\t \n

You can't group by any dimension values for GetSavingsPlansUtilization.

\n " } }, "com.amazonaws.costexplorer#GetSavingsPlansUtilizationDetails": { @@ -3668,7 +3800,7 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n \n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n TotalCommitment\n

    \n
    • \n
  • \n

    \n UsedCommitment\n

    \n
    • \n
  • \n

    \n UnusedCommitment\n

    \n
    • \n
  • \n

    \n NetSavings\n

    \n
    • \n
  • \n

    \n AmortizedRecurringCommitment\n

    \n
    • \n
  • \n

    \n AmortizedUpfrontCommitment\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value that you want to sort the data by.

\n \n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n TotalCommitment\n

    \n
    • \n
  • \n

    \n UsedCommitment\n

    \n
    • \n
  • \n

    \n UnusedCommitment\n

    \n
    • \n
  • \n

    \n NetSavings\n

    \n
    • \n
  • \n

    \n AmortizedRecurringCommitment\n

    \n
    • \n
  • \n

    \n AmortizedUpfrontCommitment\n

    \n
    • \n
\n \n

The supported values for SortOrder are ASCENDING and\n DESCENDING.

" } } } @@ -3728,7 +3860,7 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinition", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n TotalCommitment\n

    \n
    • \n
  • \n

    \n UsedCommitment\n

    \n
    • \n
  • \n

    \n UnusedCommitment\n

    \n
    • \n
  • \n

    \n NetSavings\n

    \n
    • \n
\n \n

Supported values for SortOrder are ASCENDING or DESCENDING.

" + "smithy.api#documentation": "

The value that you want to sort the data by.

\n

The following values are supported for Key:

\n
    \n
  • \n

    \n UtilizationPercentage\n

    \n
    • \n
  • \n

    \n TotalCommitment\n

    \n
    • \n
  • \n

    \n UsedCommitment\n

    \n
    • \n
  • \n

    \n UnusedCommitment\n

    \n
    • \n
  • \n

    \n NetSavings\n

    \n
    • \n
\n \n

The supported values for SortOrder are ASCENDING and\n DESCENDING.

" } } } @@ -3739,13 +3871,13 @@ "SavingsPlansUtilizationsByTime": { "target": "com.amazonaws.costexplorer#SavingsPlansUtilizationsByTime", "traits": { - "smithy.api#documentation": "

The amount of cost/commitment you used your Savings Plans. This allows you to specify date ranges.

" + "smithy.api#documentation": "

The amount of cost/commitment that you used your Savings Plans. You can use it to specify\n date ranges.

" } }, "Total": { "target": "com.amazonaws.costexplorer#SavingsPlansUtilizationAggregates", "traits": { - "smithy.api#documentation": "

The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.

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

The total amount of cost/commitment that you used your Savings Plans, regardless of date\n ranges.

", "smithy.api#required": {} } } @@ -3808,13 +3940,13 @@ "SortBy": { "target": "com.amazonaws.costexplorer#SortDefinitions", "traits": { - "smithy.api#documentation": "

The value by which you want to sort the data.

\n

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

Supported values for SortOrder are ASCENDING or DESCENDING.

\n

When using SortBy, NextPageToken and SearchString are not supported.

" + "smithy.api#documentation": "

The value that you want to sort the data by.

\n

The key represents cost and usage metrics. The following values are supported:

\n
    \n
  • \n

    \n BlendedCost\n

    \n
    • \n
  • \n

    \n UnblendedCost\n

    \n
    • \n
  • \n

    \n AmortizedCost\n

    \n
    • \n
  • \n

    \n NetAmortizedCost\n

    \n
    • \n
  • \n

    \n NetUnblendedCost\n

    \n
    • \n
  • \n

    \n UsageQuantity\n

    \n
    • \n
  • \n

    \n NormalizedUsageAmount\n

    \n
    • \n
\n

The supported values for SortOrder are ASCENDING and\n DESCENDING.

\n

When you use SortBy, NextPageToken and SearchString\n aren't supported.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#MaxResults", "traits": { - "smithy.api#documentation": "

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

\n

For GetTags, MaxResults has an upper limit of 1000.

" + "smithy.api#documentation": "

This field is only used when SortBy is provided in the request. The maximum number of\n objects that are returned for this request. If MaxResults isn't specified with SortBy, the\n request returns 1000 results as the default value for this parameter.

\n

For GetTags, MaxResults has an upper quota of 1000.

" } }, "NextPageToken": { @@ -3886,7 +4018,7 @@ "TimePeriod": { "target": "com.amazonaws.costexplorer#DateInterval", "traits": { - "smithy.api#documentation": "

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is \n\t\t retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

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

The start and end dates of the period that you want to retrieve usage forecast for. The\n start date is included in the period, but the end date isn't included in the period. For\n example, if start is 2017-01-01 and end is\n 2017-05-01, then the cost and usage data is retrieved from\n 2017-01-01 up to and including 2017-04-30 but not including\n 2017-05-01. The start date must be equal to or later than the current date to\n avoid a validation error.

", "smithy.api#required": {} } }, @@ -3913,7 +4045,7 @@ "PredictionIntervalLevel": { "target": "com.amazonaws.costexplorer#PredictionIntervalLevel", "traits": { - "smithy.api#documentation": "

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean \n\t\t\tby specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value \n\t\t\tfalling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" + "smithy.api#documentation": "

Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean \n\t\t\tby specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value \n\t\t\tfalling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" } } } @@ -4127,6 +4259,84 @@ "smithy.api#error": "client" } }, + "com.amazonaws.costexplorer#ListCostAllocationTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#ListCostAllocationTagsRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#ListCostAllocationTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a list of cost allocation tags. All inputs in the API are optional and serve as\n filters. By default, all cost allocation tags are returned.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.costexplorer#ListCostAllocationTagsRequest": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.costexplorer#CostAllocationTagStatus", + "traits": { + "smithy.api#documentation": "

The status of cost allocation tag keys that are returned for this request.

" + } + }, + "TagKeys": { + "target": "com.amazonaws.costexplorer#CostAllocationTagKeyList", + "traits": { + "smithy.api#documentation": "

The list of cost allocation tag keys that are returned for this request.

" + } + }, + "Type": { + "target": "com.amazonaws.costexplorer#CostAllocationTagType", + "traits": { + "smithy.api#documentation": "

The type of CostAllocationTag object that are returned for this request. The\n AWSGenerated type tags are tags that Amazon Web Services defines and applies to\n support Amazon Web Services resources for cost allocation purposes. The\n UserDefined type tags are tags that you define, create, and apply to resources.

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

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.costexplorer#CostAllocationTagsMaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of objects that are returned for this request. By default, the request\n returns 100 results.

" + } + } + } + }, + "com.amazonaws.costexplorer#ListCostAllocationTagsResponse": { + "type": "structure", + "members": { + "CostAllocationTags": { + "target": "com.amazonaws.costexplorer#CostAllocationTagList", + "traits": { + "smithy.api#documentation": "

A list of cost allocation tags that includes the detailed metadata for each one.

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

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

" + } + } + } + }, "com.amazonaws.costexplorer#ListCostCategoryDefinitions": { "type": "operation", "input": { @@ -4141,7 +4351,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the name, ARN, NumberOfRules and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100.

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

Returns the name, Amazon Resource Name (ARN), NumberOfRules and effective\n dates of all Cost Categories defined in the account. You have the option to use\n EffectiveOn to return a list of Cost Categories that were active on a specific\n date. If there is no EffectiveOn specified, you’ll see Cost Categories that are\n effective on the current date. If Cost Category is still effective, EffectiveEnd\n is omitted in the response. ListCostCategoryDefinitions supports pagination. The\n request can have a MaxResults range up to 100.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4155,20 +4365,20 @@ "EffectiveOn": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The date when the Cost Category was effective.\n

" + "smithy.api#documentation": "

The date when the Cost Category was effective.

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

\n The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.\n

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token\n when the response from a previous call has more results than the maximum page size.

" } }, "MaxResults": { "target": "com.amazonaws.costexplorer#CostCategoryMaxResults", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The number of entries a paginated response contains.

" + "smithy.api#documentation": "

The number of entries a paginated response contains.

" } } } @@ -4179,13 +4389,13 @@ "CostCategoryReferences": { "target": "com.amazonaws.costexplorer#CostCategoryReferencesList", "traits": { - "smithy.api#documentation": "

\n A reference to a Cost Category containing enough information to identify the Cost Category.\n

" + "smithy.api#documentation": "

A reference to a Cost Category that contains enough information to identify the Cost\n Category.

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

\n The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.\n

" + "smithy.api#documentation": "

The token to retrieve the next set of results. Amazon Web Services provides the token when\n the response from a previous call has more results than the maximum page size.

" } } } @@ -4228,7 +4438,7 @@ "ResourceTags": { "target": "com.amazonaws.costexplorer#ResourceTagList", "traits": { - "smithy.api#documentation": "

A list of tag key value pairs that are associated with the response.\n

" + "smithy.api#documentation": "

A list of tag key value pairs that are associated with the resource.\n

" } } } @@ -4398,7 +4608,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details on the modification recommendation.

" + "smithy.api#documentation": "

Details for the modification recommendation.

" } }, "com.amazonaws.costexplorer#MonitorArnList": { @@ -4442,30 +4652,30 @@ "NetworkInBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The network inbound throughput utilization measured in Bytes per second.

" + "smithy.api#documentation": "

The network inbound throughput utilization measured in Bytes per second (Bps).

" } }, "NetworkOutBytesPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The network outbound throughput utilization measured in Bytes per second.

" + "smithy.api#documentation": "

The network outbound throughput utilization measured in Bytes per second (Bps).

" } }, "NetworkPacketsInPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The network ingress packets that are measured in packets per second.

" + "smithy.api#documentation": "

The network inbound packets that are measured in packets per second.

" } }, "NetworkPacketsOutPerSecond": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The network outgress packets that are measured in packets per second.

" + "smithy.api#documentation": "

The network outbound packets that are measured in packets per second.

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

The network field that contains a list of network metrics that are associated with\n the current instance.

" + "smithy.api#documentation": "

The network field that contains a list of network metrics that are associated with the\n current instance.

" } }, "com.amazonaws.costexplorer#NextPageToken": { @@ -5018,7 +5228,7 @@ "AccountId": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The account that this RI recommendation is for.

" + "smithy.api#documentation": "

The account that this Reserved Instance (RI) recommendation is for.

" } }, "InstanceDetails": { @@ -5096,13 +5306,13 @@ "EstimatedMonthlySavingsAmount": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much Amazon Web Services estimates that this specific recommendation could save you\n in a month.

" + "smithy.api#documentation": "

How much Amazon Web Services estimates that this specific recommendation might save you\n in a month.

" } }, "EstimatedMonthlySavingsPercentage": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much Amazon Web Services estimates that this specific recommendation could save you\n in a month, as a percentage of your overall costs.

" + "smithy.api#documentation": "

How much Amazon Web Services estimates that this specific recommendation might save you\n in a month, as a percentage of your overall costs.

" } }, "EstimatedMonthlyOnDemandCost": { @@ -5114,7 +5324,7 @@ "EstimatedReservationCostForLookbackPeriod": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

How much Amazon Web Services estimates that you would have spent for all usage during\n the specified historical period if you had a reservation.

" + "smithy.api#documentation": "

How much Amazon Web Services estimates that you might spend for all usage during the\n specified historical period if you had a reservation.

" } }, "UpfrontCost": { @@ -5242,12 +5452,12 @@ "EC2ResourceDetails": { "target": "com.amazonaws.costexplorer#EC2ResourceDetails", "traits": { - "smithy.api#documentation": "

Details on the Amazon EC2 resource.

" + "smithy.api#documentation": "

Details for the Amazon EC2 resource.

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

Details on the resource.

" + "smithy.api#documentation": "

Details for the resource.

" } }, "com.amazonaws.costexplorer#ResourceNotFoundException": { @@ -5272,20 +5482,20 @@ "Key": { "target": "com.amazonaws.costexplorer#ResourceTagKey", "traits": { - "smithy.api#documentation": "

\n The key that is associated with the tag.\n

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

The key that's associated with the tag.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.costexplorer#ResourceTagValue", "traits": { - "smithy.api#documentation": "

\n The value that is associated with the tag.\n

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

The value that's associated with the tag.

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

\n The tag structure that contains a tag key and value. \n

\n \n

Tagging is supported only for the following Cost Explorer resource types: \n AnomalyMonitor\n , \n AnomalySubscription\n , \n CostCategory\n .

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

The tag structure that contains a tag key and value.

\n \n

Tagging is supported only for the following Cost Explorer resource types: \n AnomalyMonitor\n , \n AnomalySubscription\n , \n CostCategory\n .

\n " } }, "com.amazonaws.costexplorer#ResourceTagKey": { @@ -5396,7 +5606,7 @@ "CurrentInstance": { "target": "com.amazonaws.costexplorer#CurrentInstance", "traits": { - "smithy.api#documentation": "

Context regarding the current instance.

" + "smithy.api#documentation": "

Context\n regarding the current instance.

" } }, "RightsizingType": { @@ -5420,7 +5630,7 @@ "FindingReasonCodes": { "target": "com.amazonaws.costexplorer#FindingReasonCodes", "traits": { - "smithy.api#documentation": "

The list of possible reasons why the recommendation is generated such as under or\n over utilization of specific metrics (for example, CPU, Memory, Network).

" + "smithy.api#documentation": "

The list of possible reasons why the recommendation is generated, such as under- or\n over-utilization of specific metrics (for example, CPU, Memory, Network).

" } } }, @@ -5447,7 +5657,7 @@ } }, "traits": { - "smithy.api#documentation": "

You can use RightsizingRecommendationConfiguration to customize\n recommendations across two attributes. You can choose to view recommendations for\n instances within the same instance families or across different instance families. You\n can also choose to view your estimated savings that are associated with recommendations\n with consideration of existing Savings Plans or RI benefits, or neither.

" + "smithy.api#documentation": "

You can use RightsizingRecommendationConfiguration to customize\n recommendations across two attributes. You can choose to view recommendations for\n instances within the same instance families or across different instance families. You\n can also choose to view your estimated savings that are associated with recommendations\n with consideration of existing Savings Plans or Reserved Instance (RI) benefits, or\n neither.

" } }, "com.amazonaws.costexplorer#RightsizingRecommendationList": { @@ -5541,7 +5751,7 @@ "Service": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The Amazon Web Services service name that's associated with the cost anomaly.

" + "smithy.api#documentation": "

The Amazon Web Service name that's associated with the cost anomaly.

" } }, "Region": { @@ -5564,7 +5774,7 @@ } }, "traits": { - "smithy.api#documentation": "

The combination of Amazon Web Services service, linked account, Region, and usage type\n where a cost anomaly is observed.

" + "smithy.api#documentation": "

The combination of Amazon Web Service, linked account, Region, and usage type\n where a cost anomaly is observed.

" } }, "com.amazonaws.costexplorer#RootCauses": { @@ -5622,7 +5832,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of Savings Plans eligible usage that is covered by Savings Plans. All\n calculations consider the On-Demand equivalent of your Savings Plans usage.

" + "smithy.api#documentation": "

The amount of Savings Plans eligible usage that's covered by Savings Plans. All\n calculations consider the On-Demand equivalent of your Savings Plans usage.

" } }, "com.amazonaws.costexplorer#SavingsPlansCoverageData": { @@ -5631,7 +5841,7 @@ "SpendCoveredBySavingsPlans": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The amount of your Amazon Web Services usage that is covered by a Savings Plans.

" + "smithy.api#documentation": "

The amount of your Amazon Web Services usage that's covered by a Savings Plans.

" } }, "OnDemandCost": { @@ -5742,19 +5952,19 @@ "PaymentOption": { "target": "com.amazonaws.costexplorer#PaymentOption", "traits": { - "smithy.api#documentation": "

The payment option used to generate the recommendation.

" + "smithy.api#documentation": "

The payment option that's used to generate the recommendation.

" } }, "LookbackPeriodInDays": { "target": "com.amazonaws.costexplorer#LookbackPeriodInDays", "traits": { - "smithy.api#documentation": "

The lookback period in days, used to generate the recommendation.

" + "smithy.api#documentation": "

The lookback period in days that's used to generate the recommendation.

" } }, "SavingsPlansPurchaseRecommendationDetails": { "target": "com.amazonaws.costexplorer#SavingsPlansPurchaseRecommendationDetailList", "traits": { - "smithy.api#documentation": "

Details for the Savings Plans we recommend that you purchase to cover existing Savings\n Plans eligible workloads.

" + "smithy.api#documentation": "

Details for the Savings Plans that we recommend that you purchase to cover existing\n Savings Plans eligible workloads.

" } }, "SavingsPlansPurchaseRecommendationSummary": { @@ -5816,7 +6026,7 @@ "EstimatedOnDemandCostWithCurrentCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated On-Demand costs you would expect with no additional commitment, based\n on your usage of the selected time period and the Savings Plans you own.

" + "smithy.api#documentation": "

The estimated On-Demand costs you expect with no additional commitment, based on your\n usage of the selected time period and the Savings Plans you own.

" } }, "EstimatedSavingsAmount": { @@ -5890,7 +6100,7 @@ "GenerationTimestamp": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The timestamp showing when the recommendations were generated.

" + "smithy.api#documentation": "

The timestamp that shows when the recommendations were generated.

" } }, "AdditionalMetadata": { @@ -5970,7 +6180,7 @@ "EstimatedOnDemandCostWithCurrentCommitment": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "

The estimated On-Demand costs you would expect with no additional commitment. It's\n based on your usage of the selected time period and the Savings Plans you own.

" + "smithy.api#documentation": "

The estimated On-Demand costs you expect with no additional commitment. It's based on\n your usage of the selected time period and the Savings Plans you own.

" } } }, @@ -6043,7 +6253,7 @@ "Savings": { "target": "com.amazonaws.costexplorer#SavingsPlansSavings", "traits": { - "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings\n from Savings Plans, as well as the onDemandCostEquivalent of the Savings\n Plans when considering the utilization rate.

" + "smithy.api#documentation": "

The amount that's saved by using existing Savings Plans. Savings returns both net\n savings from Savings Plans and also the onDemandCostEquivalent of the\n Savings Plans when considering the utilization rate.

" } }, "AmortizedCommitment": { @@ -6076,7 +6286,7 @@ "Savings": { "target": "com.amazonaws.costexplorer#SavingsPlansSavings", "traits": { - "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings\n from Savings Plans as well as the onDemandCostEquivalent of the Savings\n Plans when considering the utilization rate.

" + "smithy.api#documentation": "

The amount that's saved by using existing Savings Plans. Savings returns both net\n savings from Savings Plans and also the onDemandCostEquivalent of the\n Savings Plans when considering the utilization rate.

" } }, "AmortizedCommitment": { @@ -6087,7 +6297,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of Savings Plans utilization, in hours.

" + "smithy.api#documentation": "

The amount of Savings Plans utilization (in hours).

" } }, "com.amazonaws.costexplorer#SavingsPlansUtilizationDetail": { @@ -6114,7 +6324,7 @@ "Savings": { "target": "com.amazonaws.costexplorer#SavingsPlansSavings", "traits": { - "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings\n from savings plans as well as the onDemandCostEquivalent of the Savings\n Plans when considering the utilization rate.

" + "smithy.api#documentation": "

The amount saved by using existing Savings Plans. Savings returns both net savings\n from savings plans and also the onDemandCostEquivalent of the Savings Plans\n when considering the utilization rate.

" } }, "AmortizedCommitment": { @@ -6125,7 +6335,7 @@ } }, "traits": { - "smithy.api#documentation": "

A single daily or monthly Savings Plans utilization rate, and details for your\n account. A management account in an organization have access to member accounts. You can\n use GetDimensionValues to determine the possible dimension values.

" + "smithy.api#documentation": "

A single daily or monthly Savings Plans utilization rate and details for your account.\n A management account in an organization have access to member accounts. You can use\n GetDimensionValues to determine the possible dimension values.

" } }, "com.amazonaws.costexplorer#SavingsPlansUtilizationDetails": { @@ -6195,7 +6405,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of how to sort the data.

" + "smithy.api#documentation": "

The details for how to sort the data.

" } }, "com.amazonaws.costexplorer#SortDefinitionKey": { @@ -6356,7 +6566,7 @@ } ], "traits": { - "smithy.api#documentation": "

An API operation for adding one or more tags (key-value pairs) to a resource.

\n

You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value you specify replaces the previous value for that tag.

\n

\n Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.

" + "smithy.api#documentation": "

An API operation for adding one or more tags (key-value pairs) to a resource.

\n

You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value you specify replaces the previous value for that tag.

\n

Although the maximum number of array members is 200, user-tag maximum is 50. The remaining\n are reserved for Amazon Web Services use.

" } }, "com.amazonaws.costexplorer#TagResourceRequest": { @@ -6372,7 +6582,7 @@ "ResourceTags": { "target": "com.amazonaws.costexplorer#ResourceTagList", "traits": { - "smithy.api#documentation": "

\n A list of tag key-value pairs to be added to the resource.

\n

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

\n
    \n
  • \n

    Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    \n
    • \n
  • \n

    The maximum length of a key is 128 characters

    \n
    • \n
  • \n

    The maximum length of a value is 256 characters

    \n
    • \n
  • \n

    Valid characters for keys and values are: A-Z, a-z, spaces, _.:/=+-\n

    \n
    • \n
  • \n

    Keys and values are case sensitive

    \n
    • \n
  • \n

    Keys and values are trimmed for any leading or trailing whitespaces

    \n
    • \n
  • \n

    Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

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

\n A list of tag key-value pairs to be added to the resource.

\n

Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

\n
    \n
  • \n

    Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    \n
    • \n
  • \n

    The maximum length of a key is 128 characters

    \n
    • \n
  • \n

    The maximum length of a value is 256 characters

    \n
    • \n
  • \n

    Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-\n

    \n
    • \n
  • \n

    Keys and values are case sensitive

    \n
    • \n
  • \n

    Keys and values are trimmed for any leading or trailing whitespaces

    \n
    • \n
  • \n

    Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

    \n
    • \n
", "smithy.api#required": {} } } @@ -6456,7 +6666,7 @@ "PlatformDifferences": { "target": "com.amazonaws.costexplorer#PlatformDifferences", "traits": { - "smithy.api#documentation": "

Explains the actions you might need to take in order to successfully migrate your\n workloads from the current instance type to the recommended instance type.

" + "smithy.api#documentation": "

Explains the actions that you might need to take to successfully migrate your\n workloads from the current instance type to the recommended instance type.

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

\n Removes one or more tags from a resource. Specify only tag key(s) in your request. Do not specify the value. \n

" + "smithy.api#documentation": "

Removes one or more tags from a resource. Specify only tag keys in your request. Don't\n specify the value.

" } }, "com.amazonaws.costexplorer#UntagResourceRequest": { @@ -6634,14 +6844,14 @@ "ResourceArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { - "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see ResourceTag.\n

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

The Amazon Resource Name (ARN) of the resource. For a list of supported resources, see\n ResourceTag.

", "smithy.api#required": {} } }, "ResourceTagKeys": { "target": "com.amazonaws.costexplorer#ResourceTagKeyList", "traits": { - "smithy.api#documentation": "

\n A list of tag keys associated with tags that need to be removed from the resource. If you specify a tag key that does not exist, it is ignored. Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.\n

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

A list of tag keys associated with tags that need to be removed from the resource. If you\n specify a tag key that doesn't exist, it's ignored. Although the maximum number of array\n members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.

", "smithy.api#required": {} } } @@ -6784,6 +6994,84 @@ } } }, + "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatusRequest" + }, + "output": { + "target": "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.costexplorer#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag\n status that's updated is the same as the existing tag status, the request doesn't fail.\n Instead, it doesn't have any effect on the tag status (for example, activating the active\n tag).

" + } + }, + "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatusError": { + "type": "structure", + "members": { + "TagKey": { + "target": "com.amazonaws.costexplorer#TagKey", + "traits": { + "smithy.api#documentation": "

The key for the cost allocation tag.

" + } + }, + "Code": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "

An error code representing why the action failed on this entry.

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

A message explaining why the action failed on this entry.

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

Gives a detailed description of the result of an action. It's on each cost allocation\n tag entry in the request.

" + } + }, + "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatusErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatusError" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatusRequest": { + "type": "structure", + "members": { + "CostAllocationTagsStatus": { + "target": "com.amazonaws.costexplorer#CostAllocationTagStatusList", + "traits": { + "smithy.api#documentation": "

The list of CostAllocationTagStatusEntry objects that are used to update cost\n allocation tags status for this request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatusResponse": { + "type": "structure", + "members": { + "Errors": { + "target": "com.amazonaws.costexplorer#UpdateCostAllocationTagsStatusErrors", + "traits": { + "smithy.api#documentation": "

A list of UpdateCostAllocationTagsStatusError objects with error details\n about each cost allocation tag that can't be updated. If there's no failure, an empty array\n returns.

" + } + } + } + }, "com.amazonaws.costexplorer#UpdateCostCategoryDefinition": { "type": "operation", "input": { @@ -6847,13 +7135,13 @@ "CostCategoryArn": { "target": "com.amazonaws.costexplorer#Arn", "traits": { - "smithy.api#documentation": "

\n The unique identifier for your Cost Category.\n

" + "smithy.api#documentation": "

The unique identifier for your Cost Category.

" } }, "EffectiveStart": { "target": "com.amazonaws.costexplorer#ZonedDateTime", "traits": { - "smithy.api#documentation": "

\n The Cost Category's effective start date.\n

" + "smithy.api#documentation": "

The Cost Category's effective start date.

" } } } @@ -6925,7 +7213,7 @@ "com.amazonaws.costexplorer#ZonedDateTime": { "type": "string", "traits": { - "smithy.api#documentation": "

The time period that you want the usage and costs for.

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

The period of time that you want the usage and costs for.

", "smithy.api#length": { "min": 20, "max": 25 diff --git a/aws/sdk/aws-models/chime-sdk-meetings.json b/aws/sdk/aws-models/chime-sdk-meetings.json index 67ec46a4a..c5f92b38a 100644 --- a/aws/sdk/aws-models/chime-sdk-meetings.json +++ b/aws/sdk/aws-models/chime-sdk-meetings.json @@ -60,12 +60,74 @@ "traits": { "smithy.api#documentation": "

The join token used by the Amazon Chime SDK attendee.

" } + }, + "Capabilities": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeCapabilities", + "traits": { + "smithy.api#documentation": "

The capabilities (audio, video, or content) assigned to an attendee.

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

An Amazon Chime SDK meeting attendee. Includes a unique \n AttendeeId and JoinToken. The \n JoinToken\n allows a client to authenticate and join as the specified attendee. The \n JoinToken\n expires when the meeting ends, or when \n DeleteAttendee\n is called. After that, the attendee is unable to join the meeting.\n

\n \n

We recommend securely transferring each JoinToken from your server application\n to the client so that no other client has access to the token except for the one\n authorized to represent the attendee.

" } }, + "com.amazonaws.chimesdkmeetings#AttendeeCapabilities": { + "type": "structure", + "members": { + "Audio": { + "target": "com.amazonaws.chimesdkmeetings#MediaCapabilities", + "traits": { + "smithy.api#documentation": "

The audio capability assigned to an attendee.

", + "smithy.api#required": {} + } + }, + "Video": { + "target": "com.amazonaws.chimesdkmeetings#MediaCapabilities", + "traits": { + "smithy.api#documentation": "

The video capability assigned to an attendee.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.chimesdkmeetings#MediaCapabilities", + "traits": { + "smithy.api#documentation": "

The content capability assigned to an attendee.

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

The media capabilities of an attendee, including audio, video and content.

" + } + }, + "com.amazonaws.chimesdkmeetings#AttendeeIdItem": { + "type": "structure", + "members": { + "AttendeeId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "

A list of one or more attendee IDs.

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

A structure that contains one or more attendee IDs.

" + } + }, + "com.amazonaws.chimesdkmeetings#AttendeeIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeIdItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250 + } + } + }, "com.amazonaws.chimesdkmeetings#AttendeeList": { "type": "list", "member": { @@ -197,6 +259,70 @@ } } }, + "com.amazonaws.chimesdkmeetings#BatchUpdateAttendeeCapabilitiesExcept": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#BatchUpdateAttendeeCapabilitiesExceptRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/meetings/{MeetingId}/attendees/capabilities?operation=batch-update-except", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#BatchUpdateAttendeeCapabilitiesExceptRequest": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the meeting associated with the update request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ExcludedAttendeeIds": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeIdsList", + "traits": { + "smithy.api#documentation": "

The AttendeeIDs that you want to exclude from one or more capabilities.

", + "smithy.api#required": {} + } + }, + "Capabilities": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeCapabilities", + "traits": { + "smithy.api#documentation": "

The capabilities (audio, video, or content) that you want to update.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.chimesdkmeetings#Boolean": { "type": "boolean" }, @@ -222,6 +348,9 @@ { "target": "com.amazonaws.chimesdkmeetings#BatchCreateAttendee" }, + { + "target": "com.amazonaws.chimesdkmeetings#BatchUpdateAttendeeCapabilitiesExcept" + }, { "target": "com.amazonaws.chimesdkmeetings#CreateAttendee" }, @@ -251,6 +380,9 @@ }, { "target": "com.amazonaws.chimesdkmeetings#StopMeetingTranscription" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UpdateAttendeeCapabilities" } ] }, @@ -265,6 +397,25 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkmeetings#ConflictException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "Message": { + "target": "com.amazonaws.chimesdkmeetings#String" + }, + "RequestId": { + "target": "com.amazonaws.chimesdkmeetings#String" + } + }, + "traits": { + "smithy.api#documentation": "

Multiple instances of the same request have been made simultaneously.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.chimesdkmeetings#CreateAttendee": { "type": "operation", "input": { @@ -354,6 +505,12 @@ "smithy.api#documentation": "

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

", "smithy.api#required": {} } + }, + "Capabilities": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeCapabilities", + "traits": { + "smithy.api#documentation": "

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on \n all media channels by default.

" + } } } }, @@ -366,6 +523,12 @@ "smithy.api#documentation": "

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

", "smithy.api#required": {} } + }, + "Capabilities": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeCapabilities", + "traits": { + "smithy.api#documentation": "

A list of one or more capabilities.

" + } } }, "traits": { @@ -1188,6 +1351,29 @@ } } }, + "com.amazonaws.chimesdkmeetings#MediaCapabilities": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SendReceive", + "name": "SEND_RECEIVE" + }, + { + "value": "Send", + "name": "SEND" + }, + { + "value": "Receive", + "name": "RECEIVE" + }, + { + "value": "None", + "name": "NONE" + } + ] + } + }, "com.amazonaws.chimesdkmeetings#MediaPlacement": { "type": "structure", "members": { @@ -1344,7 +1530,7 @@ "RequestId": { "target": "com.amazonaws.chimesdkmeetings#String", "traits": { - "smithy.api#documentation": "

The request id associated with the call responsible for the exception.

" + "smithy.api#documentation": "

The request ID associated with the call responsible for the exception.

" } } }, @@ -1416,7 +1602,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service encountered an unexpected error.

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

The service is currently unavailable.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1595,7 +1781,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of customer requests exceeds the request rate limit.

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

The number of requests exceeds the limit.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -1880,6 +2066,10 @@ { "value": "auto", "name": "AUTO" + }, + { + "value": "us-gov-west-1", + "name": "US_GOV_WEST_1" } ] } @@ -1966,6 +2156,79 @@ "smithy.api#error": "client", "smithy.api#httpError": 422 } + }, + "com.amazonaws.chimesdkmeetings#UpdateAttendeeCapabilities": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmeetings#UpdateAttendeeCapabilitiesRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmeetings#UpdateAttendeeCapabilitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmeetings#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmeetings#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

The capabilties that you want to update.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/meetings/{MeetingId}/attendees/{AttendeeId}/capabilities", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmeetings#UpdateAttendeeCapabilitiesRequest": { + "type": "structure", + "members": { + "MeetingId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the meeting associated with the update request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AttendeeId": { + "target": "com.amazonaws.chimesdkmeetings#GuidString", + "traits": { + "smithy.api#documentation": "

The ID of the attendee associated with the update request.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Capabilities": { + "target": "com.amazonaws.chimesdkmeetings#AttendeeCapabilities", + "traits": { + "smithy.api#documentation": "

The capabilties that you want to update.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmeetings#UpdateAttendeeCapabilitiesResponse": { + "type": "structure", + "members": { + "Attendee": { + "target": "com.amazonaws.chimesdkmeetings#Attendee" + } + } } } } diff --git a/aws/sdk/aws-models/chime-sdk-messaging.json b/aws/sdk/aws-models/chime-sdk-messaging.json index 812376a0e..4e0f4dc65 100644 --- a/aws/sdk/aws-models/chime-sdk-messaging.json +++ b/aws/sdk/aws-models/chime-sdk-messaging.json @@ -60,7 +60,7 @@ "ReadMarkerTimestamp": { "target": "com.amazonaws.chimesdkmessaging#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which a message was last read.

" + "smithy.api#documentation": "

The time at which an AppInstanceUser last marked a channel as read.

" } } }, @@ -73,6 +73,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#AssociateChannelFlowRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -648,6 +651,29 @@ "target": "com.amazonaws.chimesdkmessaging#ChannelFlowSummary" } }, + "com.amazonaws.chimesdkmessaging#ChannelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9]([A-Za-z0-9\\:\\-\\_\\.\\@]{0,62}[A-Za-z0-9])?$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMemberArns": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.chimesdkmessaging#ChannelMembership": { "type": "structure", "members": { @@ -1112,6 +1138,18 @@ "smithy.api#documentation": "

The details of a channel moderator.

" } }, + "com.amazonaws.chimesdkmessaging#ChannelModeratorArns": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.chimesdkmessaging#ChannelModeratorSummary": { "type": "structure", "members": { @@ -1221,7 +1259,7 @@ "name": "chime" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Chime SDK Messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK Identity APIs. For more information about the messaging\n APIs, see Amazon Chime SDK messaging\n

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

The Amazon Chime SDK Messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK Identity APIs. For more information about the messaging\n APIs, see Amazon Chime SDK messaging.

", "smithy.api#title": "Amazon Chime SDK Messaging" }, "version": "2021-05-15", @@ -1340,6 +1378,9 @@ { "target": "com.amazonaws.chimesdkmessaging#RedactChannelMessage" }, + { + "target": "com.amazonaws.chimesdkmessaging#SearchChannels" + }, { "target": "com.amazonaws.chimesdkmessaging#SendChannelMessage" }, @@ -1864,6 +1905,24 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "ChannelId": { + "target": "com.amazonaws.chimesdkmessaging#ChannelId", + "traits": { + "smithy.api#documentation": "

The ID of the channel in the request.

" + } + }, + "MemberArns": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMemberArns", + "traits": { + "smithy.api#documentation": "

The ARNs of the channel members in the request.

" + } + }, + "ModeratorArns": { + "target": "com.amazonaws.chimesdkmessaging#ChannelModeratorArns", + "traits": { + "smithy.api#documentation": "

The ARNs of the channel moderators in the request.

" + } } } }, @@ -1883,6 +1942,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#DeleteChannelRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -1917,6 +1979,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#DeleteChannelBanRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -1980,6 +2045,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#DeleteChannelFlowRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -2030,6 +2098,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#DeleteChannelMembershipRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -2096,6 +2167,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#DeleteChannelMessageRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -2159,6 +2233,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#DeleteChannelModeratorRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -2767,6 +2844,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#DisassociateChannelFlowRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -3015,7 +3095,10 @@ } }, "Member": { - "target": "com.amazonaws.chimesdkmessaging#Identity" + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The details of a user.

" + } }, "Preferences": { "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipPreferences", @@ -3604,7 +3687,7 @@ "ChannelMemberships": { "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipForAppInstanceUserSummaryList", "traits": { - "smithy.api#documentation": "

The token passed by previous API calls until all requested users are returned.

" + "smithy.api#documentation": "

The information for the requested channel memberships.

" } }, "NextToken": { @@ -4520,7 +4603,7 @@ "FilterRule": { "target": "com.amazonaws.chimesdkmessaging#FilterRule", "traits": { - "smithy.api#documentation": "

The simple JSON object used to send a subset of a push notification to the requsted member.

" + "smithy.api#documentation": "

The simple JSON object used to send a subset of a push notification to the requested member.

" } } }, @@ -4640,7 +4723,10 @@ } }, "Member": { - "target": "com.amazonaws.chimesdkmessaging#Identity" + "target": "com.amazonaws.chimesdkmessaging#Identity", + "traits": { + "smithy.api#documentation": "

The details of a user.

" + } }, "Preferences": { "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipPreferences", @@ -4662,6 +4748,9 @@ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, { "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" }, @@ -4760,6 +4849,187 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkmessaging#SearchChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#SearchChannelsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#SearchChannelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "

Allows an AppInstanceUser to search the channels that they belong to. The AppInstanceUser can search by membership or external ID. \n An AppInstanceAdmin can search across all channels within the AppInstance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/channels?operation=search", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#SearchChannelsRequest": { + "type": "structure", + "members": { + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "

The AppInstanceUserArn of the user making the API call.

", + "smithy.api#httpHeader": "x-amz-chime-bearer" + } + }, + "Fields": { + "target": "com.amazonaws.chimesdkmessaging#SearchFields", + "traits": { + "smithy.api#documentation": "

A list of the Field objects in the channel being searched.

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

The maximum number of channels that you want returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The token returned from previous API requests until the number of channels is reached.

", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#SearchChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "target": "com.amazonaws.chimesdkmessaging#ChannelSummaryList", + "traits": { + "smithy.api#documentation": "

A list of the channels in the request.

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

The token returned from previous API responses until the number of channels is reached.

" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#SearchField": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.chimesdkmessaging#SearchFieldKey", + "traits": { + "smithy.api#documentation": "

An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS \n operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.chimesdkmessaging#SearchFieldValues", + "traits": { + "smithy.api#documentation": "

The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.

\n \n

This operation isn't supported for AppInstanceUsers with large number of memberships.

\n ", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.chimesdkmessaging#SearchFieldOperator", + "traits": { + "smithy.api#documentation": "

The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS operator to find channels whose memberships equal the specified values. \n Use the INCLUDES operator to find channels whose memberships include the specified values.

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

A Field of the channel that you want to search.

" + } + }, + "com.amazonaws.chimesdkmessaging#SearchFieldKey": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MEMBERS", + "name": "MEMBERS" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#SearchFieldOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + }, + { + "value": "INCLUDES", + "name": "INCLUDES" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#SearchFieldValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.chimesdkmessaging#SearchFieldValues": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#SearchFieldValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.chimesdkmessaging#SearchFields": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#SearchField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, "com.amazonaws.chimesdkmessaging#SendChannelMessage": { "type": "operation", "input": { @@ -5012,6 +5282,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -5113,6 +5386,9 @@ "input": { "target": "com.amazonaws.chimesdkmessaging#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.chimesdkmessaging#BadRequestException" @@ -5469,15 +5745,13 @@ "Name": { "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", "traits": { - "smithy.api#documentation": "

The name of the channel.

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

The name of the channel.

" } }, "Mode": { "target": "com.amazonaws.chimesdkmessaging#ChannelMode", "traits": { - "smithy.api#documentation": "

The mode of the update request.

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

The mode of the update request.

" } }, "Metadata": { diff --git a/aws/sdk/aws-models/codeartifact.json b/aws/sdk/aws-models/codeartifact.json index 53ad19a8c..b32d5b2e9 100644 --- a/aws/sdk/aws-models/codeartifact.json +++ b/aws/sdk/aws-models/codeartifact.json @@ -52,7 +52,7 @@ "min": 12, "max": 12 }, - "smithy.api#pattern": "[0-9]{12}" + "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.codeartifact#Arn": { @@ -62,7 +62,7 @@ "min": 1, "max": 1011 }, - "smithy.api#pattern": "\\S+" + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.codeartifact#Asset": { @@ -87,7 +87,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "\\P{C}+" + "smithy.api#pattern": "^\\P{C}+$" } }, "com.amazonaws.codeartifact#AssetSummary": { @@ -177,7 +177,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -192,7 +192,7 @@ "externalConnection": { "target": "com.amazonaws.codeartifact#ExternalConnectionName", "traits": { - "smithy.api#documentation": "

\n The name of the external connection to add to the repository. The following values are supported:\n

\n
    \n
  • \n

    \n public:npmjs - for the npm public repository.\n

    \n
    • \n
  • \n

    \n public:pypi - for the Python Package Index.\n

    \n
    • \n
  • \n

    \n public:maven-central - for Maven Central.\n

    \n
    • \n
  • \n

    \n public:maven-googleandroid - for the Google Android repository.\n

    \n
    • \n
  • \n

    \n public:maven-gradleplugins - for the Gradle plugins repository.\n

    \n
    • \n
  • \n

    \n public:maven-commonsware - for the CommonsWare Android repository.\n

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

\n The name of the external connection to add to the repository. The following values are supported:\n

\n
    \n
  • \n

    \n public:npmjs - for the npm public repository.\n

    \n
    • \n
  • \n

    \n public:nuget-org - for the NuGet Gallery.\n

    \n
    • \n
  • \n

    \n public:pypi - for the Python Package Index.\n

    \n
    • \n
  • \n

    \n public:maven-central - for Maven Central.\n

    \n
    • \n
  • \n

    \n public:maven-googleandroid - for the Google Android repository.\n

    \n
    • \n
  • \n

    \n public:maven-gradleplugins - for the Gradle plugins repository.\n

    \n
    • \n
  • \n

    \n public:maven-commonsware - for the CommonsWare Android repository.\n

    \n
    • \n
", "smithy.api#httpQuery": "external-connection", "smithy.api#required": {} } @@ -228,6 +228,21 @@ }, "com.amazonaws.codeartifact#CodeArtifactControlPlaneService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "codeartifact", + "arnNamespace": "codeartifact", + "cloudFormationName": "Codeartifact", + "cloudTrailEventSource": "codeartifact.amazonaws.com", + "endpointPrefix": "codeartifact" + }, + "aws.auth#sigv4": { + "name": "codeartifact" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

CodeArtifact is a fully managed artifact repository compatible with language-native\n package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to\n share packages with development teams and pull packages. Packages can be pulled from both\n public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact\n repository and another repository, which effectively merges their contents from the point of\n view of a package manager client.

\n \n

\n CodeArtifact Components\n

\n

Use the information in this guide to help you work with the following CodeArtifact components:

\n \n
    \n
  • \n

    \n Repository: A CodeArtifact repository contains a set of package\n versions, each of which maps to a set of assets, or files. Repositories are\n polyglot, so a single repository can contain packages of any supported type. Each\n repository exposes endpoints for fetching and publishing packages using tools like the\n \n npm\n CLI, the Maven CLI (\n mvn\n ), Python CLIs (\n pip\n and twine), and NuGet CLIs (nuget and dotnet).

    \n
    • \n
  • \n

    \n Domain: Repositories are aggregated into a higher-level entity known as a\n domain. All package assets and metadata are stored in the domain,\n but are consumed through repositories. A given package asset, such as a Maven JAR file, is\n stored once per domain, no matter how many repositories it's present in. All of the assets\n and metadata in a domain are encrypted with the same customer master key (CMK) stored in\n Key Management Service (KMS).

    \n

    Each repository is a member of a single domain and can't be moved to a\n different domain.

    \n

    The domain allows organizational policy to be applied across multiple\n repositories, such as which accounts can access repositories in the domain, and\n which public repositories can be used as sources of packages.

    \n

    Although an organization can have multiple domains, we recommend a single production\n domain that contains all published artifacts so that teams can find and share packages\n across their organization.

    \n
    • \n
  • \n

    \n Package: A package is a bundle of software and the metadata required to\n resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, and NuGet package formats.

    \n

    In CodeArtifact, a package consists of:

    \n
      \n
    • \n

      A name (for example, webpack is the name of a\n popular npm package)

      \n
      • \n
    • \n

      An optional namespace (for example, @types in @types/node)

      \n
      • \n
    • \n

      A set of versions (for example, 1.0.0, 1.0.1,\n 1.0.2, etc.)

      \n
      • \n
    • \n

      Package-level metadata (for example, npm tags)

      \n
      • \n
    \n
    • \n
  • \n

    \n Package version: A version of a package, such as @types/node 12.6.9. The version number\n format and semantics vary for different package formats. For example, npm package versions\n must conform to the Semantic Versioning\n specification. In CodeArtifact, a package version consists of the version identifier,\n metadata at the package version level, and a set of assets.

    \n
    • \n
  • \n

    \n Upstream repository: One repository is upstream of another when the package versions in\n it can be accessed from the repository endpoint of the downstream repository, effectively\n merging the contents of the two repositories from the point of view of a client. CodeArtifact\n allows creating an upstream relationship between two repositories.

    \n
    • \n
  • \n

    \n Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm\n .tgz file or Maven POM and JAR files.

    \n
    • \n
\n \n

CodeArtifact supports these operations:

\n
    \n
  • \n

    \n AssociateExternalConnection: Adds an existing external \n connection to a repository.\n

    \n
    • \n
  • \n

    \n CopyPackageVersions: Copies package versions from one \n repository to another repository in the same domain.

    \n
    • \n
  • \n

    \n CreateDomain: Creates a domain

    \n
    • \n
  • \n

    \n CreateRepository: Creates a CodeArtifact repository in a domain.

    \n
    • \n
  • \n

    \n DeleteDomain: Deletes a domain. You cannot delete a domain that contains\n repositories.

    \n
    • \n
  • \n

    \n DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.

    \n
    • \n
  • \n

    \n DeletePackageVersions: Deletes versions of a package. After a package has\n been deleted, it can be republished, but its assets and metadata cannot be restored\n because they have been permanently removed from storage.

    \n
    • \n
  • \n

    \n DeleteRepository: Deletes a repository. \n

    \n
    • \n
  • \n

    \n DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.

    \n
    • \n
  • \n

    \n DescribeDomain: Returns a DomainDescription object that\n contains information about the requested domain.

    \n
    • \n
  • \n

    \n DescribePackageVersion: Returns a PackageVersionDescription\n object that contains details about a package version.

    \n
    • \n
  • \n

    \n DescribeRepository: Returns a RepositoryDescription object\n that contains detailed information about the requested repository.

    \n
    • \n
  • \n

    \n DisposePackageVersions: Disposes versions of a package. A package version\n with the status Disposed cannot be restored because they have been\n permanently removed from storage.

    \n
    • \n
  • \n

    \n DisassociateExternalConnection: Removes an existing external connection from a repository. \n

    \n
    • \n
  • \n

    \n GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. \n The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.

    \n
    • \n
  • \n

    \n GetDomainPermissionsPolicy: Returns the policy of a resource\n that is attached to the specified domain.

    \n
    • \n
  • \n

    \n GetPackageVersionAsset: Returns the contents of an asset that is in a package version.

    \n
    • \n
  • \n

    \n GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.

    \n
    • \n
  • \n

    \n GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n

    \n
      \n
    • \n

      \n maven\n

      \n
      • \n
    • \n

      \n npm\n

      \n
      • \n
    • \n

      \n nuget\n

      \n
      • \n
    • \n

      \n pypi\n

      \n
      • \n
    \n
    • \n
  • \n

    \n GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository. \n

    \n
    • \n
  • \n

    \n ListDomains: Returns a list of DomainSummary objects. Each\n returned DomainSummary object contains information about a domain.

    \n
    • \n
  • \n

    \n ListPackages: Lists the packages in a repository.

    \n
    • \n
  • \n

    \n ListPackageVersionAssets: Lists the assets for a given package version.

    \n
    • \n
  • \n

    \n ListPackageVersionDependencies: Returns a list of the direct dependencies for a\n package version.

    \n
    • \n
  • \n

    \n ListPackageVersions: Returns a list of package versions for a specified\n package in a repository.

    \n
    • \n
  • \n

    \n ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.

    \n
    • \n
  • \n

    \n ListRepositoriesInDomain: Returns a list of the repositories in a domain.

    \n
    • \n
  • \n

    \n PutDomainPermissionsPolicy: Attaches a resource policy to a domain.

    \n
    • \n
  • \n

    \n PutRepositoryPermissionsPolicy: Sets the resource policy on a repository\n that specifies permissions to access it.

    \n
    • \n
  • \n

    \n UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.

    \n
    • \n
  • \n

    \n UpdateRepository: Updates the properties of a repository.

    \n
    • \n
", + "smithy.api#title": "CodeArtifact" + }, "version": "2018-09-22", "operations": [ { @@ -332,22 +347,7 @@ { "target": "com.amazonaws.codeartifact#UpdateRepository" } - ], - "traits": { - "aws.api#service": { - "sdkId": "codeartifact", - "arnNamespace": "codeartifact", - "cloudFormationName": "Codeartifact", - "cloudTrailEventSource": "codeartifact.amazonaws.com", - "endpointPrefix": "codeartifact" - }, - "aws.auth#sigv4": { - "name": "codeartifact" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS CodeArtifact is a fully managed artifact repository compatible with language-native\n package managers and build tools such as npm, Apache Maven, and pip. You can use CodeArtifact to\n share packages with development teams and pull packages. Packages can be pulled from both\n public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact\n repository and another repository, which effectively merges their contents from the point of\n view of a package manager client.

\n \n

\n AWS CodeArtifact Components\n

\n

Use the information in this guide to help you work with the following CodeArtifact components:

\n \n
    \n
  • \n

    \n Repository: A CodeArtifact repository contains a set of package\n versions, each of which maps to a set of assets, or files. Repositories are\n polyglot, so a single repository can contain packages of any supported type. Each\n repository exposes endpoints for fetching and publishing packages using tools like the\n \n npm\n CLI, the Maven CLI (\n mvn\n ), and \n pip\n .

    \n
    • \n
  • \n

    \n Domain: Repositories are aggregated into a higher-level entity known as a\n domain. All package assets and metadata are stored in the domain,\n but are consumed through repositories. A given package asset, such as a Maven JAR file, is\n stored once per domain, no matter how many repositories it's present in. All of the assets\n and metadata in a domain are encrypted with the same customer master key (CMK) stored in\n AWS Key Management Service (AWS KMS).

    \n

    Each repository is a member of a single domain and can't be moved to a\n different domain.

    \n

    The domain allows organizational policy to be applied across multiple\n repositories, such as which accounts can access repositories in the domain, and\n which public repositories can be used as sources of packages.

    \n

    Although an organization can have multiple domains, we recommend a single production\n domain that contains all published artifacts so that teams can find and share packages\n across their organization.

    \n
    • \n
  • \n

    \n Package: A package is a bundle of software and the metadata required to\n resolve dependencies and install the software. CodeArtifact supports npm, PyPI, and Maven package formats.

    \n

    In CodeArtifact, a package consists of:

    \n
      \n
    • \n

      A name (for example, webpack is the name of a\n popular npm package)

      \n
      • \n
    • \n

      An optional namespace (for example, @types in @types/node)

      \n
      • \n
    • \n

      A set of versions (for example, 1.0.0, 1.0.1,\n 1.0.2, etc.)

      \n
      • \n
    • \n

      Package-level metadata (for example, npm tags)

      \n
      • \n
    \n
    • \n
  • \n

    \n Package version: A version of a package, such as @types/node 12.6.9. The version number\n format and semantics vary for different package formats. For example, npm package versions\n must conform to the Semantic Versioning\n specification. In CodeArtifact, a package version consists of the version identifier,\n metadata at the package version level, and a set of assets.

    \n
    • \n
  • \n

    \n Upstream repository: One repository is upstream of another when the package versions in\n it can be accessed from the repository endpoint of the downstream repository, effectively\n merging the contents of the two repositories from the point of view of a client. CodeArtifact\n allows creating an upstream relationship between two repositories.

    \n
    • \n
  • \n

    \n Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm\n .tgz file or Maven POM and JAR files.

    \n
    • \n
\n \n

CodeArtifact supports these operations:

\n
    \n
  • \n

    \n AssociateExternalConnection: Adds an existing external \n connection to a repository.\n

    \n
    • \n
  • \n

    \n CopyPackageVersions: Copies package versions from one \n repository to another repository in the same domain.

    \n
    • \n
  • \n

    \n CreateDomain: Creates a domain

    \n
    • \n
  • \n

    \n CreateRepository: Creates a CodeArtifact repository in a domain.

    \n
    • \n
  • \n

    \n DeleteDomain: Deletes a domain. You cannot delete a domain that contains\n repositories.

    \n
    • \n
  • \n

    \n DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.

    \n
    • \n
  • \n

    \n DeletePackageVersions: Deletes versions of a package. After a package has\n been deleted, it can be republished, but its assets and metadata cannot be restored\n because they have been permanently removed from storage.

    \n
    • \n
  • \n

    \n DeleteRepository: Deletes a repository. \n

    \n
    • \n
  • \n

    \n DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.

    \n
    • \n
  • \n

    \n DescribeDomain: Returns a DomainDescription object that\n contains information about the requested domain.

    \n
    • \n
  • \n

    \n DescribePackageVersion: Returns a PackageVersionDescription\n object that contains details about a package version.

    \n
    • \n
  • \n

    \n DescribeRepository: Returns a RepositoryDescription object\n that contains detailed information about the requested repository.

    \n
    • \n
  • \n

    \n DisposePackageVersions: Disposes versions of a package. A package version\n with the status Disposed cannot be restored because they have been\n permanently removed from storage.

    \n
    • \n
  • \n

    \n DisassociateExternalConnection: Removes an existing external connection from a repository. \n

    \n
    • \n
  • \n

    \n GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. \n The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.

    \n
    • \n
  • \n

    \n GetDomainPermissionsPolicy: Returns the policy of a resource\n that is attached to the specified domain.

    \n
    • \n
  • \n

    \n GetPackageVersionAsset: Returns the contents of an asset that is in a package version.

    \n
    • \n
  • \n

    \n GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.

    \n
    • \n
  • \n

    \n GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n

    \n
      \n
    • \n

      \n npm\n

      \n
      • \n
    • \n

      \n pypi\n

      \n
      • \n
    • \n

      \n maven\n

      \n
      • \n
    \n
    • \n
  • \n

    \n GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository. \n

    \n
    • \n
  • \n

    \n ListDomains: Returns a list of DomainSummary objects. Each\n returned DomainSummary object contains information about a domain.

    \n
    • \n
  • \n

    \n ListPackages: Lists the packages in a repository.

    \n
    • \n
  • \n

    \n ListPackageVersionAssets: Lists the assets for a given package version.

    \n
    • \n
  • \n

    \n ListPackageVersionDependencies: Returns a list of the direct dependencies for a\n package version.

    \n
    • \n
  • \n

    \n ListPackageVersions: Returns a list of package versions for a specified\n package in a repository.

    \n
    • \n
  • \n

    \n ListRepositories: Returns a list of repositories owned by the AWS account that called this method.

    \n
    • \n
  • \n

    \n ListRepositoriesInDomain: Returns a list of the repositories in a domain.

    \n
    • \n
  • \n

    \n PutDomainPermissionsPolicy: Attaches a resource policy to a domain.

    \n
    • \n
  • \n

    \n PutRepositoryPermissionsPolicy: Sets the resource policy on a repository\n that specifies permissions to access it.

    \n
    • \n
  • \n

    \n UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.

    \n
    • \n
  • \n

    \n UpdateRepository: Updates the properties of a repository.

    \n
    • \n
", - "smithy.api#title": "CodeArtifact" - } + ] }, "com.amazonaws.codeartifact#ConflictException": { "type": "structure", @@ -367,7 +367,7 @@ "resourceType": { "target": "com.amazonaws.codeartifact#ResourceType", "traits": { - "smithy.api#documentation": "

\n The type of AWS resource.\n

" + "smithy.api#documentation": "

\n The type of Amazon Web Services resource.\n

" } } }, @@ -431,7 +431,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -454,7 +454,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the package that is copied. The valid package types are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

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

\n The format of the package that is copied.\n

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

\n Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an\n organization. You can use a domain to apply permissions across many\n repositories owned by different AWS accounts. An asset is stored only once\n in a domain, even if it's in multiple repositories. \n

\n\n

Although you can have multiple domains, we recommend a single production domain that contains all\n published artifacts so that your development teams can find and share packages. You can use a second\n pre-production domain to test changes to the production domain configuration.\n

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

\n Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an\n organization. You can use a domain to apply permissions across many\n repositories owned by different Amazon Web Services accounts. An asset is stored only once\n in a domain, even if it's in multiple repositories. \n

\n\n

Although you can have multiple domains, we recommend a single production domain that contains all\n published artifacts so that your development teams can find and share packages. You can use a second\n pre-production domain to test changes to the production domain configuration.\n

", "smithy.api#http": { "method": "POST", "uri": "/v1/domain", @@ -563,7 +563,7 @@ "domain": { "target": "com.amazonaws.codeartifact#DomainName", "traits": { - "smithy.api#documentation": "

The name of the domain to create. All domain names in an AWS Region that are in the\n same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do\n not use sensitive information in a domain name because it is publicly discoverable.

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

The name of the domain to create. All domain names in an Amazon Web Services Region that are in the\n same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do\n not use sensitive information in a domain name because it is publicly discoverable.

", "smithy.api#httpQuery": "domain", "smithy.api#required": {} } @@ -571,7 +571,7 @@ "encryptionKey": { "target": "com.amazonaws.codeartifact#Arn", "traits": { - "smithy.api#documentation": "

The encryption key for the domain. This is used to encrypt content stored in a domain.\n An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key\n alias ARN. To specify an encryptionKey, your IAM role must have\n kms:DescribeKey and kms:CreateGrant permissions on the encryption\n key that is used. For more information, see DescribeKey in the AWS Key Management Service API Reference\n and AWS KMS API Permissions\n Reference in the AWS Key Management Service Developer Guide.

\n \n

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your\n domain. For more information, see Using symmetric and asymmetric\n keys in the AWS Key Management Service Developer Guide.

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

The encryption key for the domain. This is used to encrypt content stored in a domain.\n An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key\n alias ARN. To specify an encryptionKey, your IAM role must have\n kms:DescribeKey and kms:CreateGrant permissions on the encryption\n key that is used. For more information, see DescribeKey in the Key Management Service API Reference\n and Key Management Service API Permissions\n Reference in the Key Management Service Developer Guide.

\n \n

CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your\n domain. For more information, see Using symmetric and asymmetric\n keys in the Key Management Service Developer Guide.

\n " } }, "tags": { @@ -647,7 +647,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -668,7 +668,7 @@ "upstreams": { "target": "com.amazonaws.codeartifact#UpstreamRepositoryList", "traits": { - "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" + "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" } }, "tags": { @@ -775,7 +775,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -813,7 +813,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } } @@ -881,7 +881,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -896,7 +896,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the package versions to delete. The valid values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n The format of the package versions to delete.\n

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -926,7 +926,7 @@ "expectedStatus": { "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { - "smithy.api#documentation": "

\n The expected status of the package version to delete. Valid values are:\n

\n
    \n
  • \n

    \n Published\n

    \n
    • \n
  • \n

    \n Unfinished\n

    \n
    • \n
  • \n

    \n Unlisted\n

    \n
    • \n
  • \n

    \n Archived\n

    \n
    • \n
  • \n

    \n Disposed\n

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

\n The expected status of the package version to delete.\n

" } } } @@ -937,7 +937,7 @@ "successfulVersions": { "target": "com.amazonaws.codeartifact#SuccessfulPackageVersionInfoMap", "traits": { - "smithy.api#documentation": "

\n A list of the package versions that were successfully deleted.\n

" + "smithy.api#documentation": "

\n A list of the package versions that were successfully deleted. The \n status of every successful version will be Deleted.\n

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

\n Deletes the resource policy that is set on a repository. After a resource policy is deleted, the\n permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.\n

\n \n

\n Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, AWS users, roles, and accounts lose permissions to perform\n the repository actions granted by the deleted policy.\n

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

\n Deletes the resource policy that is set on a repository. After a resource policy is deleted, the\n permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.\n

\n \n

\n Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform\n the repository actions granted by the deleted policy.\n

\n ", "smithy.api#http": { "method": "DELETE", "uri": "/v1/repository/permissions/policies", @@ -1036,7 +1036,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -1082,7 +1082,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -1155,7 +1155,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } } @@ -1220,7 +1220,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -1235,7 +1235,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n A format that specifies the type of the requested package version. The valid values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n A format that specifies the type of the requested package version.\n

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -1325,7 +1325,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -1357,7 +1357,7 @@ "min": 0, "max": 1000 }, - "smithy.api#pattern": "\\P{C}+" + "smithy.api#pattern": "^\\P{C}+$" } }, "com.amazonaws.codeartifact#DisassociateExternalConnection": { @@ -1414,7 +1414,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -1498,7 +1498,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -1513,7 +1513,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n A format that specifies the type of package versions you want to dispose. The valid values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n A format that specifies the type of package versions you want to dispose.\n

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -1549,7 +1549,7 @@ "expectedStatus": { "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { - "smithy.api#documentation": "

\n The expected status of the package version to dispose. Valid values are:\n

\n
    \n
  • \n

    \n Published\n

    \n
    • \n
  • \n

    \n Unfinished\n

    \n
    • \n
  • \n

    \n Unlisted\n

    \n
    • \n
  • \n

    \n Archived\n

    \n
    • \n
  • \n

    \n Disposed\n

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

\n The expected status of the package version to dispose.\n

" } } } @@ -1583,7 +1583,7 @@ "owner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID that owns the domain.

" + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the domain.

" } }, "arn": { @@ -1595,7 +1595,7 @@ "status": { "target": "com.amazonaws.codeartifact#DomainStatus", "traits": { - "smithy.api#documentation": "

The current status of a domain. The valid values are

\n
    \n
  • \n

    \n Active\n

    \n
    • \n
  • \n

    \n Deleted\n

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

\n The current status of a domain.\n

" } }, "createdTime": { @@ -1607,7 +1607,7 @@ "encryptionKey": { "target": "com.amazonaws.codeartifact#Arn", "traits": { - "smithy.api#documentation": "

The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.

" + "smithy.api#documentation": "

The ARN of an Key Management Service (KMS) key associated with a domain.

" } }, "repositoryCount": { @@ -1640,7 +1640,7 @@ "min": 2, "max": 50 }, - "smithy.api#pattern": "[a-z][a-z0-9\\-]{0,48}[a-z0-9]" + "smithy.api#pattern": "^[a-z][a-z0-9\\-]{0,48}[a-z0-9]$" } }, "com.amazonaws.codeartifact#DomainStatus": { @@ -1670,7 +1670,7 @@ "owner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

" + "smithy.api#documentation": "

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

" } }, "arn": { @@ -1682,7 +1682,7 @@ "status": { "target": "com.amazonaws.codeartifact#DomainStatus", "traits": { - "smithy.api#documentation": "

\n A string that contains the status of the domain. The valid values are: \n

\n
    \n
  • \n

    \n Active\n

    \n
    • \n
  • \n

    \n Deleted\n

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

\n A string that contains the status of the domain. \n

" } }, "createdTime": { @@ -1714,7 +1714,7 @@ "com.amazonaws.codeartifact#ExternalConnectionName": { "type": "string", "traits": { - "smithy.api#pattern": "[A-Za-z0-9][A-Za-z0-9._\\-:]{1,99}" + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-:]{1,99}$" } }, "com.amazonaws.codeartifact#ExternalConnectionStatus": { @@ -1754,7 +1754,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Generates a temporary authorization token for accessing repositories in the domain. \n This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. \n For more information about authorization tokens, see \n AWS CodeArtifact authentication and tokens.\n

\n \n

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. \n You can call login periodically to refresh the token. When \n you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, \n up to a maximum of 12 hours, with the durationSeconds parameter.

\n

The authorization period begins after login \n or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while \n assuming a role, the token lifetime is independent of the maximum session duration \n of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then \n generate a CodeArtifact authorization token, the token will be valid for the full authorization period \n even though this is longer than the 15-minute session duration.

\n

See \n Using IAM Roles \n for more information on controlling session duration.

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

\n Generates a temporary authorization token for accessing repositories in the domain. \n This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. \n For more information about authorization tokens, see \n CodeArtifact authentication and tokens.\n

\n \n

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. \n You can call login periodically to refresh the token. When \n you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, \n up to a maximum of 12 hours, with the durationSeconds parameter.

\n

The authorization period begins after login \n or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while \n assuming a role, the token lifetime is independent of the maximum session duration \n of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then \n generate a CodeArtifact authorization token, the token will be valid for the full authorization period \n even though this is longer than the 15-minute session duration.

\n

See \n Using IAM Roles \n for more information on controlling session duration.

\n ", "smithy.api#http": { "method": "POST", "uri": "/v1/authorization-token", @@ -1776,7 +1776,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -1832,7 +1832,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns the resource policy attached to the specified domain.\n

\n \n

\n The policy is a resource-based policy, not an identity-based policy. For more information, see\n Identity-based policies\n and resource-based policies in the AWS Identity and Access Management User Guide.\n

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

\n Returns the resource policy attached to the specified domain.\n

\n \n

\n The policy is a resource-based policy, not an identity-based policy. For more information, see\n Identity-based policies\n and resource-based policies in the IAM User Guide.\n

\n ", "smithy.api#http": { "method": "GET", "uri": "/v1/domain/permissions/policy", @@ -1854,7 +1854,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } } @@ -1922,7 +1922,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -1937,7 +1937,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n A format that specifies the type of the package version with the requested asset file. The valid values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n A format that specifies the type of the package version with the requested asset file.\n

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

\n Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact\n extracts a description from a metadata file. For example, from the element in the\n pom.xml file of a Maven package.\n

\n

\n The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.\n

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

\n Gets the readme file or descriptive text for a package version.\n

\n

\n The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.\n

", "smithy.api#http": { "method": "GET", "uri": "/v1/package/version/readme", @@ -2063,7 +2063,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -2078,7 +2078,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n A format that specifies the type of the package version with the requested readme file. The valid values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n A format that specifies the type of the package version with the requested readme file.\n

\n \n

Although maven is \n listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.

\n ", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -2114,7 +2114,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the package with the requested readme file. Valid format types are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n The format of the package with the requested readme file.\n

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

\n Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each \n package format:\n

\n
    \n
  • \n

    \n maven\n

    \n
    • \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n nuget\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
", "smithy.api#http": { "method": "GET", "uri": "/v1/repository/endpoint", @@ -2197,7 +2197,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -2212,7 +2212,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n Returns which endpoint of a repository to return. A repository has one endpoint for each \n package format:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n Returns which endpoint of a repository to return. A repository has one endpoint for each \n package format.\n

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -2278,7 +2278,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -2333,7 +2333,7 @@ "min": 32, "max": 512 }, - "smithy.api#pattern": "[0-9a-f]+" + "smithy.api#pattern": "^[0-9a-f]+$" } }, "com.amazonaws.codeartifact#Integer": { @@ -2350,7 +2350,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation did not succeed because of an error that occurred inside AWS CodeArtifact.

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

The operation did not succeed because of an error that occurred inside CodeArtifact.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -2404,7 +2404,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of DomainSummary objects for all domains owned by the AWS account that makes\n this call. Each returned DomainSummary object contains information about a\n domain.

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

Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes\n this call. Each returned DomainSummary object contains information about a\n domain.

", "smithy.api#http": { "method": "POST", "uri": "/v1/domains", @@ -2413,6 +2413,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "domains", "pageSize": "maxResults" } } @@ -2496,6 +2497,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "assets", "pageSize": "maxResults" } } @@ -2524,7 +2526,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -2539,7 +2541,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the package that contains the returned package version assets. The valid package types are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

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

\n The format of the package that contains the returned package version assets.\n

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -2678,7 +2680,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -2693,7 +2695,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the package with the requested dependencies. The valid package types are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

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

\n The format of the package with the requested dependencies.\n

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -2736,7 +2738,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n A format that specifies the type of the package that contains the returned dependencies. The valid values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n A format that specifies the type of the package that contains the returned dependencies.\n

" } }, "namespace": { @@ -2812,6 +2814,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "versions", "pageSize": "maxResults" } } @@ -2840,7 +2843,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -2855,7 +2858,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the returned packages. The valid package types are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

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

\n The format of the returned packages.\n

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -2878,7 +2881,7 @@ "status": { "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { - "smithy.api#documentation": "

\n A string that specifies the status of the package versions to include in the returned list. It can be one of the following:\n

\n
    \n
  • \n

    \n Published\n

    \n
    • \n
  • \n

    \n Unfinished\n

    \n
    • \n
  • \n

    \n Unlisted\n

    \n
    • \n
  • \n

    \n Archived\n

    \n
    • \n
  • \n

    \n Disposed\n

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

\n A string that specifies the status of the package versions to include in the returned list.\n

", "smithy.api#httpQuery": "status" } }, @@ -2917,7 +2920,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n A format of the package. Valid package format values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n A format of the package.\n

" } }, "namespace": { @@ -2981,6 +2984,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "packages", "pageSize": "maxResults" } } @@ -3009,7 +3013,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -3024,7 +3028,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the packages. The valid package types are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

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

\n The format of the packages.\n

", "smithy.api#httpQuery": "format" } }, @@ -3098,7 +3102,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns a list of \n RepositorySummary \n objects. Each RepositorySummary contains information about a repository in the specified AWS account and that matches the input \n parameters.\n

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

\n Returns a list of \n RepositorySummary \n objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input \n parameters.\n

", "smithy.api#http": { "method": "POST", "uri": "/v1/repositories", @@ -3107,6 +3111,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "repositories", "pageSize": "maxResults" } } @@ -3146,6 +3151,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "repositories", "pageSize": "maxResults" } } @@ -3174,14 +3180,14 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, "administratorAccount": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n Filter the list of repositories to only include those that are managed by the AWS account ID.\n

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

\n Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.\n

", "smithy.api#httpQuery": "administrator-account" } }, @@ -3301,7 +3307,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.

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

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

", "smithy.api#http": { "method": "POST", "uri": "/v1/tags", @@ -3410,7 +3416,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[^!#/\\s]+" + "smithy.api#pattern": "^[^!#/\\s]+$" } }, "com.amazonaws.codeartifact#PackageNamespace": { @@ -3420,7 +3426,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[^!#/\\s]+" + "smithy.api#pattern": "^[^!#/\\s]+$" } }, "com.amazonaws.codeartifact#PackageSummary": { @@ -3429,7 +3435,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the package. Valid values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n The format of the package.\n

" } }, "namespace": { @@ -3462,7 +3468,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "[^!#/\\s]+" + "smithy.api#pattern": "^[^!#/\\s]+$" } }, "com.amazonaws.codeartifact#PackageVersionDescription": { @@ -3471,7 +3477,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The format of the package version. The valid package formats are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

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

\n The format of the package version.\n

" } }, "namespace": { @@ -3537,7 +3543,7 @@ "status": { "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { - "smithy.api#documentation": "

\n A string that contains the status of the package version. It can be one of the following:\n

\n
    \n
  • \n

    \n Published\n

    \n
    • \n
  • \n

    \n Unfinished\n

    \n
    • \n
  • \n

    \n Unlisted\n

    \n
    • \n
  • \n

    \n Archived\n

    \n
    • \n
  • \n

    \n Disposed\n

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

\n A string that contains the status of the package version.\n

" } } }, @@ -3624,7 +3630,7 @@ "min": 1, "max": 50 }, - "smithy.api#pattern": "\\S+" + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.codeartifact#PackageVersionRevisionMap": { @@ -3697,7 +3703,7 @@ "status": { "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { - "smithy.api#documentation": "

\n A string that contains the status of the package version. It can be one of the following:\n

\n
    \n
  • \n

    \n Published\n

    \n
    • \n
  • \n

    \n Unfinished\n

    \n
    • \n
  • \n

    \n Unlisted\n

    \n
    • \n
  • \n

    \n Archived\n

    \n
    • \n
  • \n

    \n Disposed\n

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

\n A string that contains the status of the package version. It can be one of the following:\n

", "smithy.api#required": {} } } @@ -3719,7 +3725,7 @@ "min": 1, "max": 2000 }, - "smithy.api#pattern": "\\S+" + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.codeartifact#PolicyDocument": { @@ -3738,7 +3744,7 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "\\S+" + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.codeartifact#PutDomainPermissionsPolicy": { @@ -3794,7 +3800,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

" + "smithy.api#documentation": "

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

" } }, "policyRevision": { @@ -3877,7 +3883,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -3927,7 +3933,7 @@ "administratorAccount": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

The 12-digit account number of the AWS account that manages the repository.

" + "smithy.api#documentation": "

The 12-digit account number of the Amazon Web Services account that manages the repository.

" } }, "domainName": { @@ -3939,7 +3945,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include \n dashes or spaces.\n

" + "smithy.api#documentation": "

\n The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include \n dashes or spaces.\n

" } }, "arn": { @@ -3957,7 +3963,7 @@ "upstreams": { "target": "com.amazonaws.codeartifact#UpstreamRepositoryInfoList", "traits": { - "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" + "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" } }, "externalConnections": { @@ -3968,7 +3974,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of a repository stored in AWS CodeArtifact. A CodeArtifact repository contains a set of\n package versions, each of which maps to a set of assets. Repositories are polyglot—a single\n repository can contain packages of any supported type. Each repository exposes endpoints for\n fetching and publishing packages using tools like the npm CLI, the Maven CLI\n (mvn), and pip. You can create up to 100 repositories per AWS\n account.

" + "smithy.api#documentation": "

The details of a repository stored in CodeArtifact. A CodeArtifact repository contains a set of\n package versions, each of which maps to a set of assets. Repositories are polyglot—a single\n repository can contain packages of any supported type. Each repository exposes endpoints for\n fetching and publishing packages using tools like the npm CLI, the Maven CLI\n (mvn), and pip. You can create up to 100 repositories per Amazon Web Services\n account.

" } }, "com.amazonaws.codeartifact#RepositoryExternalConnectionInfo": { @@ -3983,7 +3989,7 @@ "packageFormat": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The package format associated with a repository's external connection. The valid package formats are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

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

\n The package format associated with a repository's external connection. The valid package formats are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

    \n
    • \n
  • \n

    \n nuget: A NuGet package.\n

    \n
    • \n
" } }, "status": { @@ -4010,7 +4016,7 @@ "min": 2, "max": 100 }, - "smithy.api#pattern": "[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}" + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-]{1,99}$" } }, "com.amazonaws.codeartifact#RepositorySummary": { @@ -4025,7 +4031,7 @@ "administratorAccount": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The AWS account ID that manages the repository.\n

" + "smithy.api#documentation": "

\n The Amazon Web Services account ID that manages the repository.\n

" } }, "domainName": { @@ -4037,7 +4043,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

" + "smithy.api#documentation": "

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

" } }, "arn": { @@ -4081,7 +4087,7 @@ "resourceType": { "target": "com.amazonaws.codeartifact#ResourceType", "traits": { - "smithy.api#documentation": "

\n The type of AWS resource.\n

" + "smithy.api#documentation": "

\n The type of Amazon Web Services resource.\n

" } } }, @@ -4114,7 +4120,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n An AWS CodeArtifact resource policy that contains a resource ARN, document details, and a revision.\n

" + "smithy.api#documentation": "

\n An CodeArtifact resource policy that contains a resource ARN, document details, and a revision.\n

" } }, "com.amazonaws.codeartifact#ResourceType": { @@ -4168,7 +4174,7 @@ "resourceType": { "target": "com.amazonaws.codeartifact#ResourceType", "traits": { - "smithy.api#documentation": "

\n The type of AWS resource.\n

" + "smithy.api#documentation": "

\n The type of Amazon Web Services resource.\n

" } } }, @@ -4202,7 +4208,7 @@ "status": { "target": "com.amazonaws.codeartifact#PackageVersionStatus", "traits": { - "smithy.api#documentation": "

\n The status of a package version. Valid statuses are:\n

\n
    \n
  • \n

    \n Published\n

    \n
    • \n
  • \n

    \n Unfinished\n

    \n
    • \n
  • \n

    \n Unlisted\n

    \n
    • \n
  • \n

    \n Archived\n

    \n
    • \n
  • \n

    \n Disposed\n

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

\n The status of a package version.\n

" } } }, @@ -4238,7 +4244,7 @@ } }, "traits": { - "smithy.api#documentation": "

A tag is a key-value pair that can be used to manage, search for, or filter resources in AWS CodeArtifact.

" + "smithy.api#documentation": "

A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.

" } }, "com.amazonaws.codeartifact#TagKey": { @@ -4300,7 +4306,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates tags for a resource in AWS CodeArtifact.

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

Adds or updates tags for a resource in CodeArtifact.

", "smithy.api#http": { "method": "POST", "uri": "/v1/tag", @@ -4390,7 +4396,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes tags from a resource in AWS CodeArtifact.

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

Removes tags from a resource in CodeArtifact.

", "smithy.api#http": { "method": "POST", "uri": "/v1/untag", @@ -4451,7 +4457,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Updates the status of one or more versions of a package.\n

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

\n Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, \n you can update the status of package versions to Archived, Published, or Unlisted. \n To set the status of a package version to Disposed, use \n DisposePackageVersions.\n

", "smithy.api#http": { "method": "POST", "uri": "/v1/package/versions/update_status", @@ -4473,7 +4479,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -4488,7 +4494,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n A format that specifies the type of the package with the statuses to update. The valid values are:\n

\n
    \n
  • \n

    \n npm\n

    \n
    • \n
  • \n

    \n pypi\n

    \n
    • \n
  • \n

    \n maven\n

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

\n A format that specifies the type of the package with the statuses to update.\n

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -4607,7 +4613,7 @@ "domainOwner": { "target": "com.amazonaws.codeartifact#AccountId", "traits": { - "smithy.api#documentation": "

\n The 12-digit account number of the AWS account that owns the domain. It does not include \n dashes or spaces.\n

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

\n The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include \n dashes or spaces.\n

", "smithy.api#httpQuery": "domain-owner" } }, @@ -4628,7 +4634,7 @@ "upstreams": { "target": "com.amazonaws.codeartifact#UpstreamRepositoryList", "traits": { - "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" + "smithy.api#documentation": "

A list of upstream repositories to associate with the repository. The order of the upstream repositories \n in the list determines their priority order when CodeArtifact looks for a requested package version. For more \n information, see Working with upstream repositories.

" } } } diff --git a/aws/sdk/aws-models/cognito-idp.json b/aws/sdk/aws-models/cognito-idp.json index b2ca47a4d..eddf9487c 100644 --- a/aws/sdk/aws-models/cognito-idp.json +++ b/aws/sdk/aws-models/cognito-idp.json @@ -1517,7 +1517,7 @@ "ContextData": { "target": "com.amazonaws.cognitoidentityprovider#ContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } } }, @@ -2151,7 +2151,7 @@ "ContextData": { "target": "com.amazonaws.cognitoidentityprovider#ContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } }, "ClientMetadata": { @@ -2763,7 +2763,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception is thrown when a user tries to confirm the account with an email\n address or phone number that has already been supplied as an alias from a different\n account. This exception indicates that an account with this email address or phone\n already exists in a user pool that you've configured to use email address or phone\n number as a sign-in alias.

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

This exception is thrown when a user tries to confirm the account with an email\n address or phone number that has already been supplied as an alias for a different\n user profile. This exception indicates that an account with this email address or phone\n already exists in a user pool that you've configured to use email address or phone\n number as a sign-in alias.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2859,7 +2859,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a unique generated shared secret key code for the user account. The request\n takes an access token or a session string, but not both.

\n \n

Calling AssociateSoftwareToken immediately disassociates the existing software\n token from the user account. If the user doesn't subsequently verify the software\n token, their account is set up to authenticate without MFA. If MFA config is set to\n Optional at the user pool level, the user can then log in without MFA. However, if\n MFA is set to Required for the user pool, the user is asked to set up a new software\n token MFA during sign-in.

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

Begins setup of time-based one-time password multi-factor authentication (TOTP MFA)\n for a user, with a unique private key that Amazon Cognito generates and returns in the API\n response. You can authorize an AssociateSoftwareToken request with either\n the user's access token, or a session string from a challenge response that you received\n from Amazon Cognito.

\n \n

Amazon Cognito disassociates an existing software token when you verify the new token in a\n VerifySoftwareToken API request. If you don't verify the software\n token and your user pool doesn't require MFA, the user can then authenticate with\n user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito\n generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge\n each time your user signs. Complete setup with AssociateSoftwareToken\n and VerifySoftwareToken.

\n

After you set up software token MFA for your user, Amazon Cognito generates a\n SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to\n this challenge with your user's TOTP.

\n " } }, "com.amazonaws.cognitoidentityprovider#AssociateSoftwareTokenRequest": { @@ -3787,7 +3787,7 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } }, "ClientMetadata": { @@ -3911,7 +3911,7 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } }, "ClientMetadata": { @@ -3948,7 +3948,7 @@ "IpAddress": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

Source IP address of your user.

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

The source IP address of your user's device.

", "smithy.api#required": {} } }, @@ -3976,7 +3976,7 @@ "EncodedData": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

Encoded data containing device fingerprinting details collected using the Amazon Cognito\n context data collection library.

" + "smithy.api#documentation": "

Encoded device-fingerprint details that your app collected with the Amazon Cognito\n context data collection library. For more information, see Adding user device and session data to API requests.

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

Activates or deactivates token revocation. For more information about revoking tokens,\n see RevokeToken.

\n

If you don't include this parameter, token revocation is automatically activated for\n the new user pool client.

" } + }, + "EnablePropagateAdditionalUserContextData": { + "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", + "traits": { + "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

" + } } }, "traits": { @@ -4680,7 +4686,7 @@ "UserAttributeUpdateSettings": { "target": "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to to email addresses and phone numbers.

" } }, "DeviceConfiguration": { @@ -6118,7 +6124,7 @@ "IpAddress": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

The user's IP address.

" + "smithy.api#documentation": "

The source IP address of your user's device.

" } }, "DeviceName": { @@ -6491,7 +6497,7 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } }, "Username": { @@ -6529,7 +6535,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the response from the server regarding the request to reset a\n password.

" + "smithy.api#documentation": "

The response from Amazon Cognito to a request to reset a password.

" } }, "com.amazonaws.cognitoidentityprovider#GenerateSecret": { @@ -7560,7 +7566,7 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } } }, @@ -9350,7 +9356,7 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } }, "Username": { @@ -9632,7 +9638,7 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } }, "ClientMetadata": { @@ -10509,7 +10515,7 @@ "UserContextData": { "target": "com.amazonaws.cognitoidentityprovider#UserContextDataType", "traits": { - "smithy.api#documentation": "

Contextual data such as the user's device fingerprint, IP address, or location used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced \nsecurity evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito\nwhen it makes API requests.

" } }, "ClientMetadata": { @@ -10972,19 +10978,19 @@ "AccessToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in\n AccessTokenValidity, defaulting to hours.

" + "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the AccessTokenValidity\n parameter. The default AccessTokenValidity time unit is hours.

" } }, "IdToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in\n IdTokenValidity, defaulting to hours.

" + "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the IdTokenValidity\n parameter. The default IdTokenValidity time unit is hours.

" } }, "RefreshToken": { "target": "com.amazonaws.cognitoidentityprovider#TimeUnitsType", "traits": { - "smithy.api#documentation": "

A time unit in “seconds”, “minutes”, “hours”, or “days” for the value in\n RefreshTokenValidity, defaulting to days.

" + "smithy.api#documentation": "

A time unit of seconds, minutes, hours, or\n days for the value that you set in the\n RefreshTokenValidity parameter. The default\n RefreshTokenValidity time unit is days.

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

Activates or deactivates token revocation. For more information about revoking tokens,\n see RevokeToken.

" } + }, + "EnablePropagateAdditionalUserContextData": { + "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", + "traits": { + "smithy.api#documentation": "

Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.

" + } } }, "traits": { @@ -12070,7 +12082,7 @@ "UserAttributeUpdateSettings": { "target": "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to to email addresses and phone numbers.

" } }, "MfaConfiguration": { @@ -12144,21 +12156,27 @@ } }, "traits": { - "smithy.api#documentation": "

The settings for updates to user attributes.

" + "smithy.api#documentation": "

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to to email addresses and phone numbers.

" } }, "com.amazonaws.cognitoidentityprovider#UserContextDataType": { "type": "structure", "members": { + "IpAddress": { + "target": "com.amazonaws.cognitoidentityprovider#StringType", + "traits": { + "smithy.api#documentation": "

The source IP address of your user's device.

" + } + }, "EncodedData": { "target": "com.amazonaws.cognitoidentityprovider#StringType", "traits": { - "smithy.api#documentation": "

Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + "smithy.api#documentation": "

Encoded device-fingerprint details that your app collected with the Amazon Cognito\n context data collection library. For more information, see Adding user device and session data to API requests.

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

Information that your app generates about a user's AdminInitiateAuth or\n AdminRespondToAuthChallenge session. Amazon Cognito advanced security features\n calculate risk levels for user sessions based on this context data.

" + "smithy.api#documentation": "

Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced\n security.

" } }, "com.amazonaws.cognitoidentityprovider#UserFilterType": { @@ -12598,6 +12616,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether token revocation is activated for the user pool client. When you\n create a new user pool client, token revocation is activated by default. For more\n information about revoking tokens, see RevokeToken.

" } + }, + "EnablePropagateAdditionalUserContextData": { + "target": "com.amazonaws.cognitoidentityprovider#WrappedBooleanType", + "traits": { + "smithy.api#documentation": "

When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an\n IpAddress value that you send in the UserContextData\n parameter. The UserContextData parameter sends information to Amazon Cognito\n advanced security for risk analysis. You can send UserContextData when you\n sign in Amazon Cognito native users with the InitiateAuth and\n RespondToAuthChallenge API operations.

\n

When EnablePropagateAdditionalUserContextData is false, you can't send\n your user's source IP address to Amazon Cognito advanced security with unauthenticated API\n operations. EnablePropagateAdditionalUserContextData doesn't affect whether\n you can send a source IP address in a ContextData parameter with the\n authenticated API operations AdminInitiateAuth and\n AdminRespondToAuthChallenge.

\n

You can only activate EnablePropagateAdditionalUserContextData in an app\n client that has a client secret. For more information about propagation of user context\n data, see Adding user device and session data to API requests.

" + } } }, "traits": { @@ -12837,7 +12861,7 @@ "UserAttributeUpdateSettings": { "target": "com.amazonaws.cognitoidentityprovider#UserAttributeUpdateSettingsType", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,\na user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For\nmore information, see \nVerifying updates to to email addresses and phone numbers.

" } }, "MfaConfiguration": { diff --git a/aws/sdk/aws-models/connect.json b/aws/sdk/aws-models/connect.json index 54edb3855..1772c9974 100644 --- a/aws/sdk/aws-models/connect.json +++ b/aws/sdk/aws-models/connect.json @@ -57,6 +57,59 @@ } } }, + "com.amazonaws.connect#AgentContactReference": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

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

The channel of the contact.

" + } + }, + "InitiationMethod": { + "target": "com.amazonaws.connect#ContactInitiationMethod", + "traits": { + "smithy.api#documentation": "

How the contact was initiated.

" + } + }, + "AgentContactState": { + "target": "com.amazonaws.connect#ContactState", + "traits": { + "smithy.api#documentation": "

The state of the contact.

" + } + }, + "StateStartTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The epoch timestamp when the contact state started.

" + } + }, + "ConnectedToAgentTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The time at which the contact was connected to an agent.

" + } + }, + "Queue": { + "target": "com.amazonaws.connect#QueueReference" + } + }, + "traits": { + "smithy.api#documentation": "

Information about the contact associated to the\n user.

" + } + }, + "com.amazonaws.connect#AgentContactReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AgentContactReference" + } + }, "com.amazonaws.connect#AgentFirstName": { "type": "string", "traits": { @@ -191,6 +244,26 @@ } } }, + "com.amazonaws.connect#AgentStatusReference": { + "type": "structure", + "members": { + "StatusStartTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The start timestamp of the agent's status.

" + } + }, + "StatusArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent's status.

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

Information about the agent's status.

" + } + }, "com.amazonaws.connect#AgentStatusState": { "type": "string", "traits": { @@ -375,6 +448,9 @@ { "target": "com.amazonaws.connect#CreateSecurityProfile" }, + { + "target": "com.amazonaws.connect#CreateTaskTemplate" + }, { "target": "com.amazonaws.connect#CreateUseCase" }, @@ -408,6 +484,9 @@ { "target": "com.amazonaws.connect#DeleteSecurityProfile" }, + { + "target": "com.amazonaws.connect#DeleteTaskTemplate" + }, { "target": "com.amazonaws.connect#DeleteUseCase" }, @@ -504,12 +583,18 @@ { "target": "com.amazonaws.connect#GetCurrentMetricData" }, + { + "target": "com.amazonaws.connect#GetCurrentUserData" + }, { "target": "com.amazonaws.connect#GetFederationToken" }, { "target": "com.amazonaws.connect#GetMetricData" }, + { + "target": "com.amazonaws.connect#GetTaskTemplate" + }, { "target": "com.amazonaws.connect#ListAgentStatuses" }, @@ -588,6 +673,9 @@ { "target": "com.amazonaws.connect#ListTagsForResource" }, + { + "target": "com.amazonaws.connect#ListTaskTemplates" + }, { "target": "com.amazonaws.connect#ListUseCases" }, @@ -645,6 +733,9 @@ { "target": "com.amazonaws.connect#TagResource" }, + { + "target": "com.amazonaws.connect#TransferContact" + }, { "target": "com.amazonaws.connect#UntagResource" }, @@ -723,6 +814,9 @@ { "target": "com.amazonaws.connect#UpdateSecurityProfile" }, + { + "target": "com.amazonaws.connect#UpdateTaskTemplate" + }, { "target": "com.amazonaws.connect#UpdateUserHierarchy" }, @@ -920,7 +1014,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

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

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call\n and real-time analysis sessions for the given language.

", "smithy.api#http": { "method": "PUT", "uri": "/default-vocabulary/{InstanceId}/{LanguageCode}", @@ -1434,18 +1528,18 @@ "Value": { "target": "com.amazonaws.connect#ReferenceValue", "traits": { - "smithy.api#documentation": "

Contains the location path of the attachment reference.

" + "smithy.api#documentation": "

The location path of the attachment reference.

" } }, "Status": { "target": "com.amazonaws.connect#ReferenceStatus", "traits": { - "smithy.api#documentation": "

Status of an attachment reference type.

" + "smithy.api#documentation": "

Status of the attachment reference type.

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

Information about the attachment reference if the referenceType is\n ATTACHMENT. Otherwise, null.

" + "smithy.api#documentation": "

Information about a reference when the referenceType is\n ATTACHMENT. Otherwise, null.

" } }, "com.amazonaws.connect#Attribute": { @@ -1585,6 +1679,15 @@ ] } }, + "com.amazonaws.connect#ChannelToCountMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#Channel" + }, + "value": { + "target": "com.amazonaws.connect#IntegerCount" + } + }, "com.amazonaws.connect#Channels": { "type": "list", "member": { @@ -1721,7 +1824,7 @@ "PhoneNumber": { "target": "com.amazonaws.connect#PhoneNumber", "traits": { - "smithy.api#documentation": "

The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code].

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

The phone number you want to claim. Phone numbers are formatted [+] [country code]\n [subscriber number including area code].

", "smithy.api#required": {} } }, @@ -1955,6 +2058,20 @@ "smithy.api#documentation": "

Contains information about a contact.

" } }, + "com.amazonaws.connect#ContactFilter": { + "type": "structure", + "members": { + "ContactStates": { + "target": "com.amazonaws.connect#ContactStates", + "traits": { + "smithy.api#documentation": "

A list of up to 9 contact states.

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

Filters user data based on the contact information that is associated to\n the users. It contains a list of contact states.

" + } + }, "com.amazonaws.connect#ContactFlow": { "type": "structure", "members": { @@ -2392,19 +2509,74 @@ "target": "com.amazonaws.connect#Reference" } }, + "com.amazonaws.connect#ContactState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INCOMING", + "name": "INCOMING" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "CONNECTING", + "name": "CONNECTING" + }, + { + "value": "CONNECTED", + "name": "CONNECTED" + }, + { + "value": "CONNECTED_ONHOLD", + "name": "CONNECTED_ONHOLD" + }, + { + "value": "MISSED", + "name": "MISSED" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "ENDED", + "name": "ENDED" + }, + { + "value": "REJECTED", + "name": "REJECTED" + } + ] + } + }, + "com.amazonaws.connect#ContactStates": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 9 + } + } + }, "com.amazonaws.connect#ControlPlaneTagFilter": { "type": "structure", "members": { "OrConditions": { "target": "com.amazonaws.connect#TagOrConditionList", "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.\n

" } }, "AndConditions": { "target": "com.amazonaws.connect#TagAndConditionList", "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND\n condition.

" } }, "TagCondition": { @@ -2415,7 +2587,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an\n OR of AND (List of List) input where:

\n
    \n
  • \n

    Top level list specifies conditions that need to be applied\n with OR operator

    \n
    • \n
  • \n

    Inner list specifies conditions that need to be applied with AND\n operator.

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

An object that can be used to specify Tag conditions inside the SearchFilter.\n This accepts an OR of AND (List of List) input where:

\n
    \n
  • \n

    Top level list specifies conditions that need to be applied with OR\n operator

    \n
    • \n
  • \n

    Inner list specifies conditions that need to be applied with AND\n operator.

    \n
    • \n
" } }, "com.amazonaws.connect#CreateAgentStatus": { @@ -3455,6 +3627,126 @@ } } }, + "com.amazonaws.connect#CreateTaskTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateTaskTemplateRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateTaskTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#PropertyValidationException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new task template in the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/instance/{InstanceId}/task/template", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateTaskTemplateRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

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

The identifier of the flow that runs by default when a task is created by referencing this template.

" + } + }, + "Constraints": { + "target": "com.amazonaws.connect#TaskTemplateConstraints", + "traits": { + "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" + } + }, + "Defaults": { + "target": "com.amazonaws.connect#TaskTemplateDefaults", + "traits": { + "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" + } + }, + "Status": { + "target": "com.amazonaws.connect#TaskTemplateStatus", + "traits": { + "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "Fields": { + "target": "com.amazonaws.connect#TaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Fields that are part of the template.

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.connect#CreateTaskTemplateResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

The identifier of the task template resource.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.connect#TaskTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the task template resource.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#CreateUseCase": { "type": "operation", "input": { @@ -3832,7 +4124,7 @@ "Content": { "target": "com.amazonaws.connect#VocabularyContent", "traits": { - "smithy.api#documentation": "

The content of the custom vocabulary in plain-text format with a table of values. Each row\n in the table represents a word or a phrase, described with Phrase, IPA,\n SoundsLike, and DisplayAs fields. Separate the fields with TAB\n characters. The size limit is 50KB. For more information, see Create a custom\n vocabulary using a table.

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

The content of the custom vocabulary in plain-text format with a table of values. Each row\n in the table represents a word or a phrase, described with Phrase, IPA,\n SoundsLike, and DisplayAs fields. Separate the fields with TAB\n characters. The size limit is 50KB. For more information, see Create a custom\n vocabulary using a table.

", "smithy.api#required": {} } }, @@ -4041,6 +4333,26 @@ "target": "com.amazonaws.connect#CurrentMetric" } }, + "com.amazonaws.connect#DateReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the date reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid date.

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

Information about a reference when the referenceType is DATE.\n Otherwise, null.

" + } + }, "com.amazonaws.connect#DefaultVocabulary": { "type": "structure", "members": { @@ -4476,18 +4788,21 @@ } } }, - "com.amazonaws.connect#DeleteUseCase": { + "com.amazonaws.connect#DeleteTaskTemplate": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeleteUseCaseRequest" + "target": "com.amazonaws.connect#DeleteTaskTemplateRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.connect#DeleteTaskTemplateResponse" }, "errors": [ { "target": "com.amazonaws.connect#InternalServiceException" }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, { "target": "com.amazonaws.connect#InvalidRequestException" }, @@ -4499,15 +4814,15 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a use case from an integration association.

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

Deletes the task template.

", "smithy.api#http": { "method": "DELETE", - "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}", + "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", "code": 200 } } }, - "com.amazonaws.connect#DeleteUseCaseRequest": { + "com.amazonaws.connect#DeleteTaskTemplateRequest": { "type": "structure", "members": { "InstanceId": { @@ -4518,28 +4833,24 @@ "smithy.api#required": {} } }, - "IntegrationAssociationId": { - "target": "com.amazonaws.connect#IntegrationAssociationId", - "traits": { - "smithy.api#documentation": "

The identifier for the integration association.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UseCaseId": { - "target": "com.amazonaws.connect#UseCaseId", + "TaskTemplateId": { + "target": "com.amazonaws.connect#TaskTemplateId", "traits": { - "smithy.api#documentation": "

The identifier for the use case.

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

A unique identifier for the task template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.connect#DeleteUser": { + "com.amazonaws.connect#DeleteTaskTemplateResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#DeleteUseCase": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DeleteUserRequest" + "target": "com.amazonaws.connect#DeleteUseCaseRequest" }, "output": { "target": "smithy.api#Unit" @@ -4548,9 +4859,69 @@ { "target": "com.amazonaws.connect#InternalServiceException" }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a use case from an integration association.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/instance/{InstanceId}/integration-associations/{IntegrationAssociationId}/use-cases/{UseCaseId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteUseCaseRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IntegrationAssociationId": { + "target": "com.amazonaws.connect#IntegrationAssociationId", + "traits": { + "smithy.api#documentation": "

The identifier for the integration association.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UseCaseId": { + "target": "com.amazonaws.connect#UseCaseId", + "traits": { + "smithy.api#documentation": "

The identifier for the use case.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteUserRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, { "target": "com.amazonaws.connect#InvalidRequestException" }, @@ -5834,7 +6205,7 @@ "Vocabulary": { "target": "com.amazonaws.connect#Vocabulary", "traits": { - "smithy.api#documentation": "

A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They\n are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or\n proper nouns.

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

A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are\n generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper\n nouns.

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

Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if a contact flow association exists.

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

Removes the contact flow association from a phone number claimed to your Amazon Connect instance, if\n a contact flow association exists.

", "smithy.api#http": { "method": "DELETE", "uri": "/phone-number/{PhoneNumberId}/contact-flow", @@ -6480,6 +6851,26 @@ "com.amazonaws.connect#Email": { "type": "string" }, + "com.amazonaws.connect#EmailReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the email reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid email address.

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

Information about a reference when the referenceType is EMAIL.\n Otherwise, null.

" + } + }, "com.amazonaws.connect#EncryptionConfig": { "type": "structure", "members": { @@ -6716,6 +7107,95 @@ } } }, + "com.amazonaws.connect#GetCurrentUserData": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetCurrentUserDataRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetCurrentUserDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the real-time active user data from the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "POST", + "uri": "/metrics/userdata/{InstanceId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#GetCurrentUserDataRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.connect#UserDataFilters", + "traits": { + "smithy.api#documentation": "

Filters up to 100 Queues, or up to 9 ContactStates. The user data is retrieved only for those users who are associated with\n the queues and have contacts that are in the specified ContactState.

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

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + } + } + }, + "com.amazonaws.connect#GetCurrentUserDataResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

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

A list of the user data that is returned.

" + } + } + } + }, "com.amazonaws.connect#GetFederationToken": { "type": "operation", "input": { @@ -6893,79 +7373,227 @@ } } }, - "com.amazonaws.connect#Grouping": { - "type": "string", + "com.amazonaws.connect#GetTaskTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#GetTaskTemplateRequest" + }, + "output": { + "target": "com.amazonaws.connect#GetTaskTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], "traits": { - "smithy.api#enum": [ - { - "value": "QUEUE", - "name": "QUEUE" - }, - { - "value": "CHANNEL", - "name": "CHANNEL" - } - ] + "smithy.api#documentation": "

Gets details about a specific task template in the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", + "code": 200 + } } }, - "com.amazonaws.connect#Groupings": { - "type": "list", - "member": { - "target": "com.amazonaws.connect#Grouping" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 + "com.amazonaws.connect#GetTaskTemplateRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TaskTemplateId": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SnapshotVersion": { + "target": "com.amazonaws.connect#SnapshotVersion", + "traits": { + "smithy.api#documentation": "

The system generated version of a task template that is associated with a task, when the\n task is created.

", + "smithy.api#httpQuery": "snapshotVersion" + } } } }, - "com.amazonaws.connect#HierarchyGroup": { + "com.amazonaws.connect#GetTaskTemplateResponse": { "type": "structure", "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + } + }, "Id": { - "target": "com.amazonaws.connect#HierarchyGroupId", + "target": "com.amazonaws.connect#TaskTemplateId", "traits": { - "smithy.api#documentation": "

The identifier of the hierarchy group.

" + "smithy.api#documentation": "

A unique identifier for the task template.

", + "smithy.api#required": {} } }, "Arn": { - "target": "com.amazonaws.connect#ARN", + "target": "com.amazonaws.connect#TaskTemplateArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN).

", + "smithy.api#required": {} } }, "Name": { - "target": "com.amazonaws.connect#HierarchyGroupName", + "target": "com.amazonaws.connect#TaskTemplateName", "traits": { - "smithy.api#documentation": "

The name of the hierarchy group.

" + "smithy.api#documentation": "

The name of the task template.

", + "smithy.api#required": {} } }, - "LevelId": { - "target": "com.amazonaws.connect#HierarchyLevelId", + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", "traits": { - "smithy.api#documentation": "

The identifier of the level in the hierarchy group.

" + "smithy.api#documentation": "

The description of the task template.

" } }, - "HierarchyPath": { - "target": "com.amazonaws.connect#HierarchyPath", + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

Information about the levels in the hierarchy group.

" + "smithy.api#documentation": "

The identifier of the flow that runs by default when a task is created by referencing this template.

" } }, - "Tags": { - "target": "com.amazonaws.connect#TagMap", + "Constraints": { + "target": "com.amazonaws.connect#TaskTemplateConstraints", "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

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

Contains information about a hierarchy group.

" - } - }, - "com.amazonaws.connect#HierarchyGroupCondition": { - "type": "structure", + }, + "Defaults": { + "target": "com.amazonaws.connect#TaskTemplateDefaults", + "traits": { + "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" + } + }, + "Fields": { + "target": "com.amazonaws.connect#TaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Fields that are part of the template.

" + } + }, + "Status": { + "target": "com.amazonaws.connect#TaskTemplateStatus", + "traits": { + "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was last modified.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was created.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + } + }, + "com.amazonaws.connect#Grouping": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUEUE", + "name": "QUEUE" + }, + { + "value": "CHANNEL", + "name": "CHANNEL" + } + ] + } + }, + "com.amazonaws.connect#Groupings": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Grouping" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.connect#HierarchyGroup": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The identifier of the hierarchy group.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the hierarchy group.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#HierarchyGroupName", + "traits": { + "smithy.api#documentation": "

The name of the hierarchy group.

" + } + }, + "LevelId": { + "target": "com.amazonaws.connect#HierarchyLevelId", + "traits": { + "smithy.api#documentation": "

The identifier of the level in the hierarchy group.

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

Information about the levels in the hierarchy group.

" + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

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

Contains information about a hierarchy group.

" + } + }, + "com.amazonaws.connect#HierarchyGroupCondition": { + "type": "structure", "members": { "Value": { "target": "com.amazonaws.connect#String", @@ -7037,6 +7665,26 @@ "target": "com.amazonaws.connect#HierarchyGroupSummary" } }, + "com.amazonaws.connect#HierarchyGroupSummaryReference": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#HierarchyGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the hierarchy group.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the hierarchy group.

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

Information about the hierarchy group.

" + } + }, "com.amazonaws.connect#HierarchyLevel": { "type": "structure", "members": { @@ -7122,6 +7770,44 @@ "smithy.api#documentation": "

Contains information about the levels of a hierarchy group.

" } }, + "com.amazonaws.connect#HierarchyPathReference": { + "type": "structure", + "members": { + "LevelOne": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level one.

" + } + }, + "LevelTwo": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level two.

" + } + }, + "LevelThree": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level three.

" + } + }, + "LevelFour": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level four.

" + } + }, + "LevelFive": { + "target": "com.amazonaws.connect#HierarchyGroupSummaryReference", + "traits": { + "smithy.api#documentation": "

Information about level five.

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

Information about the levels in the hierarchy group.

" + } + }, "com.amazonaws.connect#HierarchyStructure": { "type": "structure", "members": { @@ -7734,6 +8420,10 @@ { "value": "MULTI_PARTY_CONFERENCE", "name": "MULTI_PARTY_CONFERENCE" + }, + { + "value": "HIGH_VOLUME_OUTBOUND", + "name": "HIGH_VOLUME_OUTBOUND" } ] } @@ -7943,6 +8633,15 @@ "target": "com.amazonaws.connect#InstanceSummary" } }, + "com.amazonaws.connect#IntegerCount": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.connect#IntegrationAssociationId": { "type": "string", "traits": { @@ -8118,6 +8817,26 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.connect#InvisibleFieldInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the invisible field.

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

A field that is invisible to an agent.

" + } + }, + "com.amazonaws.connect#InvisibleTaskTemplateFields": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#InvisibleFieldInfo" + } + }, "com.amazonaws.connect#KeyId": { "type": "string", "traits": { @@ -9696,7 +10415,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists phone numbers claimed to your Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator Guide.

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

Lists phone numbers claimed to your Amazon Connect instance.

\n

For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/phone-number/list", @@ -9716,7 +10435,7 @@ "TargetArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If TargetArn input is not provided, this API lists numbers claimed\n to all the Amazon Connect instances belonging to your account.

" } }, "MaxResults": { @@ -10629,6 +11348,105 @@ } } }, + "com.amazonaws.connect#ListTaskTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListTaskTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListTaskTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists task templates for the specified Amazon Connect instance.

", + "smithy.api#http": { + "method": "GET", + "uri": "/instance/{InstanceId}/task/template", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TaskTemplates", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListTaskTemplatesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

\n \n

It is not expected that you set this because the value returned in the previous response is\n always null.

\n ", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

\n \n

It is not expected that you set this.

\n ", + "smithy.api#httpQuery": "maxResults" + } + }, + "Status": { + "target": "com.amazonaws.connect#TaskTemplateStatus", + "traits": { + "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

", + "smithy.api#httpQuery": "status" + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

", + "smithy.api#httpQuery": "name" + } + } + } + }, + "com.amazonaws.connect#ListTaskTemplatesResponse": { + "type": "structure", + "members": { + "TaskTemplates": { + "target": "com.amazonaws.connect#TaskTemplateList", + "traits": { + "smithy.api#documentation": "

Provides details about a list of task templates belonging to an instance.

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

If there are additional results, this is the token for the next set of results.

\n \n

This is always returned as a null in the response.

\n " + } + } + } + }, "com.amazonaws.connect#ListUseCases": { "type": "operation", "input": { @@ -11007,10 +11825,30 @@ } } }, - "com.amazonaws.connect#Origin": { - "type": "string", - "traits": { - "smithy.api#length": { + "com.amazonaws.connect#NumberReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the number reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid number.

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

Information about a reference when the referenceType is NUMBER.\n Otherwise, null.

" + } + }, + "com.amazonaws.connect#Origin": { + "type": "string", + "traits": { + "smithy.api#length": { "min": 0, "max": 267 } @@ -12388,6 +13226,91 @@ "target": "com.amazonaws.connect#PromptSummary" } }, + "com.amazonaws.connect#PropertyValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message", + "traits": { + "smithy.api#required": {} + } + }, + "PropertyList": { + "target": "com.amazonaws.connect#PropertyValidationExceptionPropertyList" + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.connect#PropertyValidationExceptionProperty": { + "type": "structure", + "members": { + "PropertyPath": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "

The full property path.

", + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.connect#PropertyValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

Why the property is not valid.

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

A message describing why the property is not valid.

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

Contains information about why a property is not valid.

" + } + }, + "com.amazonaws.connect#PropertyValidationExceptionPropertyList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PropertyValidationExceptionProperty" + } + }, + "com.amazonaws.connect#PropertyValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INVALID_FORMAT", + "name": "INVALID_FORMAT" + }, + { + "value": "UNIQUE_CONSTRAINT_VIOLATED", + "name": "UNIQUE_CONSTRAINT_VIOLATED" + }, + { + "value": "REFERENCED_RESOURCE_NOT_FOUND", + "name": "REFERENCED_RESOURCE_NOT_FOUND" + }, + { + "value": "RESOURCE_NAME_ALREADY_EXISTS", + "name": "RESOURCE_NAME_ALREADY_EXISTS" + }, + { + "value": "REQUIRED_PROPERTY_MISSING", + "name": "REQUIRED_PROPERTY_MISSING" + }, + { + "value": "NOT_SUPPORTED", + "name": "NOT_SUPPORTED" + } + ] + } + }, "com.amazonaws.connect#PutUserStatus": { "type": "operation", "input": { @@ -12417,7 +13340,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the current status of a user or agent in Amazon Connect.\n If the agent is currently handling a contact, this sets the agent's next status.

\n

For more information, see Agent status \n and Set your next status\n in the Amazon Connect Administrator Guide.

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

Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a\n contact, this sets the agent's next status.

\n

For more information, see Agent status and Set your next\n status in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/users/{InstanceId}/{UserId}/status", @@ -12882,6 +13805,26 @@ } } }, + "com.amazonaws.connect#ReadOnlyFieldInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the read-only field.

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

Indicates a field that is read-only to an agent.

" + } + }, + "com.amazonaws.connect#ReadOnlyTaskTemplateFields": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ReadOnlyFieldInfo" + } + }, "com.amazonaws.connect#Reference": { "type": "structure", "members": { @@ -12895,13 +13838,13 @@ "Type": { "target": "com.amazonaws.connect#ReferenceType", "traits": { - "smithy.api#documentation": "

The type of the reference. Only URL type can be added or updated on a\n contact.

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

The type of the reference.

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

A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes\n across all references for a contact.

" + "smithy.api#documentation": "

Well-formed data on a contact, used by agents to complete a contact request. You can have up\n to 4,096 UTF-8 bytes across all references for a contact.

" } }, "com.amazonaws.connect#ReferenceKey": { @@ -12934,13 +13877,37 @@ "Url": { "target": "com.amazonaws.connect#UrlReference", "traits": { - "smithy.api#documentation": "

Information about the URL reference if the referenceType is URL.\n Otherwise, null.

" + "smithy.api#documentation": "

Information about the reference when the referenceType is URL.\n Otherwise, null.

" } }, "Attachment": { "target": "com.amazonaws.connect#AttachmentReference", "traits": { - "smithy.api#documentation": "

Information about the attachment reference if the referenceType is\n ATTACHMENT. Otherwise, null.

" + "smithy.api#documentation": "

Information about the reference when the referenceType is\n ATTACHMENT. Otherwise, null.

" + } + }, + "String": { + "target": "com.amazonaws.connect#StringReference", + "traits": { + "smithy.api#documentation": "

Information about a reference when the referenceType is STRING.\n Otherwise, null.

" + } + }, + "Number": { + "target": "com.amazonaws.connect#NumberReference", + "traits": { + "smithy.api#documentation": "

Information about a reference when the referenceType is NUMBER.\n Otherwise, null.

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

Information about a reference when the referenceType is DATE.\n Otherwise, null.

" + } + }, + "Email": { + "target": "com.amazonaws.connect#EmailReference", + "traits": { + "smithy.api#documentation": "

Information about a reference when the referenceType is EMAIL.\n Otherwise, null.

" } } }, @@ -12965,6 +13932,22 @@ { "value": "ATTACHMENT", "name": "ATTACHMENT" + }, + { + "value": "NUMBER", + "name": "NUMBER" + }, + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "DATE", + "name": "DATE" + }, + { + "value": "EMAIL", + "name": "EMAIL" } ] } @@ -12977,7 +13960,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 2 + "max": 6 } } }, @@ -13051,6 +14034,26 @@ } } }, + "com.amazonaws.connect#RequiredFieldInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for the field.

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

Information about a required field.

" + } + }, + "com.amazonaws.connect#RequiredTaskTemplateFields": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RequiredFieldInfo" + } + }, "com.amazonaws.connect#ResourceConflictException": { "type": "structure", "members": { @@ -13402,6 +14405,26 @@ "target": "com.amazonaws.connect#RoutingProfileQueueReference" } }, + "com.amazonaws.connect#RoutingProfileReference": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#RoutingProfileId", + "traits": { + "smithy.api#documentation": "

The identifier of the routing profile.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the routing profile.

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

Information about the routing profile assigned to the user.

" + } + }, "com.amazonaws.connect#RoutingProfileSummary": { "type": "structure", "members": { @@ -13680,7 +14703,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.

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

Searches for vocabularies within a specific Amazon Connect instance using State,\n NameStartsWith, and LanguageCode.

", "smithy.api#http": { "method": "POST", "uri": "/vocabulary-summary/{InstanceId}", @@ -13917,6 +14940,15 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.connect#SingleSelectOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TaskTemplateSingleSelectOption" + } + }, + "com.amazonaws.connect#SnapshotVersion": { + "type": "string" + }, "com.amazonaws.connect#SourceApplicationName": { "type": "string", "traits": { @@ -13968,7 +15000,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates a contact flow to start a new chat for the customer. Response of this API provides\n a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n\n

When a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n\n

A 429 error occurs in the following situations:

\n
    \n
  • \n

    API rate limit is exceeded. API TPS throttling returns a TooManyRequests\n exception.

    \n
    • \n
  • \n

    The quota for concurrent active\n chats is exceeded. Active chat throttling returns a\n LimitExceededException.

    \n
    • \n
\n

If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may\n not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. \n

\n\n

For more information about chat, see Chat in the Amazon Connect Administrator\n Guide.

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

Initiates a contact flow to start a new chat for the customer. Response of this API provides\n a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

\n\n

When a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

\n\n

A 429 error occurs in the following situations:

\n
    \n
  • \n

    API rate limit is exceeded. API TPS throttling returns a TooManyRequests\n exception.

    \n
    • \n
  • \n

    The quota for concurrent active\n chats is exceeded. Active chat throttling returns a\n LimitExceededException.

    \n
    • \n
\n

If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.

\n\n

For more information about chat, see Chat in the Amazon Connect Administrator\n Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/contact/chat", @@ -14022,13 +15054,13 @@ "ChatDurationInMinutes": { "target": "com.amazonaws.connect#ChatDurationInMinutes", "traits": { - "smithy.api#documentation": "

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. \n The minumum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

" + "smithy.api#documentation": "

The total duration of the newly started chat session. If not specified, the chat session\n duration defaults to 25 hour. The minumum configurable time is 60 minutes. The maximum\n configurable time is 10,080 minutes (7 days).

" } }, "SupportedMessagingContentTypes": { "target": "com.amazonaws.connect#SupportedMessagingContentTypes", "traits": { - "smithy.api#documentation": "

The supported chat message content types. Content types can be text/plain or both text/plain and text/markdown.

" + "smithy.api#documentation": "

The supported chat message content types. Content types can be text/plain or both text/plain\n and text/markdown.

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

Starts recording the contact:

\n
    \n
  • \n

    If the API is called before the agent joins the call, recording starts when the agent joins the call.

    \n
    • \n
  • \n

    If the API is called after the agent joins the call, recording starts at the time of the API call.

    \n
    • \n
\n \n

StartContactRecording is a\n one-time action. For example, if you use StopContactRecording to stop recording an ongoing call,\n you can't use StartContactRecording to restart it. For scenarios where the recording has started\n and you want to suspend and resume it, such as when collecting sensitive information (for\n example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

\n

You can use this API to override the recording behavior configured in the Set recording\n behavior block.

\n

Only voice recordings are supported at this time.

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

Starts recording the contact:

\n
    \n
  • \n

    If the API is called before the agent joins the call, recording\n starts when the agent joins the call.

    \n
    • \n
  • \n

    If the API is called after the agent joins the call, recording starts\n at the time of the API call.

    \n
    • \n
\n\n

StartContactRecording is a one-time action. For example, if you use StopContactRecording to\n stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios\n where the recording has started and you want to suspend and resume it, such as when collecting\n sensitive information (for example, a credit card number), use SuspendContactRecording and\n ResumeContactRecording.

\n

You can use this API to override the recording behavior configured in the Set recording\n behavior block.

\n

Only voice recordings are supported at this time.

", "smithy.api#http": { "method": "POST", "uri": "/contact/start-recording", @@ -14380,8 +15412,7 @@ "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the\n Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On\n the contact flow page, under the name of the contact flow, choose Show\n additional flow information. The ContactFlowId is the last part of the ARN, shown\n here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

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

The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the\n Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On\n the contact flow page, under the name of the contact flow, choose Show\n additional flow information. The ContactFlowId is the last part of the ARN, shown\n here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

" } }, "Attributes": { @@ -14421,6 +15452,18 @@ "traits": { "smithy.api#documentation": "

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

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

A unique identifier for the task template.

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

The identifier for the quick connect.

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

Ends the specified contact. This call does not work for the following initiation methods:

\n
    \n
  • \n

    DISCONNECT

    \n
    • \n
  • \n

    TRANSFER

    \n
    • \n
  • \n

    QUEUE_TRANSFER

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

Ends the specified contact. This call does not work for the following initiation\n methods:

\n \n
    \n
  • \n

    DISCONNECT

    \n
    • \n
  • \n

    TRANSFER

    \n
    • \n
  • \n

    QUEUE_TRANSFER

    \n
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/contact/stop", @@ -14707,7 +15750,27 @@ } }, "traits": { - "smithy.api#documentation": "

A leaf node condition which can be used to specify a string condition, for example,\n username = 'abc'.

" + "smithy.api#documentation": "

A leaf node condition which can be used to specify a string condition, for example,\n username = 'abc'.

" + } + }, + "com.amazonaws.connect#StringReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the string reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid string.

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

Information about a reference when the referenceType is STRING.\n Otherwise, null.

" } }, "com.amazonaws.connect#SupportedMessagingContentType": { @@ -14806,7 +15869,7 @@ } }, "traits": { - "smithy.api#documentation": "

A leaf node condition which can be used to specify a tag condition, for example, HAVE\n BPO = 123.

" + "smithy.api#documentation": "

A leaf node condition which can be used to specify a tag condition, for example, HAVE\n BPO = 123.

" } }, "com.amazonaws.connect#TagKey": { @@ -14878,7 +15941,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, queues, quick connects, contact\n flows, agent status, hours of operation, and phone number.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

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

Adds the specified tags to the specified resource.

\n

The supported resource types are users, routing profiles, queues, quick connects, contact\n flows, agent status, hours of operation, phone number, security profiles, and task\n templates.

\n

For sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -14915,69 +15978,488 @@ } } }, - "com.amazonaws.connect#Threshold": { + "com.amazonaws.connect#TaskTemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.connect#TaskTemplateConstraints": { "type": "structure", "members": { - "Comparison": { - "target": "com.amazonaws.connect#Comparison", + "RequiredFields": { + "target": "com.amazonaws.connect#RequiredTaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Lists the fields that are required to be filled by agents.

" + } + }, + "ReadOnlyFields": { + "target": "com.amazonaws.connect#ReadOnlyTaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Lists the fields that are read-only to agents, and cannot be edited.

" + } + }, + "InvisibleFields": { + "target": "com.amazonaws.connect#InvisibleTaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Lists the fields that are invisible to agents.

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

Describes constraints that apply to the template fields.

" + } + }, + "com.amazonaws.connect#TaskTemplateDefaultFieldValue": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of a field.

" + } + }, + "DefaultValue": { + "target": "com.amazonaws.connect#TaskTemplateFieldValue", + "traits": { + "smithy.api#documentation": "

Default value for the field.

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

Describes a default field and its corresponding value.

" + } + }, + "com.amazonaws.connect#TaskTemplateDefaultFieldValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TaskTemplateDefaultFieldValue" + } + }, + "com.amazonaws.connect#TaskTemplateDefaults": { + "type": "structure", + "members": { + "DefaultFieldValues": { + "target": "com.amazonaws.connect#TaskTemplateDefaultFieldValueList", + "traits": { + "smithy.api#documentation": "

Default value for the field.

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

Describes default values for fields on a template.

" + } + }, + "com.amazonaws.connect#TaskTemplateDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.connect#TaskTemplateField": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateFieldIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for the field.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateFieldDescription", + "traits": { + "smithy.api#documentation": "

The description of the field.

" + } + }, + "Type": { + "target": "com.amazonaws.connect#TaskTemplateFieldType", + "traits": { + "smithy.api#documentation": "

Indicates the type of field.

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

A list of options for a single select field.

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

Describes a single task template field.

" + } + }, + "com.amazonaws.connect#TaskTemplateFieldDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.connect#TaskTemplateFieldIdentifier": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#TaskTemplateFieldName", + "traits": { + "smithy.api#documentation": "

The name of the task template field.

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

The identifier of the task template field.

" + } + }, + "com.amazonaws.connect#TaskTemplateFieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#TaskTemplateFieldType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NAME", + "name": "NAME" + }, + { + "value": "DESCRIPTION", + "name": "DESCRIPTION" + }, + { + "value": "SCHEDULED_TIME", + "name": "SCHEDULED_TIME" + }, + { + "value": "QUICK_CONNECT", + "name": "QUICK_CONNECT" + }, + { + "value": "URL", + "name": "URL" + }, + { + "value": "NUMBER", + "name": "NUMBER" + }, + { + "value": "TEXT", + "name": "TEXT" + }, + { + "value": "TEXT_AREA", + "name": "TEXT_AREA" + }, + { + "value": "DATE_TIME", + "name": "DATE_TIME" + }, + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "SINGLE_SELECT", + "name": "SINGLE_SELECT" + }, + { + "value": "EMAIL", + "name": "EMAIL" + } + ] + } + }, + "com.amazonaws.connect#TaskTemplateFieldValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.connect#TaskTemplateFields": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TaskTemplateField" + } + }, + "com.amazonaws.connect#TaskTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.connect#TaskTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TaskTemplateMetadata" + } + }, + "com.amazonaws.connect#TaskTemplateMetadata": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#TaskTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task template.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

" + } + }, + "Status": { + "target": "com.amazonaws.connect#TaskTemplateStatus", + "traits": { + "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was last modified.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was created.

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

Contains summary information about the task template.

" + } + }, + "com.amazonaws.connect#TaskTemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#TaskTemplateSingleSelectOption": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.connect#TaskTemplateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + } + ] + } + }, + "com.amazonaws.connect#Threshold": { + "type": "structure", + "members": { + "Comparison": { + "target": "com.amazonaws.connect#Comparison", + "traits": { + "smithy.api#documentation": "

The type of comparison. Only \"less than\" (LT) comparisons are supported.

" + } + }, + "ThresholdValue": { + "target": "com.amazonaws.connect#ThresholdValue", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The threshold value to compare.

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

Contains information about the threshold for service level metrics.

" + } + }, + "com.amazonaws.connect#ThresholdValue": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.connect#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ThrottlingException", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "

The throttling limit has been exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.connect#TimeZone": { + "type": "string" + }, + "com.amazonaws.connect#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.connect#TrafficType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GENERAL", + "name": "GENERAL" + }, + { + "value": "CAMPAIGN", + "name": "CAMPAIGN" + } + ] + } + }, + "com.amazonaws.connect#TransferContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#TransferContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#TransferContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Transfers contacts from one agent or queue to another agent or queue at any point after a\n contact is created. You can transfer a contact to another queue by providing the contact flow\n which orchestrates the contact to the destination queue. This gives you more control over contact\n handling and helps you adhere to the service level agreement (SLA) guaranteed to your\n customers.

\n

Note the following requirements:

\n
    \n
  • \n

    Transfer is supported for only TASK contacts.

    \n
    • \n
  • \n

    Do not use both QueueId and UserId in the same call.

    \n
    • \n
  • \n

    The following contact flow types are supported: Inbound contact flow, Transfer to agent\n flow, and Transfer to queue flow.

    \n
    • \n
  • \n

    The TransferContact API can be called only on active contacts.

    \n
    • \n
  • \n

    A contact cannot be transferred more than 11 times.

    \n
    • \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/transfer", + "code": 200 + } + } + }, + "com.amazonaws.connect#TransferContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact in this instance of Amazon Connect.

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

The identifier for the queue.

" + } + }, + "UserId": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "

The identifier for the user.

" + } + }, + "ContactFlowId": { + "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The type of comparison. Only \"less than\" (LT) comparisons are supported.

" + "smithy.api#documentation": "

The identifier of the contact flow.

", + "smithy.api#required": {} } }, - "ThresholdValue": { - "target": "com.amazonaws.connect#ThresholdValue", + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "

The threshold value to compare.

" + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

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

Contains information about the threshold for service level metrics.

" - } - }, - "com.amazonaws.connect#ThresholdValue": { - "type": "double", - "traits": { - "smithy.api#box": {} } }, - "com.amazonaws.connect#ThrottlingException": { + "com.amazonaws.connect#TransferContactResponse": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.connect#Message" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ThrottlingException", - "httpResponseCode": 429 + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

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

The throttling limit has been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.connect#TimeZone": { - "type": "string" - }, - "com.amazonaws.connect#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.connect#TrafficType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "GENERAL", - "name": "GENERAL" - }, - { - "value": "CAMPAIGN", - "name": "CAMPAIGN" + "ContactArn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact.

" } - ] + } } }, "com.amazonaws.connect#URI": { @@ -15656,7 +17138,7 @@ "References": { "target": "com.amazonaws.connect#ContactReferences", "traits": { - "smithy.api#documentation": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

" + "smithy.api#documentation": "

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

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

Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region.

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

Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance\n in the same Region.

", "smithy.api#http": { "method": "PUT", "uri": "/phone-number/{PhoneNumberId}", @@ -16817,6 +18299,183 @@ } } }, + "com.amazonaws.connect#UpdateTaskTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateTaskTemplateRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateTaskTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#PropertyValidationException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates details about a specific task template in the specified Amazon Connect instance. This\n operation does not support partial updates. Instead it does a full update of template\n content.

", + "smithy.api#http": { + "method": "POST", + "uri": "/instance/{InstanceId}/task/template/{TaskTemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateTaskTemplateRequest": { + "type": "structure", + "members": { + "TaskTemplateId": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the task template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

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

The identifier of the flow that runs by default when a task is created by referencing this template.

" + } + }, + "Constraints": { + "target": "com.amazonaws.connect#TaskTemplateConstraints", + "traits": { + "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" + } + }, + "Defaults": { + "target": "com.amazonaws.connect#TaskTemplateDefaults", + "traits": { + "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" + } + }, + "Status": { + "target": "com.amazonaws.connect#TaskTemplateStatus", + "traits": { + "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "Fields": { + "target": "com.amazonaws.connect#TaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Fields that are part of the template.

" + } + } + } + }, + "com.amazonaws.connect#UpdateTaskTemplateResponse": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#TaskTemplateId", + "traits": { + "smithy.api#documentation": "

The identifier of the task template resource.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#TaskTemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the task template resource.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#TaskTemplateName", + "traits": { + "smithy.api#documentation": "

The name of the task template.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#TaskTemplateDescription", + "traits": { + "smithy.api#documentation": "

The description of the task template.

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

The identifier of the flow that runs by default when a task is created by referencing this template.

" + } + }, + "Constraints": { + "target": "com.amazonaws.connect#TaskTemplateConstraints", + "traits": { + "smithy.api#documentation": "

Constraints that are applicable to the fields listed.

" + } + }, + "Defaults": { + "target": "com.amazonaws.connect#TaskTemplateDefaults", + "traits": { + "smithy.api#documentation": "

The default values for fields when a task is created by referencing this template.

" + } + }, + "Fields": { + "target": "com.amazonaws.connect#TaskTemplateFields", + "traits": { + "smithy.api#documentation": "

Fields that are part of the template.

" + } + }, + "Status": { + "target": "com.amazonaws.connect#TaskTemplateStatus", + "traits": { + "smithy.api#documentation": "

Marks a template as ACTIVE or INACTIVE for a task to refer to it. \nTasks can only be created from ACTIVE templates.\nIf a template is marked as INACTIVE, then a task that refers to this template cannot be created.

" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was last modified.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the task template was created.

" + } + } + } + }, "com.amazonaws.connect#UpdateUserHierarchy": { "type": "operation", "input": { @@ -17392,6 +19051,88 @@ "smithy.api#documentation": "

Contains information about a user account for a Amazon Connect instance.

" } }, + "com.amazonaws.connect#UserData": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.connect#UserReference", + "traits": { + "smithy.api#documentation": "

Information about the user for the data that is returned. It contains resourceId and ARN of\n the user.

" + } + }, + "RoutingProfile": { + "target": "com.amazonaws.connect#RoutingProfileReference", + "traits": { + "smithy.api#documentation": "

Information about the routing profile that is assigned to the user.

" + } + }, + "HierarchyPath": { + "target": "com.amazonaws.connect#HierarchyPathReference", + "traits": { + "smithy.api#documentation": "

Contains information about the levels of a hierarchy group assigned to a user.

" + } + }, + "Status": { + "target": "com.amazonaws.connect#AgentStatusReference", + "traits": { + "smithy.api#documentation": "

The status of the agent that they manually set in their Contact Control Panel (CCP), or that\n the supervisor manually changes in the real-time metrics report.

" + } + }, + "AvailableSlotsByChannel": { + "target": "com.amazonaws.connect#ChannelToCountMap", + "traits": { + "smithy.api#documentation": "

A map of available slots by channel. The key is a channel name. The value is an integer: the\n available number of slots.

" + } + }, + "MaxSlotsByChannel": { + "target": "com.amazonaws.connect#ChannelToCountMap", + "traits": { + "smithy.api#documentation": "

A map of maximum slots by channel. The key is a channel name. The value is an integer: the\n maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.

" + } + }, + "ActiveSlotsByChannel": { + "target": "com.amazonaws.connect#ChannelToCountMap", + "traits": { + "smithy.api#documentation": "

A map of active slots by channel. The key is a channel name. The value is an integer: the\n number of active slots.

" + } + }, + "Contacts": { + "target": "com.amazonaws.connect#AgentContactReferenceList", + "traits": { + "smithy.api#documentation": "

A list of contact reference information.

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

Data for a user.

" + } + }, + "com.amazonaws.connect#UserDataFilters": { + "type": "structure", + "members": { + "Queues": { + "target": "com.amazonaws.connect#Queues", + "traits": { + "smithy.api#documentation": "

Contains information about a queue resource for which metrics are returned.

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

A filter for the user data based on the contact information that is associated to the user. It\n contains a list of contact states.

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

A filter for the user data.

" + } + }, + "com.amazonaws.connect#UserDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserData" + } + }, "com.amazonaws.connect#UserId": { "type": "string" }, @@ -17509,6 +19250,26 @@ "smithy.api#documentation": "

Contains information about the quick connect configuration settings for a user. The contact\n flow must be of type Transfer to Agent.

" } }, + "com.amazonaws.connect#UserReference": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

" + } + }, + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user.

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

Information about the user.

" + } + }, "com.amazonaws.connect#UserSearchConditionList": { "type": "list", "member": { @@ -17521,13 +19282,13 @@ "OrConditions": { "target": "com.amazonaws.connect#UserSearchConditionList", "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR\n condition.

" } }, "AndConditions": { "target": "com.amazonaws.connect#UserSearchConditionList", "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.\n

" } }, "StringCondition": { diff --git a/aws/sdk/aws-models/connectcampaigns.json b/aws/sdk/aws-models/connectcampaigns.json new file mode 100644 index 000000000..4fec2d031 --- /dev/null +++ b/aws/sdk/aws-models/connectcampaigns.json @@ -0,0 +1,2419 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.connectcampaigns#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.connectcampaigns#AmazonConnectCampaignService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "ConnectCampaigns", + "arnNamespace": "connect-campaigns", + "cloudTrailEventSource": "connect-campaigns.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "connect-campaigns" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Provide APIs to create and manage Amazon Connect Campaigns.", + "smithy.api#title": "AmazonConnectCampaignService" + }, + "version": "2021-01-30", + "operations": [ + { + "target": "com.amazonaws.connectcampaigns#CreateCampaign" + }, + { + "target": "com.amazonaws.connectcampaigns#DeleteCampaign" + }, + { + "target": "com.amazonaws.connectcampaigns#DeleteConnectInstanceConfig" + }, + { + "target": "com.amazonaws.connectcampaigns#DeleteInstanceOnboardingJob" + }, + { + "target": "com.amazonaws.connectcampaigns#DescribeCampaign" + }, + { + "target": "com.amazonaws.connectcampaigns#GetCampaignState" + }, + { + "target": "com.amazonaws.connectcampaigns#GetCampaignStateBatch" + }, + { + "target": "com.amazonaws.connectcampaigns#GetConnectInstanceConfig" + }, + { + "target": "com.amazonaws.connectcampaigns#GetInstanceOnboardingJobStatus" + }, + { + "target": "com.amazonaws.connectcampaigns#ListCampaigns" + }, + { + "target": "com.amazonaws.connectcampaigns#ListTagsForResource" + }, + { + "target": "com.amazonaws.connectcampaigns#PauseCampaign" + }, + { + "target": "com.amazonaws.connectcampaigns#PutDialRequestBatch" + }, + { + "target": "com.amazonaws.connectcampaigns#ResumeCampaign" + }, + { + "target": "com.amazonaws.connectcampaigns#StartCampaign" + }, + { + "target": "com.amazonaws.connectcampaigns#StartInstanceOnboardingJob" + }, + { + "target": "com.amazonaws.connectcampaigns#StopCampaign" + }, + { + "target": "com.amazonaws.connectcampaigns#TagResource" + }, + { + "target": "com.amazonaws.connectcampaigns#UntagResource" + }, + { + "target": "com.amazonaws.connectcampaigns#UpdateCampaignDialerConfig" + }, + { + "target": "com.amazonaws.connectcampaigns#UpdateCampaignName" + }, + { + "target": "com.amazonaws.connectcampaigns#UpdateCampaignOutboundCallConfig" + } + ] + }, + "com.amazonaws.connectcampaigns#AnswerMachineDetectionConfig": { + "type": "structure", + "members": { + "enableAnswerMachineDetection": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Enable or disable answering machine detection", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Answering Machine Detection config" + } + }, + "com.amazonaws.connectcampaigns#Arn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Arn", + "smithy.api#length": { + "min": 20, + "max": 500 + }, + "smithy.api#pattern": "^arn:.*" + } + }, + "com.amazonaws.connectcampaigns#AttributeName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.", + "smithy.api#length": { + "min": 0, + "max": 32767 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-_]+$" + } + }, + "com.amazonaws.connectcampaigns#AttributeValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "The value of the attribute.", + "smithy.api#length": { + "min": 0, + "max": 32767 + } + } + }, + "com.amazonaws.connectcampaigns#Attributes": { + "type": "map", + "key": { + "target": "com.amazonaws.connectcampaigns#AttributeName" + }, + "value": { + "target": "com.amazonaws.connectcampaigns#AttributeValue" + }, + "traits": { + "smithy.api#documentation": "A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connectcampaigns#BandwidthAllocation": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The bandwidth allocation of a queue resource.", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.connectcampaigns#Campaign": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.connectcampaigns#CampaignArn", + "traits": { + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.connectcampaigns#CampaignName", + "traits": { + "smithy.api#required": {} + } + }, + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#required": {} + } + }, + "dialerConfig": { + "target": "com.amazonaws.connectcampaigns#DialerConfig", + "traits": { + "smithy.api#required": {} + } + }, + "outboundCallConfig": { + "target": "com.amazonaws.connectcampaigns#OutboundCallConfig", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.connectcampaigns#TagMap" + } + }, + "traits": { + "smithy.api#documentation": "An Amazon Connect campaign." + } + }, + "com.amazonaws.connectcampaigns#CampaignArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "The resource name of an Amazon Connect campaign.", + "smithy.api#length": { + "min": 20, + "max": 500 + } + } + }, + "com.amazonaws.connectcampaigns#CampaignFilters": { + "type": "structure", + "members": { + "instanceIdFilter": { + "target": "com.amazonaws.connectcampaigns#InstanceIdFilter" + } + }, + "traits": { + "smithy.api#documentation": "Filter model by type" + } + }, + "com.amazonaws.connectcampaigns#CampaignId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier representing a Campaign", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connectcampaigns#CampaignIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcampaigns#CampaignId" + }, + "traits": { + "smithy.api#documentation": "List of CampaignId" + } + }, + "com.amazonaws.connectcampaigns#CampaignName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of an Amazon Connect Campaign name.", + "smithy.api#length": { + "min": 1, + "max": 127 + } + } + }, + "com.amazonaws.connectcampaigns#CampaignState": { + "type": "string", + "traits": { + "smithy.api#documentation": "State of a campaign", + "smithy.api#enum": [ + { + "value": "Initialized", + "name": "INITIALIZED", + "documentation": "Campaign is in initialized state" + }, + { + "value": "Running", + "name": "RUNNING", + "documentation": "Campaign is in running state" + }, + { + "value": "Paused", + "name": "PAUSED", + "documentation": "Campaign is in paused state" + }, + { + "value": "Stopped", + "name": "STOPPED", + "documentation": "Campaign is in stopped state" + }, + { + "value": "Failed", + "name": "FAILED", + "documentation": "Campaign is in failed state" + } + ] + } + }, + "com.amazonaws.connectcampaigns#CampaignSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.connectcampaigns#CampaignArn", + "traits": { + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.connectcampaigns#CampaignName", + "traits": { + "smithy.api#required": {} + } + }, + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon Connect campaign summary." + } + }, + "com.amazonaws.connectcampaigns#CampaignSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcampaigns#CampaignSummary" + }, + "traits": { + "smithy.api#documentation": "A list of Amazon Connect campaigns." + } + }, + "com.amazonaws.connectcampaigns#ClientToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "Client provided parameter used for idempotency. Its value must be unique for each request.", + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.connectcampaigns#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "The request could not be processed because of conflict in the current state of the resource.", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.connectcampaigns#ContactFlowId": { + "type": "string", + "traits": { + "smithy.api#documentation": "The identifier of the contact flow for the outbound call.", + "smithy.api#length": { + "max": 500 + } + } + }, + "com.amazonaws.connectcampaigns#CreateCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#CreateCampaignRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#CreateCampaignResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a campaign for the specified Amazon Connect account. This API is idempotent.", + "smithy.api#http": { + "uri": "/campaigns", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#CreateCampaignRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.connectcampaigns#CampaignName", + "traits": { + "smithy.api#required": {} + } + }, + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#required": {} + } + }, + "dialerConfig": { + "target": "com.amazonaws.connectcampaigns#DialerConfig", + "traits": { + "smithy.api#required": {} + } + }, + "outboundCallConfig": { + "target": "com.amazonaws.connectcampaigns#OutboundCallConfig", + "traits": { + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.connectcampaigns#TagMap" + } + }, + "traits": { + "smithy.api#documentation": "The request for Create Campaign API." + } + }, + "com.amazonaws.connectcampaigns#CreateCampaignResponse": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId" + }, + "arn": { + "target": "com.amazonaws.connectcampaigns#CampaignArn" + }, + "tags": { + "target": "com.amazonaws.connectcampaigns#TagMap" + } + }, + "traits": { + "smithy.api#documentation": "The response for Create Campaign API" + } + }, + "com.amazonaws.connectcampaigns#DeleteCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#DeleteCampaignRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a campaign from the specified Amazon Connect account.", + "smithy.api#http": { + "uri": "/campaigns/{id}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#DeleteCampaignRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "DeleteCampaignRequest" + } + }, + "com.amazonaws.connectcampaigns#DeleteConnectInstanceConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#DeleteConnectInstanceConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#InvalidStateException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a connect instance config from the specified AWS account.", + "smithy.api#http": { + "uri": "/connect-instance/{connectInstanceId}/config", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#DeleteConnectInstanceConfigRequest": { + "type": "structure", + "members": { + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "DeleteCampaignRequest" + } + }, + "com.amazonaws.connectcampaigns#DeleteInstanceOnboardingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#DeleteInstanceOnboardingJobRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#InvalidStateException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.", + "smithy.api#http": { + "uri": "/connect-instance/{connectInstanceId}/onboarding", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#DeleteInstanceOnboardingJobRequest": { + "type": "structure", + "members": { + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request for DeleteInstanceOnboardingJob API." + } + }, + "com.amazonaws.connectcampaigns#DescribeCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#DescribeCampaignRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#DescribeCampaignResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the specific campaign.", + "smithy.api#http": { + "uri": "/campaigns/{id}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.connectcampaigns#DescribeCampaignRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "DescribeCampaignRequests" + } + }, + "com.amazonaws.connectcampaigns#DescribeCampaignResponse": { + "type": "structure", + "members": { + "campaign": { + "target": "com.amazonaws.connectcampaigns#Campaign" + } + }, + "traits": { + "smithy.api#documentation": "DescribeCampaignResponse" + } + }, + "com.amazonaws.connectcampaigns#DestinationPhoneNumber": { + "type": "string", + "traits": { + "smithy.api#documentation": "The phone number of the customer, in E.164 format.", + "smithy.api#length": { + "min": 0, + "max": 20 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.connectcampaigns#DialRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.connectcampaigns#ClientToken", + "traits": { + "smithy.api#required": {} + } + }, + "phoneNumber": { + "target": "com.amazonaws.connectcampaigns#DestinationPhoneNumber", + "traits": { + "smithy.api#required": {} + } + }, + "expirationTime": { + "target": "com.amazonaws.connectcampaigns#TimeStamp", + "traits": { + "smithy.api#required": {} + } + }, + "attributes": { + "target": "com.amazonaws.connectcampaigns#Attributes", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A dial request for a campaign." + } + }, + "com.amazonaws.connectcampaigns#DialRequestId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier representing a Dial request" + } + }, + "com.amazonaws.connectcampaigns#DialRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcampaigns#DialRequest" + }, + "traits": { + "smithy.api#documentation": "A list of dial requests.", + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.connectcampaigns#DialerConfig": { + "type": "union", + "members": { + "progressiveDialerConfig": { + "target": "com.amazonaws.connectcampaigns#ProgressiveDialerConfig" + }, + "predictiveDialerConfig": { + "target": "com.amazonaws.connectcampaigns#PredictiveDialerConfig" + } + }, + "traits": { + "smithy.api#documentation": "The possible types of dialer config parameters" + } + }, + "com.amazonaws.connectcampaigns#Enabled": { + "type": "boolean", + "traits": { + "smithy.api#documentation": "Boolean to indicate if custom encryption has been enabled." + } + }, + "com.amazonaws.connectcampaigns#EncryptionConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.connectcampaigns#Enabled", + "traits": { + "smithy.api#required": {} + } + }, + "encryptionType": { + "target": "com.amazonaws.connectcampaigns#EncryptionType" + }, + "keyArn": { + "target": "com.amazonaws.connectcampaigns#EncryptionKey" + } + }, + "traits": { + "smithy.api#documentation": "Encryption config for Connect Instance. Note that sensitive data will always be encrypted.\nIf disabled, service will perform encryption with its own key.\nIf enabled, a KMS key id needs to be provided and KMS charges will apply.\nKMS is only type supported" + } + }, + "com.amazonaws.connectcampaigns#EncryptionKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "KMS key id/arn for encryption config.", + "smithy.api#length": { + "max": 500 + } + } + }, + "com.amazonaws.connectcampaigns#EncryptionType": { + "type": "string", + "traits": { + "smithy.api#documentation": "Server-side encryption type.", + "smithy.api#enum": [ + { + "name": "KMS", + "value": "KMS" + } + ] + } + }, + "com.amazonaws.connectcampaigns#FailedCampaignStateResponse": { + "type": "structure", + "members": { + "campaignId": { + "target": "com.amazonaws.connectcampaigns#CampaignId" + }, + "failureCode": { + "target": "com.amazonaws.connectcampaigns#GetCampaignStateBatchFailureCode" + } + }, + "traits": { + "smithy.api#documentation": "Failed response of campaign state" + } + }, + "com.amazonaws.connectcampaigns#FailedCampaignStateResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcampaigns#FailedCampaignStateResponse" + }, + "traits": { + "smithy.api#documentation": "List of failed requests of campaign state", + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.connectcampaigns#FailedRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.connectcampaigns#ClientToken" + }, + "id": { + "target": "com.amazonaws.connectcampaigns#DialRequestId" + }, + "failureCode": { + "target": "com.amazonaws.connectcampaigns#FailureCode" + } + }, + "traits": { + "smithy.api#documentation": "A failed request identified by the unique client token." + } + }, + "com.amazonaws.connectcampaigns#FailedRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcampaigns#FailedRequest" + }, + "traits": { + "smithy.api#documentation": "A list of failed requests.", + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.connectcampaigns#FailureCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "A predefined code indicating the error that caused the failure.", + "smithy.api#enum": [ + { + "value": "InvalidInput", + "name": "INVALID_INPUT", + "documentation": "The request failed to satisfy the constraints specified by the service" + }, + { + "value": "RequestThrottled", + "name": "REQUEST_THROTTLED", + "documentation": "Request throttled due to large number of pending dial requests" + }, + { + "value": "UnknownError", + "name": "UNKNOWN_ERROR", + "documentation": "Unexpected error during processing of request" + } + ] + } + }, + "com.amazonaws.connectcampaigns#GetCampaignState": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#GetCampaignStateRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#GetCampaignStateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Get state of a campaign for the specified Amazon Connect account.", + "smithy.api#http": { + "uri": "/campaigns/{id}/state", + "method": "GET" + } + } + }, + "com.amazonaws.connectcampaigns#GetCampaignStateBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#GetCampaignStateBatchRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#GetCampaignStateBatchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get state of campaigns for the specified Amazon Connect account.", + "smithy.api#http": { + "uri": "/campaigns-state", + "method": "POST" + } + } + }, + "com.amazonaws.connectcampaigns#GetCampaignStateBatchFailureCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "A predefined code indicating the error that caused the failure in getting state of campaigns", + "smithy.api#enum": [ + { + "value": "ResourceNotFound", + "name": "RESOURCE_NOT_FOUND", + "documentation": "The specified resource was not found" + }, + { + "value": "UnknownError", + "name": "UNKNOWN_ERROR", + "documentation": "Unexpected error during processing of request" + } + ] + } + }, + "com.amazonaws.connectcampaigns#GetCampaignStateBatchRequest": { + "type": "structure", + "members": { + "campaignIds": { + "target": "com.amazonaws.connectcampaigns#CampaignIdList", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "GetCampaignStateBatchRequest" + } + }, + "com.amazonaws.connectcampaigns#GetCampaignStateBatchResponse": { + "type": "structure", + "members": { + "successfulRequests": { + "target": "com.amazonaws.connectcampaigns#SuccessfulCampaignStateResponseList" + }, + "failedRequests": { + "target": "com.amazonaws.connectcampaigns#FailedCampaignStateResponseList" + } + }, + "traits": { + "smithy.api#documentation": "GetCampaignStateBatchResponse" + } + }, + "com.amazonaws.connectcampaigns#GetCampaignStateRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "GetCampaignStateRequest" + } + }, + "com.amazonaws.connectcampaigns#GetCampaignStateResponse": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.connectcampaigns#CampaignState" + } + }, + "traits": { + "smithy.api#documentation": "GetCampaignStateResponse" + } + }, + "com.amazonaws.connectcampaigns#GetConnectInstanceConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#GetConnectInstanceConfigRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#GetConnectInstanceConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the specific Connect instance config.", + "smithy.api#http": { + "uri": "/connect-instance/{connectInstanceId}/config", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.connectcampaigns#GetConnectInstanceConfigRequest": { + "type": "structure", + "members": { + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "GetConnectInstanceConfigRequest" + } + }, + "com.amazonaws.connectcampaigns#GetConnectInstanceConfigResponse": { + "type": "structure", + "members": { + "connectInstanceConfig": { + "target": "com.amazonaws.connectcampaigns#InstanceConfig" + } + }, + "traits": { + "smithy.api#documentation": "GetConnectInstanceConfigResponse" + } + }, + "com.amazonaws.connectcampaigns#GetInstanceOnboardingJobStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#GetInstanceOnboardingJobStatusRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#GetInstanceOnboardingJobStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the specific instance onboarding job status.", + "smithy.api#http": { + "uri": "/connect-instance/{connectInstanceId}/onboarding", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.connectcampaigns#GetInstanceOnboardingJobStatusRequest": { + "type": "structure", + "members": { + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "GetInstanceOnboardingJobStatusRequest" + } + }, + "com.amazonaws.connectcampaigns#GetInstanceOnboardingJobStatusResponse": { + "type": "structure", + "members": { + "connectInstanceOnboardingJobStatus": { + "target": "com.amazonaws.connectcampaigns#InstanceOnboardingJobStatus" + } + }, + "traits": { + "smithy.api#documentation": "GetInstanceOnboardingJobStatusResponse" + } + }, + "com.amazonaws.connectcampaigns#InstanceConfig": { + "type": "structure", + "members": { + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#required": {} + } + }, + "serviceLinkedRoleArn": { + "target": "com.amazonaws.connectcampaigns#ServiceLinkedRoleArn", + "traits": { + "smithy.api#required": {} + } + }, + "encryptionConfig": { + "target": "com.amazonaws.connectcampaigns#EncryptionConfig", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Instance config object" + } + }, + "com.amazonaws.connectcampaigns#InstanceId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Amazon Connect Instance Id", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connectcampaigns#InstanceIdFilter": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#required": {} + } + }, + "operator": { + "target": "com.amazonaws.connectcampaigns#InstanceIdFilterOperator", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Connect instance identifier filter" + } + }, + "com.amazonaws.connectcampaigns#InstanceIdFilterOperator": { + "type": "string", + "traits": { + "smithy.api#documentation": "Operators for Connect instance identifier filter", + "smithy.api#enum": [ + { + "name": "EQ", + "value": "Eq", + "documentation": "Equals operator" + } + ] + } + }, + "com.amazonaws.connectcampaigns#InstanceOnboardingJobFailureCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "Enumeration of the possible failure codes for instance onboarding job", + "smithy.api#enum": [ + { + "value": "EVENT_BRIDGE_ACCESS_DENIED", + "name": "EVENT_BRIDGE_ACCESS_DENIED" + }, + { + "value": "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED", + "name": "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED" + }, + { + "value": "IAM_ACCESS_DENIED", + "name": "IAM_ACCESS_DENIED" + }, + { + "value": "KMS_ACCESS_DENIED", + "name": "KMS_ACCESS_DENIED" + }, + { + "value": "KMS_KEY_NOT_FOUND", + "name": "KMS_KEY_NOT_FOUND" + }, + { + "value": "INTERNAL_FAILURE", + "name": "INTERNAL_FAILURE" + } + ] + } + }, + "com.amazonaws.connectcampaigns#InstanceOnboardingJobStatus": { + "type": "structure", + "members": { + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.connectcampaigns#InstanceOnboardingJobStatusCode", + "traits": { + "smithy.api#required": {} + } + }, + "failureCode": { + "target": "com.amazonaws.connectcampaigns#InstanceOnboardingJobFailureCode" + } + }, + "traits": { + "smithy.api#documentation": "Instance onboarding job status object" + } + }, + "com.amazonaws.connectcampaigns#InstanceOnboardingJobStatusCode": { + "type": "string", + "traits": { + "smithy.api#documentation": "Enumeration of the possible states for instance onboarding job", + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.connectcampaigns#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "Request processing failed because of an error or failure with the service.", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.connectcampaigns#InvalidCampaignStateException": { + "type": "structure", + "members": { + "state": { + "target": "com.amazonaws.connectcampaigns#CampaignState", + "traits": { + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "The request could not be processed because of conflict in the current state of the campaign.", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.connectcampaigns#InvalidStateException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "The request could not be processed because of conflict in the current state.", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.connectcampaigns#ListCampaigns": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#ListCampaignsRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#ListCampaignsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides summary information about the campaigns under the specified Amazon Connect account.", + "smithy.api#http": { + "uri": "/campaigns-summary", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "campaignSummaryList" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.connectcampaigns#ListCampaignsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.connectcampaigns#MaxResults" + }, + "nextToken": { + "target": "com.amazonaws.connectcampaigns#NextToken" + }, + "filters": { + "target": "com.amazonaws.connectcampaigns#CampaignFilters" + } + }, + "traits": { + "smithy.api#documentation": "ListCampaignsRequest" + } + }, + "com.amazonaws.connectcampaigns#ListCampaignsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.connectcampaigns#NextToken" + }, + "campaignSummaryList": { + "target": "com.amazonaws.connectcampaigns#CampaignSummaryList" + } + }, + "traits": { + "smithy.api#documentation": "ListCampaignsResponse" + } + }, + "com.amazonaws.connectcampaigns#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List tags for a resource.", + "smithy.api#http": { + "uri": "/tags/{arn}", + "method": "GET" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.connectcampaigns#Arn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "ListTagsForResource" + } + }, + "com.amazonaws.connectcampaigns#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.connectcampaigns#TagMap" + } + }, + "traits": { + "smithy.api#documentation": "ListTagsForResponse" + } + }, + "com.amazonaws.connectcampaigns#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to return per page.", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.connectcampaigns#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "The token for the next set of results.", + "smithy.api#length": { + "max": 1000 + } + } + }, + "com.amazonaws.connectcampaigns#OutboundCallConfig": { + "type": "structure", + "members": { + "connectContactFlowId": { + "target": "com.amazonaws.connectcampaigns#ContactFlowId", + "traits": { + "smithy.api#required": {} + } + }, + "connectSourcePhoneNumber": { + "target": "com.amazonaws.connectcampaigns#SourcePhoneNumber" + }, + "connectQueueId": { + "target": "com.amazonaws.connectcampaigns#QueueId", + "traits": { + "smithy.api#required": {} + } + }, + "answerMachineDetectionConfig": { + "target": "com.amazonaws.connectcampaigns#AnswerMachineDetectionConfig" + } + }, + "traits": { + "smithy.api#documentation": "The configuration used for outbound calls." + } + }, + "com.amazonaws.connectcampaigns#PauseCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#PauseCampaignRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#InvalidCampaignStateException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Pauses a campaign for the specified Amazon Connect account.", + "smithy.api#http": { + "uri": "/campaigns/{id}/pause", + "method": "POST" + } + } + }, + "com.amazonaws.connectcampaigns#PauseCampaignRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "PauseCampaignRequest" + } + }, + "com.amazonaws.connectcampaigns#PredictiveDialerConfig": { + "type": "structure", + "members": { + "bandwidthAllocation": { + "target": "com.amazonaws.connectcampaigns#BandwidthAllocation", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Predictive Dialer config" + } + }, + "com.amazonaws.connectcampaigns#ProgressiveDialerConfig": { + "type": "structure", + "members": { + "bandwidthAllocation": { + "target": "com.amazonaws.connectcampaigns#BandwidthAllocation", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Progressive Dialer config" + } + }, + "com.amazonaws.connectcampaigns#PutDialRequestBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#PutDialRequestBatchRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#PutDialRequestBatchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#InvalidCampaignStateException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.", + "smithy.api#http": { + "uri": "/campaigns/{id}/dial-requests", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#PutDialRequestBatchRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dialRequests": { + "target": "com.amazonaws.connectcampaigns#DialRequestList", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "PutDialRequestBatchRequest" + } + }, + "com.amazonaws.connectcampaigns#PutDialRequestBatchResponse": { + "type": "structure", + "members": { + "successfulRequests": { + "target": "com.amazonaws.connectcampaigns#SuccessfulRequestList" + }, + "failedRequests": { + "target": "com.amazonaws.connectcampaigns#FailedRequestList" + } + }, + "traits": { + "smithy.api#documentation": "PutDialRequestBatchResponse" + } + }, + "com.amazonaws.connectcampaigns#QueueId": { + "type": "string", + "traits": { + "smithy.api#documentation": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.", + "smithy.api#length": { + "max": 500 + } + } + }, + "com.amazonaws.connectcampaigns#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource was not found.", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.connectcampaigns#ResumeCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#ResumeCampaignRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#InvalidCampaignStateException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a campaign for the specified Amazon Connect account.", + "smithy.api#http": { + "uri": "/campaigns/{id}/resume", + "method": "POST" + } + } + }, + "com.amazonaws.connectcampaigns#ResumeCampaignRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "ResumeCampaignRequest" + } + }, + "com.amazonaws.connectcampaigns#ServiceLinkedRoleArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "Service linked role arn", + "smithy.api#length": { + "max": 256 + } + } + }, + "com.amazonaws.connectcampaigns#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "Request would cause a service quota to be exceeded.", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.connectcampaigns#SourcePhoneNumber": { + "type": "string", + "traits": { + "smithy.api#documentation": "The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.", + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.connectcampaigns#StartCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#StartCampaignRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#InvalidCampaignStateException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a campaign for the specified Amazon Connect account.", + "smithy.api#http": { + "uri": "/campaigns/{id}/start", + "method": "POST" + } + } + }, + "com.amazonaws.connectcampaigns#StartCampaignRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "StartCampaignRequest" + } + }, + "com.amazonaws.connectcampaigns#StartInstanceOnboardingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#StartInstanceOnboardingJobRequest" + }, + "output": { + "target": "com.amazonaws.connectcampaigns#StartInstanceOnboardingJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Onboard the specific Amazon Connect instance to Connect Campaigns.", + "smithy.api#http": { + "uri": "/connect-instance/{connectInstanceId}/onboarding", + "method": "PUT" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#StartInstanceOnboardingJobRequest": { + "type": "structure", + "members": { + "connectInstanceId": { + "target": "com.amazonaws.connectcampaigns#InstanceId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "encryptionConfig": { + "target": "com.amazonaws.connectcampaigns#EncryptionConfig", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request for StartInstanceOnboardingJob API." + } + }, + "com.amazonaws.connectcampaigns#StartInstanceOnboardingJobResponse": { + "type": "structure", + "members": { + "connectInstanceOnboardingJobStatus": { + "target": "com.amazonaws.connectcampaigns#InstanceOnboardingJobStatus" + } + }, + "traits": { + "smithy.api#documentation": "The response for StartInstanceOnboardingJob API." + } + }, + "com.amazonaws.connectcampaigns#StopCampaign": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#StopCampaignRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#InvalidCampaignStateException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a campaign for the specified Amazon Connect account.", + "smithy.api#http": { + "uri": "/campaigns/{id}/stop", + "method": "POST" + } + } + }, + "com.amazonaws.connectcampaigns#StopCampaignRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "StopCampaignRequest" + } + }, + "com.amazonaws.connectcampaigns#SuccessfulCampaignStateResponse": { + "type": "structure", + "members": { + "campaignId": { + "target": "com.amazonaws.connectcampaigns#CampaignId" + }, + "state": { + "target": "com.amazonaws.connectcampaigns#CampaignState" + } + }, + "traits": { + "smithy.api#documentation": "Successful response of campaign state" + } + }, + "com.amazonaws.connectcampaigns#SuccessfulCampaignStateResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcampaigns#SuccessfulCampaignStateResponse" + }, + "traits": { + "smithy.api#documentation": "List of successful response of campaign state", + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.connectcampaigns#SuccessfulRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.connectcampaigns#ClientToken" + }, + "id": { + "target": "com.amazonaws.connectcampaigns#DialRequestId" + } + }, + "traits": { + "smithy.api#documentation": "A successful request identified by the unique client token." + } + }, + "com.amazonaws.connectcampaigns#SuccessfulRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcampaigns#SuccessfulRequest" + }, + "traits": { + "smithy.api#documentation": "A list of successful requests identified by the unique client token.", + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.connectcampaigns#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Tag key.", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.connectcampaigns#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.connectcampaigns#TagKey" + }, + "traits": { + "smithy.api#documentation": "List of tag keys.", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.connectcampaigns#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connectcampaigns#TagKey" + }, + "value": { + "target": "com.amazonaws.connectcampaigns#TagValue" + }, + "traits": { + "smithy.api#documentation": "Tag map with key and value." + } + }, + "com.amazonaws.connectcampaigns#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tag a resource.", + "smithy.api#http": { + "uri": "/tags/{arn}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#TagResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.connectcampaigns#Arn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.connectcampaigns#TagMap", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "TagResourceRequest" + } + }, + "com.amazonaws.connectcampaigns#TagValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Tag value.", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.connectcampaigns#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.connectcampaigns#TimeStamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "Timestamp with no UTC offset or timezone", + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.connectcampaigns#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Untag a resource.", + "smithy.api#http": { + "uri": "/tags/{arn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#UntagResourceRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.connectcampaigns#Arn", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.connectcampaigns#TagKeyList", + "traits": { + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "UntagResourceRequest" + } + }, + "com.amazonaws.connectcampaigns#UpdateCampaignDialerConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#UpdateCampaignDialerConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the dialer config of a campaign. This API is idempotent.", + "smithy.api#http": { + "uri": "/campaigns/{id}/dialer-config", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#UpdateCampaignDialerConfigRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dialerConfig": { + "target": "com.amazonaws.connectcampaigns#DialerConfig", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "UpdateCampaignDialerConfigRequest" + } + }, + "com.amazonaws.connectcampaigns#UpdateCampaignName": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#UpdateCampaignNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the name of a campaign. This API is idempotent.", + "smithy.api#http": { + "uri": "/campaigns/{id}/name", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#UpdateCampaignNameRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.connectcampaigns#CampaignName", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "UpdateCampaignNameRequest" + } + }, + "com.amazonaws.connectcampaigns#UpdateCampaignOutboundCallConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.connectcampaigns#UpdateCampaignOutboundCallConfigRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connectcampaigns#AccessDeniedException" + }, + { + "target": "com.amazonaws.connectcampaigns#ConflictException" + }, + { + "target": "com.amazonaws.connectcampaigns#InternalServerException" + }, + { + "target": "com.amazonaws.connectcampaigns#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connectcampaigns#ThrottlingException" + }, + { + "target": "com.amazonaws.connectcampaigns#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the outbound call config of a campaign. This API is idempotent.", + "smithy.api#http": { + "uri": "/campaigns/{id}/outbound-call-config", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connectcampaigns#UpdateCampaignOutboundCallConfigRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.connectcampaigns#CampaignId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "connectContactFlowId": { + "target": "com.amazonaws.connectcampaigns#ContactFlowId" + }, + "connectSourcePhoneNumber": { + "target": "com.amazonaws.connectcampaigns#SourcePhoneNumber" + }, + "answerMachineDetectionConfig": { + "target": "com.amazonaws.connectcampaigns#AnswerMachineDetectionConfig" + } + }, + "traits": { + "smithy.api#documentation": "UpdateCampaignOutboundCallConfigRequest" + } + }, + "com.amazonaws.connectcampaigns#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "xAmzErrorType": { + "target": "com.amazonaws.connectcampaigns#XAmazonErrorType", + "traits": { + "smithy.api#httpHeader": "x-amzn-ErrorType" + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.connectcampaigns#XAmazonErrorType": { + "type": "string", + "traits": { + "smithy.api#documentation": "A header that defines the error encountered while processing the request." + } + } + } +} diff --git a/aws/sdk/aws-models/dms.json b/aws/sdk/aws-models/dms.json index 520e693bc..d927806a0 100644 --- a/aws/sdk/aws-models/dms.json +++ b/aws/sdk/aws-models/dms.json @@ -162,6 +162,9 @@ { "target": "com.amazonaws.databasemigrationservice#CreateEventSubscription" }, + { + "target": "com.amazonaws.databasemigrationservice#CreateFleetAdvisorCollector" + }, { "target": "com.amazonaws.databasemigrationservice#CreateReplicationInstance" }, @@ -183,6 +186,12 @@ { "target": "com.amazonaws.databasemigrationservice#DeleteEventSubscription" }, + { + "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorCollector" + }, + { + "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabases" + }, { "target": "com.amazonaws.databasemigrationservice#DeleteReplicationInstance" }, @@ -225,6 +234,21 @@ { "target": "com.amazonaws.databasemigrationservice#DescribeEventSubscriptions" }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectors" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabases" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysis" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummary" + }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemas" + }, { "target": "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstances" }, @@ -297,6 +321,9 @@ { "target": "com.amazonaws.databasemigrationservice#RemoveTagsFromResource" }, + { + "target": "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysis" + }, { "target": "com.amazonaws.databasemigrationservice#StartReplicationTask" }, @@ -633,6 +660,178 @@ ] } }, + "com.amazonaws.databasemigrationservice#CollectorHealthCheck": { + "type": "structure", + "members": { + "CollectorStatus": { + "target": "com.amazonaws.databasemigrationservice#CollectorStatus", + "traits": { + "smithy.api#documentation": "

The status of the Fleet Advisor collector.

" + } + }, + "LocalCollectorS3Access": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether the local collector can access its Amazon S3 bucket.

" + } + }, + "WebCollectorS3Access": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether the web collector can access its Amazon S3 bucket.

" + } + }, + "WebCollectorGrantedRoleBasedAccess": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether the role that you provided when creating the Fleet Advisor collector has sufficient permissions\n to access the Fleet Advisor web collector.

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

Describes the last Fleet Advisor collector health check.

" + } + }, + "com.amazonaws.databasemigrationservice#CollectorNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The specified collector doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.databasemigrationservice#CollectorResponse": { + "type": "structure", + "members": { + "CollectorReferencedId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The reference ID of the Fleet Advisor collector.

" + } + }, + "CollectorName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of the Fleet Advisor collector .

" + } + }, + "CollectorVersion": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The version of your Fleet Advisor collector, in semantic versioning format, for example\n 1.0.2\n

" + } + }, + "VersionStatus": { + "target": "com.amazonaws.databasemigrationservice#VersionStatus", + "traits": { + "smithy.api#documentation": "

Whether the collector version is up to date.

" + } + }, + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

A summary description of the Fleet Advisor collector.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.

" + } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The IAM role that grants permissions to access the specified Amazon S3 bucket.

" + } + }, + "CollectorHealthCheck": { + "target": "com.amazonaws.databasemigrationservice#CollectorHealthCheck" + }, + "LastDataReceived": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The timestamp of the last time the collector received data, in the following format:\n 2022-01-24T19:04:02.596113Z\n

" + } + }, + "RegisteredDate": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The timestamp when DMS registered the collector, in the following format:\n 2022-01-24T19:04:02.596113Z\n

" + } + }, + "CreatedDate": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The timestamp when you created the collector, in the following format:\n 2022-01-24T19:04:02.596113Z\n

" + } + }, + "ModifiedDate": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The timestamp when DMS last modified the collector, in the following format:\n 2022-01-24T19:04:02.596113Z\n

" + } + }, + "InventoryData": { + "target": "com.amazonaws.databasemigrationservice#InventoryData" + } + }, + "traits": { + "smithy.api#documentation": "

Describes a Fleet Advisor collector.

" + } + }, + "com.amazonaws.databasemigrationservice#CollectorResponses": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#CollectorResponse" + } + }, + "com.amazonaws.databasemigrationservice#CollectorShortInfoResponse": { + "type": "structure", + "members": { + "CollectorReferencedId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The reference ID of the Fleet Advisor collector.

" + } + }, + "CollectorName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of the Fleet Advisor collector.

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

Briefly describes a Fleet Advisor collector.

" + } + }, + "com.amazonaws.databasemigrationservice#CollectorStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNREGISTERED", + "name": "UNREGISTERED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + } + ] + } + }, + "com.amazonaws.databasemigrationservice#CollectorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#CollectorShortInfoResponse" + } + }, "com.amazonaws.databasemigrationservice#CompressionTypeValue": { "type": "string", "traits": { @@ -787,7 +986,7 @@ "DatabaseName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

" + "smithy.api#documentation": "

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.\n To migrate to a specific database, use this setting and targetDbType.

" } }, "ExtraConnectionAttributes": { @@ -1069,6 +1268,102 @@ "smithy.api#documentation": "

" } }, + "com.amazonaws.databasemigrationservice#CreateFleetAdvisorCollector": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#CreateFleetAdvisorCollectorRequest" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#CreateFleetAdvisorCollectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3AccessDeniedFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#S3ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Fleet Advisor collector using the specified parameters.

" + } + }, + "com.amazonaws.databasemigrationservice#CreateFleetAdvisorCollectorRequest": { + "type": "structure", + "members": { + "CollectorName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of your Fleet Advisor collector (for example, sample-collector).

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

A summary description of your Fleet Advisor collector.

" + } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The IAM role that grants permissions to access the specified Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "S3BucketName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databasemigrationservice#CreateFleetAdvisorCollectorResponse": { + "type": "structure", + "members": { + "CollectorReferencedId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the new Fleet Advisor collector, for example:\n 22fda70c-40d5-4acf-b233-a495bd8eb7f5\n

" + } + }, + "CollectorName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of the new Fleet Advisor collector.

" + } + }, + "Description": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

A summary description of the Fleet Advisor collector.

" + } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The IAM role that grants permissions to access the specified Amazon S3 bucket.

" + } + }, + "S3BucketName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket that the collector uses to store inventory metadata.

" + } + } + } + }, "com.amazonaws.databasemigrationservice#CreateReplicationInstance": { "type": "operation", "input": { @@ -1461,46 +1756,184 @@ ] } }, - "com.amazonaws.databasemigrationservice#DatePartitionDelimiterValue": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SLASH", - "name": "SLASH" - }, - { - "value": "UNDERSCORE", - "name": "UNDERSCORE" - }, - { - "value": "DASH", - "name": "DASH" - }, - { - "value": "NONE", - "name": "NONE" + "com.amazonaws.databasemigrationservice#DatabaseInstanceSoftwareDetailsResponse": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The database engine of a database in a Fleet Advisor collector inventory, for example Microsoft\n SQL Server.

" } - ] - } - }, - "com.amazonaws.databasemigrationservice#DatePartitionSequenceValue": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "YYYYMMDD", - "name": "YYYYMMDD" - }, - { - "value": "YYYYMMDDHH", - "name": "YYYYMMDDHH" - }, - { - "value": "YYYYMM", - "name": "YYYYMM" - }, - { + }, + "EngineVersion": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The database engine version of a database in a Fleet Advisor collector inventory, for example\n 2019.

" + } + }, + "EngineEdition": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The database engine edition of a database in a Fleet Advisor collector inventory, for example\n Express.

" + } + }, + "ServicePack": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The service pack level of the database.

" + } + }, + "SupportLevel": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The support level of the database, for example Mainstream support.

" + } + }, + "OsArchitecture": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The operating system architecture of the database.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Information about the database engine software, for example Mainstream support\n ends on November 14th, 2024.

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

Describes an inventory database instance for a Fleet Advisor collector.

" + } + }, + "com.amazonaws.databasemigrationservice#DatabaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#DatabaseResponse" + } + }, + "com.amazonaws.databasemigrationservice#DatabaseResponse": { + "type": "structure", + "members": { + "DatabaseId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of a database in a Fleet Advisor collector inventory.

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

The name of a database in a Fleet Advisor collector inventory.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The IP address of a database in a Fleet Advisor collector inventory.

" + } + }, + "NumberOfSchemas": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "

The number of schemas in a Fleet Advisor collector inventory database.

" + } + }, + "Server": { + "target": "com.amazonaws.databasemigrationservice#ServerShortInfoResponse", + "traits": { + "smithy.api#documentation": "

The server name of a database in a Fleet Advisor collector inventory.

" + } + }, + "SoftwareDetails": { + "target": "com.amazonaws.databasemigrationservice#DatabaseInstanceSoftwareDetailsResponse", + "traits": { + "smithy.api#documentation": "

The software details of a database in a Fleet Advisor collector inventory, such as database engine and version.

" + } + }, + "Collectors": { + "target": "com.amazonaws.databasemigrationservice#CollectorsList", + "traits": { + "smithy.api#documentation": "

A list of collectors associated with the database.

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

Describes a database in a Fleet Advisor collector inventory.

" + } + }, + "com.amazonaws.databasemigrationservice#DatabaseShortInfoResponse": { + "type": "structure", + "members": { + "DatabaseId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of a database in a Fleet Advisor collector inventory.

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

The name of a database in a Fleet Advisor collector inventory.

" + } + }, + "DatabaseIpAddress": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The IP address of a database in a Fleet Advisor collector inventory.

" + } + }, + "DatabaseEngine": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The database engine of a database in a Fleet Advisor collector inventory, for example\n PostgreSQL.

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

Describes a database in a Fleet Advisor collector inventory.

" + } + }, + "com.amazonaws.databasemigrationservice#DatePartitionDelimiterValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SLASH", + "name": "SLASH" + }, + { + "value": "UNDERSCORE", + "name": "UNDERSCORE" + }, + { + "value": "DASH", + "name": "DASH" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, + "com.amazonaws.databasemigrationservice#DatePartitionSequenceValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "YYYYMMDD", + "name": "YYYYMMDD" + }, + { + "value": "YYYYMMDDHH", + "name": "YYYYMMDDHH" + }, + { + "value": "YYYYMM", + "name": "YYYYMM" + }, + { "value": "MMYYYYDD", "name": "MMYYYYDD" }, @@ -1554,6 +1987,18 @@ } } }, + "com.amazonaws.databasemigrationservice#DeleteCollectorRequest": { + "type": "structure", + "members": { + "CollectorReferencedId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The reference ID of the Fleet Advisor collector to delete.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.databasemigrationservice#DeleteConnection": { "type": "operation", "input": { @@ -1711,6 +2156,69 @@ "smithy.api#documentation": "

" } }, + "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorCollector": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteCollectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#CollectorNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified Fleet Advisor collector.

" + } + }, + "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesRequest" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidOperationFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified Fleet Advisor collector databases.

" + } + }, + "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesRequest": { + "type": "structure", + "members": { + "DatabaseIds": { + "target": "com.amazonaws.databasemigrationservice#StringList", + "traits": { + "smithy.api#documentation": "

The IDs of the Fleet Advisor collector databases to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesResponse": { + "type": "structure", + "members": { + "DatabaseIds": { + "target": "com.amazonaws.databasemigrationservice#StringList", + "traits": { + "smithy.api#documentation": "

The IDs of the databases that the operation deleted.

" + } + } + } + }, "com.amazonaws.databasemigrationservice#DeleteReplicationInstance": { "type": "operation", "input": { @@ -2588,56 +3096,360 @@ "Duration": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The duration of the events to be listed.

" + "smithy.api#documentation": "

The duration of the events to be listed.

" + } + }, + "EventCategories": { + "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "traits": { + "smithy.api#documentation": "

A list of event categories for the source type that you've chosen.

" + } + }, + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to events. The only valid filter is replication-instance-id.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

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

" + } + }, + "com.amazonaws.databasemigrationservice#DescribeEventsResponse": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + } + }, + "Events": { + "target": "com.amazonaws.databasemigrationservice#EventList", + "traits": { + "smithy.api#documentation": "

The events described.

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

" + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsRequest" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the Fleet Advisor collectors in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

If you specify any of the following filters, the output includes information for only\n those collectors that meet the filter criteria:

\n \n
    \n
  • \n

    \n collector-referenced-id – The ID of the collector agent, for example\n d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.

    \n
    • \n
  • \n

    \n collector-name – The name of the collector agent.

    \n
    • \n
\n \n

An example is: describe-fleet-advisor-collectors --filter\n Name=\"collector-referenced-id\",Values=\"d4610ac5-e323-4ad9-bc50-eaf7249dfe9d\"\n

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of records returned in the response.

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

If NextToken is returned by a previous response, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorCollectorsResponse": { + "type": "structure", + "members": { + "Collectors": { + "target": "com.amazonaws.databasemigrationservice#CollectorResponses", + "traits": { + "smithy.api#documentation": "

Provides descriptions of the Fleet Advisor collectors, including the collectors' name\n and ID, and the latest inventory data.

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

If NextToken is returned, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabases": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabasesRequest" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Fleet Advisor databases in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabasesRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

If you specify any of the following filters, the output includes information for only\n those databases that meet the filter criteria:

\n \n
    \n
  • \n

    \n database-id – The ID of the database, for example\n d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.

    \n
    • \n
  • \n

    \n database-name – The name of the database.

    \n
    • \n
  • \n

    \n database-engine – The name of the database engine.

    \n
    • \n
  • \n

    \n server-ip-address – The IP address of the database server.

    \n
    • \n
  • \n

    \n database-ip-address – The IP address of the database.

    \n
    • \n
  • \n

    \n collector-name – The name of the associated Fleet Advisor collector.

    \n
    • \n
\n \n

An example is: describe-fleet-advisor-databases --filter\n Name=\"database-id\",Values=\"d4610ac5-e323-4ad9-bc50-eaf7249dfe9d\"\n

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of records returned in the response.

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

If NextToken is returned by a previous response, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorDatabasesResponse": { + "type": "structure", + "members": { + "Databases": { + "target": "com.amazonaws.databasemigrationservice#DatabaseList", + "traits": { + "smithy.api#documentation": "

Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.

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

If NextToken is returned, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Provides descriptions of large-scale assessment (LSA) analyses produced by your\n Fleet Advisor collectors.\n

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysisRequest": { + "type": "structure", + "members": { + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of records returned in the response.

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

If NextToken is returned by a previous response, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorLsaAnalysisResponse": { + "type": "structure", + "members": { + "Analysis": { + "target": "com.amazonaws.databasemigrationservice#FleetAdvisorLsaAnalysisResponseList", + "traits": { + "smithy.api#documentation": "

A list of FleetAdvisorLsaAnalysisResponse objects.

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

If NextToken is returned, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummaryRequest" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummaryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Provides descriptions of the schemas discovered by your Fleet Advisor\n collectors.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummaryRequest": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

If you specify any of the following filters, the output includes information for only\n those schema objects that meet the filter criteria:

\n \n
    \n
  • \n

    \n schema-id – The ID of the schema, for example\n d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.

    \n
    • \n
\n \n

Example: describe-fleet-advisor-schema-object-summary --filter Name=\"schema-id\",Values=\"50\"\n

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of records returned in the response.

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

If NextToken is returned by a previous response, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemaObjectSummaryResponse": { + "type": "structure", + "members": { + "FleetAdvisorSchemaObjects": { + "target": "com.amazonaws.databasemigrationservice#FleetAdvisorSchemaObjectList", + "traits": { + "smithy.api#documentation": "

A collection of FleetAdvisorSchemaObjectResponse objects.

" } }, - "EventCategories": { - "target": "com.amazonaws.databasemigrationservice#EventCategoriesList", + "NextToken": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A list of event categories for the source type that you've chosen.

" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

" } - }, + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemas": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemasRequest" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of schemas detected by Fleet Advisor Collectors in your account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemasRequest": { + "type": "structure", + "members": { "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Filters applied to events. The only valid filter is replication-instance-id.

" + "smithy.api#documentation": "

If you specify any of the following filters, the output includes information for only\n those schemas that meet the filter criteria:

\n \n
    \n
  • \n

    \n complexity – The schema's complexity, for example\n Simple.

    \n
    • \n
  • \n

    \n database-id – The ID of the schema's database.

    \n
    • \n
  • \n

    \n database-ip-address – The IP address of the schema's database.

    \n
    • \n
  • \n

    \n database-name – The name of the schema's database.

    \n
    • \n
  • \n

    \n database-engine – The name of the schema database's engine.

    \n
    • \n
  • \n

    \n original-schema-name – The name of the schema's database's main schema.

    \n
    • \n
  • \n

    \n schema-id – The ID of the schema, for example 15.

    \n
    • \n
  • \n

    \n schema-name – The name of the schema.

    \n
    • \n
  • \n

    \n server-ip-address – The IP address of the schema database's server.

    \n
    • \n
\n \n

An example is: describe-fleet-advisor-schemas --filter\n Name=\"schema-id\",Values=\"50\"\n

" } }, "MaxRecords": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than\n the specified MaxRecords value, a pagination token called a marker is included\n in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: Minimum 20, maximum 100.

" + "smithy.api#documentation": "

Sets the maximum number of records returned in the response.

" } }, - "Marker": { + "NextToken": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + "smithy.api#documentation": "

If NextToken is returned by a previous response, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

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

" } }, - "com.amazonaws.databasemigrationservice#DescribeEventsResponse": { + "com.amazonaws.databasemigrationservice#DescribeFleetAdvisorSchemasResponse": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.databasemigrationservice#String", + "FleetAdvisorSchemas": { + "target": "com.amazonaws.databasemigrationservice#FleetAdvisorSchemaList", "traits": { - "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified\n by MaxRecords.

" + "smithy.api#documentation": "

A collection of SchemaResponse objects.

" } }, - "Events": { - "target": "com.amazonaws.databasemigrationservice#EventList", + "NextToken": { + "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The events described.

" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of \n NextToken is a unique pagination token for each page. Make the call again using the returned \n token to retrieve the next page. Keep all other arguments unchanged.

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

" } }, "com.amazonaws.databasemigrationservice#DescribeOrderableReplicationInstances": { @@ -4007,6 +4819,12 @@ "smithy.api#documentation": "

Provides information that defines a DocumentDB endpoint.

" } }, + "com.amazonaws.databasemigrationservice#DoubleOptional": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.databasemigrationservice#DynamoDbSettings": { "type": "structure", "members": { @@ -4616,13 +5434,89 @@ } } }, + "com.amazonaws.databasemigrationservice#FleetAdvisorLsaAnalysisResponse": { + "type": "structure", + "members": { + "LsaAnalysisId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of an LSA analysis run by a Fleet Advisor collector.

" + } + }, + "Status": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The status of an LSA analysis run by a Fleet Advisor collector.

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

Describes a large-scale assessment (LSA) analysis run by a Fleet Advisor collector.

" + } + }, + "com.amazonaws.databasemigrationservice#FleetAdvisorLsaAnalysisResponseList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#FleetAdvisorLsaAnalysisResponse" + } + }, + "com.amazonaws.databasemigrationservice#FleetAdvisorSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#SchemaResponse" + } + }, + "com.amazonaws.databasemigrationservice#FleetAdvisorSchemaObjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#FleetAdvisorSchemaObjectResponse" + } + }, + "com.amazonaws.databasemigrationservice#FleetAdvisorSchemaObjectResponse": { + "type": "structure", + "members": { + "SchemaId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of a schema object in a Fleet Advisor collector inventory.

" + } + }, + "ObjectType": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The type of the schema object, as reported by the database engine. Examples include the following:

\n
    \n
  • \n

    \n function\n

    \n
    • \n
  • \n

    \n trigger\n

    \n
    • \n
  • \n

    \n SYSTEM_TABLE\n

    \n
    • \n
  • \n

    \n QUEUE\n

    \n
    • \n
" + } + }, + "NumberOfObjects": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "

The number of objects in a schema object in a Fleet Advisor collector inventory.

" + } + }, + "CodeLineCount": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "

The number of lines of code in a schema object in a Fleet Advisor collector inventory.

" + } + }, + "CodeSize": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "

The size level of the code in a schema object in a Fleet Advisor collector inventory.

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

Describes a schema object in a Fleet Advisor collector inventory.

" + } + }, "com.amazonaws.databasemigrationservice#GcpMySQLSettings": { "type": "structure", "members": { "AfterConnectScript": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Specifies a script to run immediately after DMS connects to the endpoint. \n The migration task continues running regardless if the SQL statement succeeds or fails.

\n \n

For this parameter, provide the code of the script itself, not the name of a file containing the script.

" + "smithy.api#documentation": "

Specifies a script to run immediately after DMS connects to the endpoint. \n The migration task continues running regardless if the SQL statement succeeds or fails.

\n \n

For this parameter, provide the code of the script itself, not the name of a file containing the script.

" } }, "CleanSourceMetadataOnMismatch": { @@ -4658,7 +5552,7 @@ "ParallelLoadThreads": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Improves performance when loading data into the MySQL-compatible target database. Specifies how many \n threads to use to load the data into the MySQL-compatible target database. Setting a large number of \n threads can have an adverse effect on database performance, because a separate connection is required \n for each thread. The default is one.

\n \n

Example: parallelLoadThreads=1 \n

" + "smithy.api#documentation": "

Improves performance when loading data into the MySQL-compatible target database. Specifies how many \n threads to use to load the data into the MySQL-compatible target database. Setting a large number of \n threads can have an adverse effect on database performance, because a separate connection is required \n for each thread. The default is one.

\n \n

Example: parallelLoadThreads=1 \n

" } }, "Password": { @@ -4682,7 +5576,7 @@ "ServerTimezone": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Specifies the time zone for the source MySQL database.

\n \n

Example: serverTimezone=US/Pacific;\n

\n \n

Note: Do not enclose time zones in single quotes.

" + "smithy.api#documentation": "

Specifies the time zone for the source MySQL database.

\n \n

Example: serverTimezone=US/Pacific;\n

\n \n

Note: Do not enclose time zones in single quotes.

" } }, "Username": { @@ -4694,7 +5588,7 @@ "SecretsManagerAccessRoleArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS\n as the trusted entity and grants the required permissions to access the value in \n SecretsManagerSecret. The role must allow the iam:PassRole action. \n SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret \n that allows access to the MySQL endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify \n the values for this setting and SecretsManagerSecretId. Or you can specify clear-text\n values for UserName, Password, ServerName, and Port.\n You can't specify both. For more information on creating this SecretsManagerSecret \n and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to \n access it, see Using secrets to access Database Migration Service resources in the \n Database Migration Service User Guide.\n \n

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

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS\n as the trusted entity and grants the required permissions to access the value in \n SecretsManagerSecret. The role must allow the iam:PassRole action. \n SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret \n that allows access to the MySQL endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify \n the values for this setting and SecretsManagerSecretId. Or you can specify clear-text\n values for UserName, Password, ServerName, and Port.\n You can't specify both. For more information on creating this SecretsManagerSecret \n and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to \n access it, see Using secrets to access Database Migration Service resources in the \n Database Migration Service User Guide.\n \n

\n " } }, "SecretsManagerSecretId": { @@ -4894,6 +5788,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.databasemigrationservice#InvalidOperationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The action or operation requested isn't valid.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.databasemigrationservice#InvalidResourceStateFault": { "type": "structure", "members": { @@ -4924,6 +5830,26 @@ "smithy.api#error": "client" } }, + "com.amazonaws.databasemigrationservice#InventoryData": { + "type": "structure", + "members": { + "NumberOfDatabases": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of databases in the Fleet Advisor collector inventory.

" + } + }, + "NumberOfSchemas": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of schemas in the Fleet Advisor collector inventory.

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

Describes a Fleet Advisor collector inventory.

" + } + }, "com.amazonaws.databasemigrationservice#KMSAccessDeniedFault": { "type": "structure", "members": { @@ -5278,6 +6204,12 @@ "com.amazonaws.databasemigrationservice#Long": { "type": "long" }, + "com.amazonaws.databasemigrationservice#LongOptional": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.databasemigrationservice#MessageFormatValue": { "type": "string", "traits": { @@ -6233,7 +7165,7 @@ "TargetDbType": { "target": "com.amazonaws.databasemigrationservice#TargetDbType", "traits": { - "smithy.api#documentation": "

Specifies where to migrate source tables on the target, either\n to a single database or multiple databases.

\n

Example: targetDbType=MULTIPLE_DATABASES\n

" + "smithy.api#documentation": "

Specifies where to migrate source tables on the target, either\n to a single database or multiple databases. If you specify\n SPECIFIC_DATABASE, specify the database name using the DatabaseName\n parameter of the Endpoint object.

\n

Example: targetDbType=MULTIPLE_DATABASES\n

" } }, "MaxFileSize": { @@ -8249,6 +9181,43 @@ "smithy.api#error": "client" } }, + "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysis": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.

" + } + }, + "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysisResponse": { + "type": "structure", + "members": { + "LsaAnalysisId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of the LSA analysis run.

" + } + }, + "Status": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The status of the LSA analysis, for example COMPLETED.

" + } + } + } + }, "com.amazonaws.databasemigrationservice#S3AccessDeniedFault": { "type": "structure", "members": { @@ -8447,7 +9416,7 @@ "UseTaskStartTimeForFullLoadTimestamp": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

When set to true, this parameter uses the task start time as the timestamp column value instead of \n the time data is written to target. For full load, when useTaskStartTimeForFullLoadTimestamp\n is set to true, each row of the timestamp column contains the task start time. For CDC loads, \n each row of the timestamp column contains the transaction commit time.

\n \n

When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp \n in the timestamp column increments with the time data arrives at the target.

" + "smithy.api#documentation": "

When set to true, this parameter uses the task start time as the timestamp column value instead of \n the time data is written to target. For full load, when useTaskStartTimeForFullLoadTimestamp\n is set to true, each row of the timestamp column contains the task start time. For CDC loads, \n each row of the timestamp column contains the transaction commit time.

\n \n

When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp \n in the timestamp column increments with the time data arrives at the target.

" } }, "CannedAclForObjects": { @@ -8501,7 +9470,7 @@ "DatePartitionTimezone": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

When creating an S3 target endpoint, set DatePartitionTimezone to convert\n the current UTC time into a specified time zone. The conversion occurs when a date\n partition folder is created and a CDC filename is generated. The time zone format is Area/Location.\n Use this parameter when DatePartitionedEnabled is set to true, as shown in the\n following example.

\n

\n s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n \"DatePartitionDelimiter\": \"SLASH\",\n \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n \"dms-nattarat-test\"}'\n

" + "smithy.api#documentation": "

When creating an S3 target endpoint, set DatePartitionTimezone to convert\n the current UTC time into a specified time zone. The conversion occurs when a date\n partition folder is created and a CDC filename is generated. The time zone format is Area/Location.\n Use this parameter when DatePartitionedEnabled is set to true, as shown in the\n following example.

\n

\n s3-settings='{\"DatePartitionEnabled\": true, \"DatePartitionSequence\": \"YYYYMMDDHH\",\n \"DatePartitionDelimiter\": \"SLASH\",\n \"DatePartitionTimezone\":\"Asia/Seoul\", \"BucketName\":\n \"dms-nattarat-test\"}'\n

" } } }, @@ -8564,12 +9533,135 @@ "target": "com.amazonaws.databasemigrationservice#String" } }, + "com.amazonaws.databasemigrationservice#SchemaResponse": { + "type": "structure", + "members": { + "CodeLineCount": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "

The number of lines of code in a schema in a Fleet Advisor collector inventory.

" + } + }, + "CodeSize": { + "target": "com.amazonaws.databasemigrationservice#LongOptional", + "traits": { + "smithy.api#documentation": "

The size level of the code in a schema in a Fleet Advisor collector inventory.

" + } + }, + "Complexity": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The complexity level of the code in a schema in a Fleet Advisor collector inventory.

" + } + }, + "Server": { + "target": "com.amazonaws.databasemigrationservice#ServerShortInfoResponse", + "traits": { + "smithy.api#documentation": "

The database server for a schema in a Fleet Advisor collector inventory.

" + } + }, + "DatabaseInstance": { + "target": "com.amazonaws.databasemigrationservice#DatabaseShortInfoResponse", + "traits": { + "smithy.api#documentation": "

The database for a schema in a Fleet Advisor collector inventory.

" + } + }, + "SchemaId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of a schema in a Fleet Advisor collector inventory.

" + } + }, + "SchemaName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of a schema in a Fleet Advisor collector inventory.

" + } + }, + "OriginalSchema": { + "target": "com.amazonaws.databasemigrationservice#SchemaShortInfoResponse" + }, + "Similarity": { + "target": "com.amazonaws.databasemigrationservice#DoubleOptional", + "traits": { + "smithy.api#documentation": "

The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value\n indicates that a schema is likely to be a duplicate.

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

Describes a schema in a Fleet Advisor collector inventory.

" + } + }, + "com.amazonaws.databasemigrationservice#SchemaShortInfoResponse": { + "type": "structure", + "members": { + "SchemaId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of a schema in a Fleet Advisor collector inventory.

" + } + }, + "SchemaName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of a schema in a Fleet Advisor collector inventory.

" + } + }, + "DatabaseId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of a database in a Fleet Advisor collector inventory.

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

The name of a database in a Fleet Advisor collector inventory.

" + } + }, + "DatabaseIpAddress": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The IP address of a database in a Fleet Advisor collector inventory.

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

Describes a schema in a Fleet Advisor collector inventory.

" + } + }, "com.amazonaws.databasemigrationservice#SecretString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, + "com.amazonaws.databasemigrationservice#ServerShortInfoResponse": { + "type": "structure", + "members": { + "ServerId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The ID of a server in a Fleet Advisor collector inventory.

" + } + }, + "IpAddress": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The IP address of a server in a Fleet Advisor collector inventory.

" + } + }, + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name address of a server in a Fleet Advisor collector inventory.

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

Describes a server in a Fleet Advisor collector inventory.

" + } + }, "com.amazonaws.databasemigrationservice#SourceIdsList": { "type": "list", "member": { @@ -8947,6 +10039,12 @@ "com.amazonaws.databasemigrationservice#String": { "type": "string" }, + "com.amazonaws.databasemigrationservice#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String" + } + }, "com.amazonaws.databasemigrationservice#Subnet": { "type": "structure", "members": { @@ -9392,6 +10490,25 @@ "smithy.api#error": "client" } }, + "com.amazonaws.databasemigrationservice#VersionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UP_TO_DATE", + "name": "UP_TO_DATE" + }, + { + "value": "OUTDATED", + "name": "OUTDATED" + }, + { + "value": "UNSUPPORTED", + "name": "UNSUPPORTED" + } + ] + } + }, "com.amazonaws.databasemigrationservice#VpcSecurityGroupIdList": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/drs.json b/aws/sdk/aws-models/drs.json index e255b87ad..9053d48fa 100644 --- a/aws/sdk/aws-models/drs.json +++ b/aws/sdk/aws-models/drs.json @@ -22,11 +22,25 @@ } }, "traits": { - "smithy.api#documentation": "

TYou do not have sufficient access to perform this action.

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

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, + "com.amazonaws.drs#Account": { + "type": "structure", + "members": { + "accountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

Account ID of AWS account.

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

AWS account.

" + } + }, "com.amazonaws.drs#AccountID": { "type": "string", "traits": { @@ -37,6 +51,18 @@ "smithy.api#pattern": "[0-9]{12,}" } }, + "com.amazonaws.drs#AccountIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#AccountID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, "com.amazonaws.drs#AccountResource": { "type": "resource", "identifiers": { @@ -48,6 +74,18 @@ "aws.iam#disableConditionKeyInference": {} } }, + "com.amazonaws.drs#Accounts": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#Account" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.drs#BoundedString": { "type": "string", "traits": { @@ -105,6 +143,53 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.drs#ConversionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#ebsSnapshot" + }, + "value": { + "target": "com.amazonaws.drs#ebsSnapshot" + } + }, + "com.amazonaws.drs#ConversionProperties": { + "type": "structure", + "members": { + "volumeToConversionMap": { + "target": "com.amazonaws.drs#VolumeToConversionMap", + "traits": { + "smithy.api#documentation": "

A mapping between the volumes being converted and the converted snapshot ids

" + } + }, + "rootVolumeName": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The root volume name of a conversion job

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

Whether the volume being converted uses UEFI or not

" + } + }, + "dataTimestamp": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "

The timestamp of when the snapshot being converted was taken

" + } + }, + "volumeToVolumeSize": { + "target": "com.amazonaws.drs#VolumeToSizeMap", + "traits": { + "smithy.api#documentation": "

A mapping between the volumes and their sizes

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

Properties of a conversion job

" + } + }, "com.amazonaws.drs#Cpus": { "type": "list", "member": { @@ -117,6 +202,75 @@ } } }, + "com.amazonaws.drs#CreateExtendedSourceServer": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#CreateExtendedSourceServerRequest" + }, + "output": { + "target": "com.amazonaws.drs#CreateExtendedSourceServerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create an extended source server in the target Account based on the source server in staging account.

", + "smithy.api#http": { + "uri": "/CreateExtendedSourceServer", + "method": "POST", + "code": 201 + } + } + }, + "com.amazonaws.drs#CreateExtendedSourceServerRequest": { + "type": "structure", + "members": { + "sourceServerArn": { + "target": "com.amazonaws.drs#SourceServerARN", + "traits": { + "smithy.api#documentation": "

This defines the ARN of the source server in staging Account based on which you want to create an extended source server.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the extended source server.

" + } + } + } + }, + "com.amazonaws.drs#CreateExtendedSourceServerResponse": { + "type": "structure", + "members": { + "sourceServer": { + "target": "com.amazonaws.drs#SourceServer", + "traits": { + "smithy.api#documentation": "

Created extended source server.

" + } + } + } + }, "com.amazonaws.drs#CreateReplicationConfigurationTemplate": { "type": "operation", "input": { @@ -148,8 +302,8 @@ "traits": { "smithy.api#documentation": "

Creates a new ReplicationConfigurationTemplate.

", "smithy.api#http": { - "method": "POST", "uri": "/CreateReplicationConfigurationTemplate", + "method": "POST", "code": 201 } } @@ -280,60 +434,60 @@ "traits": { "smithy.api#enum": [ { - "value": "AGENT_NOT_SEEN", - "name": "AGENT_NOT_SEEN" + "name": "AGENT_NOT_SEEN", + "value": "AGENT_NOT_SEEN" }, { - "value": "SNAPSHOTS_FAILURE", - "name": "SNAPSHOTS_FAILURE" + "name": "SNAPSHOTS_FAILURE", + "value": "SNAPSHOTS_FAILURE" }, { - "value": "NOT_CONVERGING", - "name": "NOT_CONVERGING" + "name": "NOT_CONVERGING", + "value": "NOT_CONVERGING" }, { - "value": "UNSTABLE_NETWORK", - "name": "UNSTABLE_NETWORK" + "name": "UNSTABLE_NETWORK", + "value": "UNSTABLE_NETWORK" }, { - "value": "FAILED_TO_CREATE_SECURITY_GROUP", - "name": "FAILED_TO_CREATE_SECURITY_GROUP" + "name": "FAILED_TO_CREATE_SECURITY_GROUP", + "value": "FAILED_TO_CREATE_SECURITY_GROUP" }, { - "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER", - "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER" + "name": "FAILED_TO_LAUNCH_REPLICATION_SERVER", + "value": "FAILED_TO_LAUNCH_REPLICATION_SERVER" }, { - "value": "FAILED_TO_BOOT_REPLICATION_SERVER", - "name": "FAILED_TO_BOOT_REPLICATION_SERVER" + "name": "FAILED_TO_BOOT_REPLICATION_SERVER", + "value": "FAILED_TO_BOOT_REPLICATION_SERVER" }, { - "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", - "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" + "name": "FAILED_TO_AUTHENTICATE_WITH_SERVICE", + "value": "FAILED_TO_AUTHENTICATE_WITH_SERVICE" }, { - "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", - "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE", + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE" }, { - "value": "FAILED_TO_CREATE_STAGING_DISKS", - "name": "FAILED_TO_CREATE_STAGING_DISKS" + "name": "FAILED_TO_CREATE_STAGING_DISKS", + "value": "FAILED_TO_CREATE_STAGING_DISKS" }, { - "value": "FAILED_TO_ATTACH_STAGING_DISKS", - "name": "FAILED_TO_ATTACH_STAGING_DISKS" + "name": "FAILED_TO_ATTACH_STAGING_DISKS", + "value": "FAILED_TO_ATTACH_STAGING_DISKS" }, { - "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", - "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" + "name": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT", + "value": "FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT" }, { - "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", - "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" + "name": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER", + "value": "FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER" }, { - "value": "FAILED_TO_START_DATA_TRANSFER", - "name": "FAILED_TO_START_DATA_TRANSFER" + "name": "FAILED_TO_START_DATA_TRANSFER", + "value": "FAILED_TO_START_DATA_TRANSFER" } ] } @@ -534,24 +688,24 @@ "traits": { "smithy.api#enum": [ { - "value": "NOT_STARTED", - "name": "NOT_STARTED" + "name": "NOT_STARTED", + "value": "NOT_STARTED" }, { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" }, { - "value": "SUCCEEDED", - "name": "SUCCEEDED" + "name": "SUCCEEDED", + "value": "SUCCEEDED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" }, { - "value": "SKIPPED", - "name": "SKIPPED" + "name": "SKIPPED", + "value": "SKIPPED" } ] } @@ -567,44 +721,44 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "INITIATING", - "name": "INITIATING" + "name": "INITIATING", + "value": "INITIATING" }, { - "value": "INITIAL_SYNC", - "name": "INITIAL_SYNC" + "name": "INITIAL_SYNC", + "value": "INITIAL_SYNC" }, { - "value": "BACKLOG", - "name": "BACKLOG" + "name": "BACKLOG", + "value": "BACKLOG" }, { - "value": "CREATING_SNAPSHOT", - "name": "CREATING_SNAPSHOT" + "name": "CREATING_SNAPSHOT", + "value": "CREATING_SNAPSHOT" }, { - "value": "CONTINUOUS", - "name": "CONTINUOUS" + "name": "CONTINUOUS", + "value": "CONTINUOUS" }, { - "value": "PAUSED", - "name": "PAUSED" + "name": "PAUSED", + "value": "PAUSED" }, { - "value": "RESCAN", - "name": "RESCAN" + "name": "RESCAN", + "value": "RESCAN" }, { - "value": "STALLED", - "name": "STALLED" + "name": "STALLED", + "value": "STALLED" }, { - "value": "DISCONNECTED", - "name": "DISCONNECTED" + "name": "DISCONNECTED", + "value": "DISCONNECTED" } ] } @@ -637,8 +791,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single Job by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteJob", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -665,6 +819,9 @@ "input": { "target": "com.amazonaws.drs#DeleteRecoveryInstanceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.drs#AccessDeniedException" @@ -685,8 +842,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteRecoveryInstance", + "method": "POST", "code": 200 } } @@ -731,8 +888,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single Replication Configuration Template by ID

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteReplicationConfigurationTemplate", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -782,8 +939,8 @@ "traits": { "smithy.api#documentation": "

Deletes a single Source Server by ID. The Source Server must be disconnected first.

", "smithy.api#http": { - "method": "POST", "uri": "/DeleteSourceServer", + "method": "POST", "code": 204 }, "smithy.api#idempotent": {} @@ -830,15 +987,15 @@ "traits": { "smithy.api#documentation": "

Retrieves a detailed Job log with pagination.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeJobLogItems", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -909,15 +1066,15 @@ "traits": { "smithy.api#documentation": "

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeJobs", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -928,8 +1085,7 @@ "filters": { "target": "com.amazonaws.drs#DescribeJobsRequestFilters", "traits": { - "smithy.api#documentation": "

A set of filters by which to return Jobs.

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

A set of filters by which to return Jobs.

" } }, "maxResults": { @@ -1029,15 +1185,15 @@ ], "smithy.api#documentation": "

Lists all Recovery Instances or multiple Recovery Instances by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeRecoveryInstances", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1054,8 +1210,7 @@ "filters": { "target": "com.amazonaws.drs#DescribeRecoveryInstancesRequestFilters", "traits": { - "smithy.api#documentation": "

A set of filters by which to return Recovery Instances.

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

A set of filters by which to return Recovery Instances.

" } }, "maxResults": { @@ -1137,15 +1292,15 @@ "traits": { "smithy.api#documentation": "

Lists all Recovery Snapshots for a single Source Server.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeRecoverySnapshots", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1251,15 +1406,15 @@ "traits": { "smithy.api#documentation": "

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeReplicationConfigurationTemplates", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1270,8 +1425,7 @@ "replicationConfigurationTemplateIDs": { "target": "com.amazonaws.drs#ReplicationConfigurationTemplateIDs", "traits": { - "smithy.api#documentation": "

The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.

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

The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.

" } }, "maxResults": { @@ -1330,15 +1484,15 @@ "traits": { "smithy.api#documentation": "

Lists all Source Servers or multiple Source Servers filtered by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/DescribeSourceServers", + "method": "POST", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "items", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -1349,8 +1503,7 @@ "filters": { "target": "com.amazonaws.drs#DescribeSourceServersRequestFilters", "traits": { - "smithy.api#documentation": "

A set of filters by which to return Source Servers.

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

A set of filters by which to return Source Servers.

" } }, "maxResults": { @@ -1381,6 +1534,12 @@ "traits": { "smithy.api#documentation": "

An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.

" } + }, + "stagingAccountIDs": { + "target": "com.amazonaws.drs#AccountIDs", + "traits": { + "smithy.api#documentation": "

An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.

" + } } }, "traits": { @@ -1421,6 +1580,9 @@ "input": { "target": "com.amazonaws.drs#DisconnectRecoveryInstanceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.drs#AccessDeniedException" @@ -1444,8 +1606,8 @@ "traits": { "smithy.api#documentation": "

Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", "smithy.api#http": { - "method": "POST", "uri": "/DisconnectRecoveryInstance", + "method": "POST", "code": 200 } } @@ -1490,8 +1652,8 @@ "traits": { "smithy.api#documentation": "

Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

", "smithy.api#http": { - "method": "POST", "uri": "/DisconnectSourceServer", + "method": "POST", "code": 200 } } @@ -1555,32 +1717,32 @@ "traits": { "smithy.api#enum": [ { - "value": "PENDING", - "name": "PENDING" + "name": "PENDING", + "value": "PENDING" }, { - "value": "RUNNING", - "name": "RUNNING" + "name": "RUNNING", + "value": "RUNNING" }, { - "value": "STOPPING", - "name": "STOPPING" + "name": "STOPPING", + "value": "STOPPING" }, { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "SHUTTING-DOWN", - "name": "SHUTTING_DOWN" + "name": "SHUTTING_DOWN", + "value": "SHUTTING-DOWN" }, { - "value": "TERMINATED", - "name": "TERMINATED" + "name": "TERMINATED", + "value": "TERMINATED" }, { - "value": "NOT_FOUND", - "name": "NOT_FOUND" + "name": "NOT_FOUND", + "value": "NOT_FOUND" } ] } @@ -1616,9 +1778,8 @@ "aws.api#service": { "sdkId": "drs", "arnNamespace": "drs", - "cloudFormationName": "ElasticDisasterRecoveryService", - "cloudTrailEventSource": "drs.amazonaws.com", - "endpointPrefix": "drs" + "awsProductName": "drs", + "cloudTrailEventSource": "drs.amazonaws.com" }, "aws.auth#sigv4": { "name": "drs" @@ -1632,10 +1793,10 @@ "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ - "X-Amz-Content-Sha256", - "X-Amzn-Trace-Id", "Content-Type", - "X-Amz-User-Agent" + "X-Amz-Content-Sha256", + "X-Amz-User-Agent", + "X-Amzn-Trace-Id" ], "additionalExposedHeaders": [ "X-Amzn-Errortype", @@ -1649,9 +1810,18 @@ }, "version": "2020-02-26", "operations": [ + { + "target": "com.amazonaws.drs#CreateExtendedSourceServer" + }, { "target": "com.amazonaws.drs#InitializeService" }, + { + "target": "com.amazonaws.drs#ListExtensibleSourceServers" + }, + { + "target": "com.amazonaws.drs#ListStagingAccounts" + }, { "target": "com.amazonaws.drs#ListTagsForResource" }, @@ -1680,45 +1850,64 @@ } ] }, + "com.amazonaws.drs#ExtensionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "EXTENDED", + "value": "EXTENDED" + }, + { + "name": "EXTENSION_ERROR", + "value": "EXTENSION_ERROR" + }, + { + "name": "NOT_EXTENDED", + "value": "NOT_EXTENDED" + } + ] + } + }, "com.amazonaws.drs#FailbackReplicationError": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "AGENT_NOT_SEEN", - "name": "AGENT_NOT_SEEN" + "name": "AGENT_NOT_SEEN", + "value": "AGENT_NOT_SEEN" }, { - "value": "FAILBACK_CLIENT_NOT_SEEN", - "name": "FAILBACK_CLIENT_NOT_SEEN" + "name": "FAILBACK_CLIENT_NOT_SEEN", + "value": "FAILBACK_CLIENT_NOT_SEEN" }, { - "value": "NOT_CONVERGING", - "name": "NOT_CONVERGING" + "name": "NOT_CONVERGING", + "value": "NOT_CONVERGING" }, { - "value": "UNSTABLE_NETWORK", - "name": "UNSTABLE_NETWORK" + "name": "UNSTABLE_NETWORK", + "value": "UNSTABLE_NETWORK" }, { - "value": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", - "name": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" + "name": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", + "value": "FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" }, { - "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", - "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" + "name": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", + "value": "FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" }, { - "value": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE", - "name": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE" + "name": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE", + "value": "FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE" }, { - "value": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE", - "name": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE" + "name": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE", + "value": "FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE" }, { - "value": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", - "name": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" + "name": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", + "value": "FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" } ] } @@ -1728,24 +1917,24 @@ "traits": { "smithy.api#enum": [ { - "value": "FAILBACK_NOT_STARTED", - "name": "FAILBACK_NOT_STARTED" + "name": "FAILBACK_NOT_STARTED", + "value": "FAILBACK_NOT_STARTED" }, { - "value": "FAILBACK_IN_PROGRESS", - "name": "FAILBACK_IN_PROGRESS" + "name": "FAILBACK_IN_PROGRESS", + "value": "FAILBACK_IN_PROGRESS" }, { - "value": "FAILBACK_READY_FOR_LAUNCH", - "name": "FAILBACK_READY_FOR_LAUNCH" + "name": "FAILBACK_READY_FOR_LAUNCH", + "value": "FAILBACK_READY_FOR_LAUNCH" }, { - "value": "FAILBACK_COMPLETED", - "name": "FAILBACK_COMPLETED" + "name": "FAILBACK_COMPLETED", + "value": "FAILBACK_COMPLETED" }, { - "value": "FAILBACK_ERROR", - "name": "FAILBACK_ERROR" + "name": "FAILBACK_ERROR", + "value": "FAILBACK_ERROR" } ] } @@ -1775,8 +1964,8 @@ "traits": { "smithy.api#documentation": "

Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.

", "smithy.api#http": { - "method": "POST", "uri": "/GetFailbackReplicationConfiguration", + "method": "POST", "code": 200 }, "smithy.api#readonly": {} @@ -1849,8 +2038,8 @@ "traits": { "smithy.api#documentation": "

Gets a LaunchConfiguration, filtered by Source Server IDs.

", "smithy.api#http": { - "method": "POST", "uri": "/GetLaunchConfiguration", + "method": "POST", "code": 200 }, "smithy.api#readonly": {} @@ -1877,6 +2066,9 @@ "target": "com.amazonaws.drs#ReplicationConfiguration" }, "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, { "target": "com.amazonaws.drs#InternalServerException" }, @@ -1893,8 +2085,8 @@ "traits": { "smithy.api#documentation": "

Gets a ReplicationConfiguration, filtered by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/GetReplicationConfiguration", + "method": "POST", "code": 200 }, "smithy.api#readonly": {} @@ -1991,8 +2183,8 @@ ], "smithy.api#documentation": "

Initialize Elastic Disaster Recovery.

", "smithy.api#http": { - "method": "POST", "uri": "/InitializeService", + "method": "POST", "code": 204 } } @@ -2028,6 +2220,10 @@ { "value": "TERMINATE_RECOVERY_INSTANCES", "name": "TERMINATE_RECOVERY_INSTANCES" + }, + { + "value": "TARGET_ACCOUNT", + "name": "TARGET_ACCOUNT" } ] } @@ -2159,72 +2355,72 @@ "traits": { "smithy.api#enum": [ { - "value": "JOB_START", - "name": "JOB_START" + "name": "JOB_START", + "value": "JOB_START" }, { - "value": "SERVER_SKIPPED", - "name": "SERVER_SKIPPED" + "name": "SERVER_SKIPPED", + "value": "SERVER_SKIPPED" }, { - "value": "CLEANUP_START", - "name": "CLEANUP_START" + "name": "CLEANUP_START", + "value": "CLEANUP_START" }, { - "value": "CLEANUP_END", - "name": "CLEANUP_END" + "name": "CLEANUP_END", + "value": "CLEANUP_END" }, { - "value": "CLEANUP_FAIL", - "name": "CLEANUP_FAIL" + "name": "CLEANUP_FAIL", + "value": "CLEANUP_FAIL" }, { - "value": "SNAPSHOT_START", - "name": "SNAPSHOT_START" + "name": "SNAPSHOT_START", + "value": "SNAPSHOT_START" }, { - "value": "SNAPSHOT_END", - "name": "SNAPSHOT_END" + "name": "SNAPSHOT_END", + "value": "SNAPSHOT_END" }, { - "value": "SNAPSHOT_FAIL", - "name": "SNAPSHOT_FAIL" + "name": "SNAPSHOT_FAIL", + "value": "SNAPSHOT_FAIL" }, { - "value": "USING_PREVIOUS_SNAPSHOT", - "name": "USING_PREVIOUS_SNAPSHOT" + "name": "USING_PREVIOUS_SNAPSHOT", + "value": "USING_PREVIOUS_SNAPSHOT" }, { - "value": "USING_PREVIOUS_SNAPSHOT_FAILED", - "name": "USING_PREVIOUS_SNAPSHOT_FAILED" + "name": "USING_PREVIOUS_SNAPSHOT_FAILED", + "value": "USING_PREVIOUS_SNAPSHOT_FAILED" }, { - "value": "CONVERSION_START", - "name": "CONVERSION_START" + "name": "CONVERSION_START", + "value": "CONVERSION_START" }, { - "value": "CONVERSION_END", - "name": "CONVERSION_END" + "name": "CONVERSION_END", + "value": "CONVERSION_END" }, { - "value": "CONVERSION_FAIL", - "name": "CONVERSION_FAIL" + "name": "CONVERSION_FAIL", + "value": "CONVERSION_FAIL" }, { - "value": "LAUNCH_START", - "name": "LAUNCH_START" + "name": "LAUNCH_START", + "value": "LAUNCH_START" }, { - "value": "LAUNCH_FAILED", - "name": "LAUNCH_FAILED" + "name": "LAUNCH_FAILED", + "value": "LAUNCH_FAILED" }, { - "value": "JOB_CANCEL", - "name": "JOB_CANCEL" + "name": "JOB_CANCEL", + "value": "JOB_CANCEL" }, { - "value": "JOB_END", - "name": "JOB_END" + "name": "JOB_END", + "value": "JOB_END" } ] } @@ -2255,6 +2451,12 @@ "traits": { "smithy.api#documentation": "

A string representing a job error.

" } + }, + "conversionProperties": { + "target": "com.amazonaws.drs#ConversionProperties", + "traits": { + "smithy.api#documentation": "

Properties of a conversion job

" + } } }, "traits": { @@ -2287,10 +2489,7 @@ ], "traits": { "aws.api#arn": { - "template": "job/{jobID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "job/{jobID}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag" @@ -2328,6 +2527,10 @@ { "value": "TERMINATE", "name": "TERMINATE" + }, + { + "value": "CREATE_CONVERTED_SNAPSHOT", + "name": "CREATE_CONVERTED_SNAPSHOT" } ] } @@ -2352,20 +2555,20 @@ "traits": { "smithy.api#enum": [ { - "value": "NOT_STARTED", - "name": "NOT_STARTED" + "name": "NOT_STARTED", + "value": "NOT_STARTED" }, { - "value": "PENDING", - "name": "PENDING" + "name": "PENDING", + "value": "PENDING" }, { - "value": "SUCCEEDED", - "name": "SUCCEEDED" + "name": "SUCCEEDED", + "value": "SUCCEEDED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" } ] } @@ -2375,12 +2578,12 @@ "traits": { "smithy.api#enum": [ { - "value": "RECOVERY", - "name": "RECOVERY" + "name": "RECOVERY", + "value": "RECOVERY" }, { - "value": "DRILL", - "name": "DRILL" + "name": "DRILL", + "value": "DRILL" } ] } @@ -2443,12 +2646,12 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "STARTED", - "name": "STARTED" + "name": "STARTED", + "value": "STARTED" } ] } @@ -2572,6 +2775,169 @@ "smithy.api#documentation": "

An object containing information regarding the initiation of the last launch of a Source Server.

" } }, + "com.amazonaws.drs#ListExtensibleSourceServers": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ListExtensibleSourceServersRequest" + }, + "output": { + "target": "com.amazonaws.drs#ListExtensibleSourceServersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of source servers on a staging account that are extensible, which means that:\n a. The source server is not already extended into this Account.\n b. The source server on the Account we’re reading from is not an extension of another source server.\n

", + "smithy.api#http": { + "uri": "/ListExtensibleSourceServers", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#ListExtensibleSourceServersRequest": { + "type": "structure", + "members": { + "stagingAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

The Id of the staging Account to retrieve extensible source servers from.

", + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.drs#MaxResultsReplicatingSourceServers", + "traits": { + "smithy.api#documentation": "

The maximum number of extensible source servers to retrieve.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next extensible source server to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#ListExtensibleSourceServersResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#StagingSourceServersList", + "traits": { + "smithy.api#documentation": "

A list of source servers on a staging Account that are extensible.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next extensible source server to retrieve.

" + } + } + } + }, + "com.amazonaws.drs#ListStagingAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ListStagingAccountsRequest" + }, + "output": { + "target": "com.amazonaws.drs#ListStagingAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an array of staging accounts for existing extended source servers.

", + "smithy.api#http": { + "uri": "/ListStagingAccounts", + "method": "GET", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "accounts" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#ListStagingAccountsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of staging Accounts to retrieve.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next staging Account to retrieve.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.drs#ListStagingAccountsResponse": { + "type": "structure", + "members": { + "accounts": { + "target": "com.amazonaws.drs#Accounts", + "traits": { + "smithy.api#documentation": "

An array of staging AWS Accounts.

" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The token of the next staging Account to retrieve.

" + } + } + } + }, "com.amazonaws.drs#ListTagsForResource": { "type": "operation", "input": { @@ -2601,8 +2967,7 @@ "smithy.api#documentation": "

List all tags for your Elastic Disaster Recovery resources.

", "smithy.api#http": { "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } @@ -2631,6 +2996,15 @@ } } }, + "com.amazonaws.drs#MaxResultsReplicatingSourceServers": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + }, "com.amazonaws.drs#NetworkInterface": { "type": "structure", "members": { @@ -3043,32 +3417,32 @@ "traits": { "smithy.api#enum": [ { - "value": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE", - "name": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE" + "name": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE", + "value": "LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE" }, { - "value": "COMPLETE_VOLUME_MAPPING", - "name": "COMPLETE_VOLUME_MAPPING" + "name": "COMPLETE_VOLUME_MAPPING", + "value": "COMPLETE_VOLUME_MAPPING" }, { - "value": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", - "name": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" + "name": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION", + "value": "ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION" }, { - "value": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", - "name": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" + "name": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT", + "value": "DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT" }, { - "value": "CONFIGURE_REPLICATION_SOFTWARE", - "name": "CONFIGURE_REPLICATION_SOFTWARE" + "name": "CONFIGURE_REPLICATION_SOFTWARE", + "value": "CONFIGURE_REPLICATION_SOFTWARE" }, { - "value": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE", - "name": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE" + "name": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE", + "value": "PAIR_AGENT_WITH_REPLICATION_SOFTWARE" }, { - "value": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", - "name": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" + "name": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION", + "value": "ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION" } ] } @@ -3078,24 +3452,24 @@ "traits": { "smithy.api#enum": [ { - "value": "NOT_STARTED", - "name": "NOT_STARTED" + "name": "NOT_STARTED", + "value": "NOT_STARTED" }, { - "value": "IN_PROGRESS", - "name": "IN_PROGRESS" + "name": "IN_PROGRESS", + "value": "IN_PROGRESS" }, { - "value": "SUCCEEDED", - "name": "SUCCEEDED" + "name": "SUCCEEDED", + "value": "SUCCEEDED" }, { - "value": "FAILED", - "name": "FAILED" + "name": "FAILED", + "value": "FAILED" }, { - "value": "SKIPPED", - "name": "SKIPPED" + "name": "SKIPPED", + "value": "SKIPPED" } ] } @@ -3111,44 +3485,44 @@ "traits": { "smithy.api#enum": [ { - "value": "STOPPED", - "name": "STOPPED" + "name": "STOPPED", + "value": "STOPPED" }, { - "value": "INITIATING", - "name": "INITIATING" + "name": "INITIATING", + "value": "INITIATING" }, { - "value": "INITIAL_SYNC", - "name": "INITIAL_SYNC" + "name": "INITIAL_SYNC", + "value": "INITIAL_SYNC" }, { - "value": "BACKLOG", - "name": "BACKLOG" + "name": "BACKLOG", + "value": "BACKLOG" }, { - "value": "CREATING_SNAPSHOT", - "name": "CREATING_SNAPSHOT" + "name": "CREATING_SNAPSHOT", + "value": "CREATING_SNAPSHOT" }, { - "value": "CONTINUOUS", - "name": "CONTINUOUS" + "name": "CONTINUOUS", + "value": "CONTINUOUS" }, { - "value": "PAUSED", - "name": "PAUSED" + "name": "PAUSED", + "value": "PAUSED" }, { - "value": "RESCAN", - "name": "RESCAN" + "name": "RESCAN", + "value": "RESCAN" }, { - "value": "STALLED", - "name": "STALLED" + "name": "STALLED", + "value": "STALLED" }, { - "value": "DISCONNECTED", - "name": "DISCONNECTED" + "name": "DISCONNECTED", + "value": "DISCONNECTED" } ] } @@ -3362,10 +3736,7 @@ ], "traits": { "aws.api#arn": { - "template": "recovery-instance/{recoveryInstanceID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "recovery-instance/{recoveryInstanceID}" }, "aws.iam#conditionKeys": [ "drs:EC2InstanceARN", @@ -3448,12 +3819,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ASC", - "name": "ASC" + "name": "ASC", + "value": "ASC" }, { - "value": "DESC", - "name": "DESC" + "name": "DESC", + "value": "DESC" } ] } @@ -3838,10 +4209,7 @@ }, "traits": { "aws.api#arn": { - "template": "replication-configuration-template/{replicationConfigurationTemplateID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "replication-configuration-template/{replicationConfigurationTemplateID}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag" @@ -3923,8 +4291,8 @@ "traits": { "smithy.api#documentation": "

Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.

", "smithy.api#http": { - "method": "POST", "uri": "/RetryDataReplication", + "method": "POST", "code": 200 } } @@ -4106,6 +4474,12 @@ "traits": { "smithy.api#documentation": "

The source properties of the Source Server.

" } + }, + "stagingArea": { + "target": "com.amazonaws.drs#StagingArea", + "traits": { + "smithy.api#documentation": "

The staging area of the source server.

" + } } }, "traits": { @@ -4116,6 +4490,16 @@ ] } }, + "com.amazonaws.drs#SourceServerARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(?:[0-9a-zA-Z_-]+:){3}([0-9]{12,}):source-server/(s-[0-9a-zA-Z]{17})$" + } + }, "com.amazonaws.drs#SourceServerID": { "type": "string", "traits": { @@ -4175,10 +4559,7 @@ ], "traits": { "aws.api#arn": { - "template": "source-server/{sourceServerID}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "source-server/{sourceServerID}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag" @@ -4192,6 +4573,70 @@ "target": "com.amazonaws.drs#SourceServer" } }, + "com.amazonaws.drs#StagingArea": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.drs#ExtensionStatus", + "traits": { + "smithy.api#documentation": "

Status of Source server extension. Possible values:\n (a) NOT_EXTENDED - This is a source server that is replicating in the current account.\n (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account.\n (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.

" + } + }, + "stagingAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "

Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.

" + } + }, + "stagingSourceServerArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "

Arn of the staging source server if this source server is extended

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

Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR

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

Staging information related to source server.

" + } + }, + "com.amazonaws.drs#StagingSourceServer": { + "type": "structure", + "members": { + "hostname": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "

Hostname of staging source server.

" + } + }, + "arn": { + "target": "com.amazonaws.drs#SourceServerARN", + "traits": { + "smithy.api#documentation": "

The ARN of the source server.

" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the staging source server.

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

Source server in staging account that extended source server connected to.

" + } + }, + "com.amazonaws.drs#StagingSourceServersList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#StagingSourceServer" + } + }, "com.amazonaws.drs#StartFailbackLaunch": { "type": "operation", "input": { @@ -4223,8 +4668,8 @@ "traits": { "smithy.api#documentation": "

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.

", "smithy.api#http": { - "method": "POST", "uri": "/StartFailbackLaunch", + "method": "POST", "code": 200 } } @@ -4335,8 +4780,8 @@ ], "smithy.api#documentation": "

Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

", "smithy.api#http": { - "method": "POST", "uri": "/StartRecovery", + "method": "POST", "code": 202 } } @@ -4414,6 +4859,9 @@ "input": { "target": "com.amazonaws.drs#StopFailbackRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.drs#InternalServerException" @@ -4431,8 +4879,8 @@ "traits": { "smithy.api#documentation": "

Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.

", "smithy.api#http": { - "method": "POST", "uri": "/StopFailback", + "method": "POST", "code": 200 } } @@ -4490,6 +4938,9 @@ "input": { "target": "com.amazonaws.drs#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.drs#AccessDeniedException" @@ -4511,8 +4962,7 @@ "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

", "smithy.api#http": { "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -4563,12 +5013,12 @@ "traits": { "smithy.api#enum": [ { - "value": "NONE", - "name": "NONE" + "name": "NONE", + "value": "NONE" }, { - "value": "BASIC", - "name": "BASIC" + "name": "BASIC", + "value": "BASIC" } ] } @@ -4607,8 +5057,8 @@ ], "smithy.api#documentation": "

Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.

", "smithy.api#http": { - "method": "POST", "uri": "/TerminateRecoveryInstances", + "method": "POST", "code": 200 } } @@ -4692,6 +5142,9 @@ "input": { "target": "com.amazonaws.drs#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.drs#AccessDeniedException" @@ -4713,8 +5166,7 @@ "smithy.api#documentation": "

Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.

", "smithy.api#http": { "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 + "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } @@ -4745,6 +5197,9 @@ "input": { "target": "com.amazonaws.drs#UpdateFailbackReplicationConfigurationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.drs#AccessDeniedException" @@ -4765,8 +5220,8 @@ "traits": { "smithy.api#documentation": "

Allows you to update the failback replication configuration of a Recovery Instance by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateFailbackReplicationConfiguration", + "method": "POST", "code": 200 } } @@ -4832,8 +5287,8 @@ "traits": { "smithy.api#documentation": "

Updates a LaunchConfiguration by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateLaunchConfiguration", + "method": "POST", "code": 200 }, "smithy.api#idempotent": {} @@ -4921,8 +5376,8 @@ "traits": { "smithy.api#documentation": "

Allows you to update a ReplicationConfiguration by Source Server ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateReplicationConfiguration", + "method": "POST", "code": 200 }, "smithy.api#idempotent": {} @@ -5061,8 +5516,8 @@ "traits": { "smithy.api#documentation": "

Updates a ReplicationConfigurationTemplate by ID.

", "smithy.api#http": { - "method": "POST", "uri": "/UpdateReplicationConfigurationTemplate", + "method": "POST", "code": 200 } } @@ -5240,6 +5695,24 @@ ] } }, + "com.amazonaws.drs#VolumeToConversionMap": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "value": { + "target": "com.amazonaws.drs#ConversionMap" + } + }, + "com.amazonaws.drs#VolumeToSizeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.drs#LargeBoundedString" + }, + "value": { + "target": "com.amazonaws.drs#PositiveInteger" + } + }, "com.amazonaws.drs#ebsSnapshot": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/ds.json b/aws/sdk/aws-models/ds.json index 49f84c048..f21cfa51b 100644 --- a/aws/sdk/aws-models/ds.json +++ b/aws/sdk/aws-models/ds.json @@ -725,6 +725,10 @@ { "value": "SmartCard", "name": "SMART_CARD" + }, + { + "value": "SmartCardOrPassword", + "name": "SMART_CARD_OR_PASSWORD" } ] } @@ -2586,6 +2590,85 @@ } } }, + "com.amazonaws.directoryservice#DescribeSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#DescribeSettingsRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#DescribeSettingsResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about the configurable settings for the specified directory.

" + } + }, + "com.amazonaws.directoryservice#DescribeSettingsRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to retrieve information.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The status of the directory settings for which to retrieve information.

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

The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

" + } + } + } + }, + "com.amazonaws.directoryservice#DescribeSettingsResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory.

" + } + }, + "SettingEntries": { + "target": "com.amazonaws.directoryservice#SettingEntries", + "traits": { + "smithy.api#documentation": "

The list of SettingEntry objects that were retrieved.

\n

It is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.

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

If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items.

" + } + } + } + }, "com.amazonaws.directoryservice#DescribeSharedDirectories": { "type": "operation", "input": { @@ -2878,6 +2961,77 @@ "smithy.api#error": "client" } }, + "com.amazonaws.directoryservice#DirectoryConfigurationSettingAllowedValues": { + "type": "string" + }, + "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastRequestedDateTime": { + "type": "timestamp" + }, + "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastUpdatedDateTime": { + "type": "timestamp" + }, + "com.amazonaws.directoryservice#DirectoryConfigurationSettingName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-/. _]*$" + } + }, + "com.amazonaws.directoryservice#DirectoryConfigurationSettingRequestDetailedStatus": { + "type": "map", + "key": { + "target": "com.amazonaws.directoryservice#RegionName" + }, + "value": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationStatus" + } + }, + "com.amazonaws.directoryservice#DirectoryConfigurationSettingRequestStatusMessage": { + "type": "string" + }, + "com.amazonaws.directoryservice#DirectoryConfigurationSettingType": { + "type": "string" + }, + "com.amazonaws.directoryservice#DirectoryConfigurationSettingValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.directoryservice#DirectoryConfigurationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Requested", + "name": "REQUESTED" + }, + { + "value": "Updating", + "name": "UPDATING" + }, + { + "value": "Updated", + "name": "UPDATED" + }, + { + "value": "Failed", + "name": "FAILED" + }, + { + "value": "Default", + "name": "DEFAULT" + } + ] + } + }, "com.amazonaws.directoryservice#DirectoryConnectSettings": { "type": "structure", "members": { @@ -3270,6 +3424,24 @@ }, "com.amazonaws.directoryservice#DirectoryService_20150416": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Directory Service", + "arnNamespace": "ds", + "cloudFormationName": "DirectoryService", + "cloudTrailEventSource": "directoryservice.amazonaws.com", + "endpointPrefix": "ds" + }, + "aws.auth#sigv4": { + "name": "ds" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Directory Service\n

Directory Service is a web service that makes it easy for you to setup and run directories in the\n Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active\n Directory. This guide provides detailed information about Directory Service operations, data types,\n parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service\n Administration Guide.

\n \n

Amazon Web Services provides SDKs that consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs\n provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services\n services. For more information about the Amazon Web Services SDKs, including how to download and\n install them, see Tools for Amazon Web\n Services.

\n ", + "smithy.api#title": "AWS Directory Service", + "smithy.api#xmlNamespace": { + "uri": "http://directoryservice.amazonaws.com/doc/2015-04-16/" + } + }, "version": "2015-04-16", "operations": [ { @@ -3359,6 +3531,9 @@ { "target": "com.amazonaws.directoryservice#DescribeRegions" }, + { + "target": "com.amazonaws.directoryservice#DescribeSettings" + }, { "target": "com.amazonaws.directoryservice#DescribeSharedDirectories" }, @@ -3455,31 +3630,16 @@ { "target": "com.amazonaws.directoryservice#UpdateRadius" }, + { + "target": "com.amazonaws.directoryservice#UpdateSettings" + }, { "target": "com.amazonaws.directoryservice#UpdateTrust" }, { "target": "com.amazonaws.directoryservice#VerifyTrust" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Directory Service", - "arnNamespace": "ds", - "cloudFormationName": "DirectoryService", - "cloudTrailEventSource": "directoryservice.amazonaws.com", - "endpointPrefix": "ds" - }, - "aws.auth#sigv4": { - "name": "ds" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Directory Service\n

Directory Service is a web service that makes it easy for you to setup and run directories in the\n Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active\n Directory. This guide provides detailed information about Directory Service operations, data types,\n parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service\n Administration Guide.

\n \n

Amazon Web Services provides SDKs that consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs\n provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services\n services. For more information about the Amazon Web Services SDKs, including how to download and\n install them, see Tools for Amazon Web\n Services.

\n ", - "smithy.api#title": "AWS Directory Service", - "smithy.api#xmlNamespace": { - "uri": "http://directoryservice.amazonaws.com/doc/2015-04-16/" - } - } + ] }, "com.amazonaws.directoryservice#DirectoryShortName": { "type": "string", @@ -4430,6 +4590,21 @@ "smithy.api#documentation": "

Contains the results of the GetSnapshotLimits operation.

" } }, + "com.amazonaws.directoryservice#IncompatibleSettingsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" + } + }, + "traits": { + "smithy.api#documentation": "

The specified directory setting is not compatible with other settings.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.directoryservice#InsufficientPermissionsException": { "type": "structure", "members": { @@ -6220,6 +6395,108 @@ "smithy.api#error": "server" } }, + "com.amazonaws.directoryservice#Setting": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingName", + "traits": { + "smithy.api#documentation": "

The name of the directory setting. For example:

\n

\n TLS_1_0\n

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingValue", + "traits": { + "smithy.api#documentation": "

The value of the directory setting for which to retrieve information. For example, for TLS_1_0, the valid values are: Enable and Disable.

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

Contains information about the configurable settings for a directory.

" + } + }, + "com.amazonaws.directoryservice#SettingEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#SettingEntry" + } + }, + "com.amazonaws.directoryservice#SettingEntry": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingType", + "traits": { + "smithy.api#documentation": "

The type of directory setting. For example, Protocol or Cipher.

" + } + }, + "Name": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingName", + "traits": { + "smithy.api#documentation": "

The name of the directory setting. For example:

\n

\n TLS_1_0\n

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingAllowedValues", + "traits": { + "smithy.api#documentation": "

The valid range of values for the directory setting.

" + } + }, + "AppliedValue": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingValue", + "traits": { + "smithy.api#documentation": "

The value of the directory setting that is applied to the directory.

" + } + }, + "RequestedValue": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingValue", + "traits": { + "smithy.api#documentation": "

The value that was last requested for the directory setting.

" + } + }, + "RequestStatus": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationStatus", + "traits": { + "smithy.api#documentation": "

The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is Failed.

" + } + }, + "RequestDetailedStatus": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingRequestDetailedStatus", + "traits": { + "smithy.api#documentation": "

Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.

" + } + }, + "RequestStatusMessage": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingRequestStatusMessage", + "traits": { + "smithy.api#documentation": "

The last status message for the directory status request.

" + } + }, + "LastUpdatedDateTime": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastUpdatedDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the directory setting was last updated.

" + } + }, + "LastRequestedDateTime": { + "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastRequestedDateTime", + "traits": { + "smithy.api#documentation": "

The date and time when the request to update a directory setting was last submitted.

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

Contains information about the specified configurable setting for a directory.

" + } + }, + "com.amazonaws.directoryservice#Settings": { + "type": "list", + "member": { + "target": "com.amazonaws.directoryservice#Setting" + } + }, "com.amazonaws.directoryservice#ShareDirectory": { "type": "operation", "input": { @@ -6972,7 +7249,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^(.|\\s)*\\S(.|\\s)*$", + "smithy.api#pattern": "^(\\p{LD}|\\p{Punct}| )+$", "smithy.api#sensitive": {} } }, @@ -7147,6 +7424,21 @@ "smithy.api#error": "client" } }, + "com.amazonaws.directoryservice#UnsupportedSettingsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.directoryservice#ExceptionMessage" + }, + "RequestId": { + "target": "com.amazonaws.directoryservice#RequestId" + } + }, + "traits": { + "smithy.api#documentation": "

The specified directory setting is not supported.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.directoryservice#UpdateConditionalForwarder": { "type": "operation", "input": { @@ -7331,6 +7623,74 @@ "com.amazonaws.directoryservice#UpdateSecurityGroupForDirectoryControllers": { "type": "boolean" }, + "com.amazonaws.directoryservice#UpdateSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.directoryservice#UpdateSettingsRequest" + }, + "output": { + "target": "com.amazonaws.directoryservice#UpdateSettingsResult" + }, + "errors": [ + { + "target": "com.amazonaws.directoryservice#ClientException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryDoesNotExistException" + }, + { + "target": "com.amazonaws.directoryservice#DirectoryUnavailableException" + }, + { + "target": "com.amazonaws.directoryservice#IncompatibleSettingsException" + }, + { + "target": "com.amazonaws.directoryservice#InvalidParameterException" + }, + { + "target": "com.amazonaws.directoryservice#ServiceException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedOperationException" + }, + { + "target": "com.amazonaws.directoryservice#UnsupportedSettingsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the configurable settings for the specified directory.

" + } + }, + "com.amazonaws.directoryservice#UpdateSettingsRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory for which to update settings.

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

The list of Setting objects.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.directoryservice#UpdateSettingsResult": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.directoryservice#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the directory.

" + } + } + } + }, "com.amazonaws.directoryservice#UpdateTrust": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/dynamodb.json b/aws/sdk/aws-models/dynamodb.json index 47e63f7d5..79ea156ea 100644 --- a/aws/sdk/aws-models/dynamodb.json +++ b/aws/sdk/aws-models/dynamodb.json @@ -191,7 +191,7 @@ "L": { "target": "com.amazonaws.dynamodb#ListAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]\n

" + "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\": \"3.14159\"}]\n

" } }, "NULL": { @@ -229,7 +229,7 @@ "Action": { "target": "com.amazonaws.dynamodb#AttributeAction", "traits": { - "smithy.api#documentation": "

Specifies how to perform the update. Valid values are PUT (default),\n DELETE, and ADD. The behavior depends on whether the\n specified primary key already exists in the table.

\n\n

\n If an item with the specified Key is found in\n the table:\n

\n\n
    \n
  • \n

    \n PUT - Adds the specified attribute to the item. If the attribute\n already exists, it is replaced by the new value.

    \n
    • \n
  • \n

    \n DELETE - If no value is specified, the attribute and its value are\n removed from the item. The data type of the specified value must match the\n existing value's data type.

    \n

    If a set of values is specified, then those values are\n subtracted from the old set. For example, if the attribute value was the set\n [a,b,c] and the DELETE action specified\n [a,c], then the final attribute value would be\n [b]. Specifying an empty set is an error.

    \n
    • \n
  • \n

    \n ADD - If the attribute does not already exist, then the attribute\n and its values are added to the item. If the attribute does exist, then the\n behavior of ADD depends on the data type of the attribute:

    \n
      \n
    • \n

      If the existing attribute is a number, and if Value is\n also a number, then the Value is mathematically added to\n the existing attribute. If Value is a negative number, then\n it is subtracted from the existing attribute.

      \n \n

      If you use ADD to increment or decrement a number\n value for an item that doesn't exist before the update, DynamoDB\n uses 0 as the initial value.

      \n

      In addition, if you use ADD to update an existing\n item, and intend to increment or decrement an attribute value which\n does not yet exist, DynamoDB uses 0 as the initial\n value. For example, suppose that the item you want to update does\n not yet have an attribute named itemcount, but\n you decide to ADD the number 3 to this\n attribute anyway, even though it currently does not exist. DynamoDB\n will create the itemcount attribute, set its\n initial value to 0, and finally add 3 to\n it. The result will be a new itemcount\n attribute in the item, with a value of 3.

      \n       \n
      • \n
    • \n

      If the existing data type is a set, and if the Value is\n also a set, then the Value is added to the existing set.\n (This is a set operation, not mathematical\n addition.) For example, if the attribute value was the set\n [1,2], and the ADD action specified\n [3], then the final attribute value would be\n [1,2,3]. An error occurs if an Add action is specified\n for a set attribute and the attribute type specified does not match the\n existing set type.

      \n

      Both sets must have the same primitive data type. For example, if the\n existing data type is a set of strings, the Value must also\n be a set of strings. The same holds true for number sets and binary\n sets.

      \n
      • \n
    \n

    This action is only valid for an existing attribute whose data type is number\n or is a set. Do not use ADD for any other data types.

    \n
    • \n
\n\n

\n If no item with the specified Key is\n found:\n

\n\n
    \n
  • \n

    \n PUT - DynamoDB creates a new item with the specified primary key,\n and then adds the attribute.

    \n
    • \n
  • \n

    \n DELETE - Nothing happens; there is no attribute to delete.

    \n
    • \n
  • \n

    \n ADD - DynamoDB creates an item with the supplied primary key and\n number (or set of numbers) for the attribute value. The only data types allowed\n are number and number set; no other data types can be specified.

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

Specifies how to perform the update. Valid values are PUT (default),\n DELETE, and ADD. The behavior depends on whether the\n specified primary key already exists in the table.

\n\n

\n If an item with the specified Key is found in\n the table:\n

\n\n
    \n
  • \n

    \n PUT - Adds the specified attribute to the item. If the attribute\n already exists, it is replaced by the new value.

    \n
    • \n
  • \n

    \n DELETE - If no value is specified, the attribute and its value are\n removed from the item. The data type of the specified value must match the\n existing value's data type.

    \n

    If a set of values is specified, then those values are\n subtracted from the old set. For example, if the attribute value was the set\n [a,b,c] and the DELETE action specified\n [a,c], then the final attribute value would be\n [b]. Specifying an empty set is an error.

    \n
    • \n
  • \n

    \n ADD - If the attribute does not already exist, then the attribute\n and its values are added to the item. If the attribute does exist, then the\n behavior of ADD depends on the data type of the attribute:

    \n
      \n
    • \n

      If the existing attribute is a number, and if Value is\n also a number, then the Value is mathematically added to\n the existing attribute. If Value is a negative number, then\n it is subtracted from the existing attribute.

      \n \n

      If you use ADD to increment or decrement a number\n value for an item that doesn't exist before the update, DynamoDB\n uses 0 as the initial value.

      \n

      In addition, if you use ADD to update an existing\n item, and intend to increment or decrement an attribute value which\n does not yet exist, DynamoDB uses 0 as the initial\n value. For example, suppose that the item you want to update does\n not yet have an attribute named itemcount, but\n you decide to ADD the number 3 to this\n attribute anyway, even though it currently does not exist. DynamoDB\n will create the itemcount attribute, set its\n initial value to 0, and finally add 3 to\n it. The result will be a new itemcount\n attribute in the item, with a value of 3.

      \n       \n
      • \n
    • \n

      If the existing data type is a set, and if the Value is\n also a set, then the Value is added to the existing set.\n (This is a set operation, not mathematical\n addition.) For example, if the attribute value was the set\n [1,2], and the ADD action specified\n [3], then the final attribute value would be\n [1,2,3]. An error occurs if an Add action is specified\n for a set attribute and the attribute type specified does not match the\n existing set type.

      \n

      Both sets must have the same primitive data type. For example, if the\n existing data type is a set of strings, the Value must also\n be a set of strings. The same holds true for number sets and binary\n sets.

      \n
      • \n
    \n

    This action is only valid for an existing attribute whose data type is number\n or is a set. Do not use ADD for any other data types.

    \n
    • \n
\n\n

\n If no item with the specified Key is\n found:\n

\n\n
    \n
  • \n

    \n PUT - DynamoDB creates a new item with the specified primary key,\n and then adds the attribute.

    \n
    • \n
  • \n

    \n DELETE - Nothing happens; there is no attribute to delete.

    \n
    • \n
  • \n

    \n ADD - DynamoDB creates a new item with the supplied primary key and\n number (or set) for the attribute value. The only data types allowed\n are number, number set, string set or binary set.

    \n
    • \n
" } } }, @@ -510,7 +510,7 @@ "BackupSizeBytes": { "target": "com.amazonaws.dynamodb#BackupSizeBytes", "traits": { - "smithy.api#documentation": "

Size of the backup in bytes.

" + "smithy.api#documentation": "

Size of the backup in bytes. DynamoDB updates this value approximately every six hours. \n Recent changes might not be reflected in this value.

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

This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL.

\n \n

The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

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

This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality\n condition on all key attributes. This enforces that each SELECT statement in a\n batch returns at most a single item.

\n \n

The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

\n \n \n

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the Error field of the BatchStatementResponse for each\n statement.

\n " } }, "com.amazonaws.dynamodb#BatchExecuteStatementInput": { @@ -1041,7 +1041,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of \n data over the network, consisting of up to 25 item put or delete operations. While \n individual items can be up to 400 KB once stored, it's important to \n note that an item's representation might be greater than 400KB while being sent in \n DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

\n \n

\n BatchWriteItem cannot update items. To update items, use the\n UpdateItem action.

\n \n

The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n\n

With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

\n

If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

\n

Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

\n

If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

\n
    \n
  • \n

    One or more tables specified in the BatchWriteItem request does\n not exist.

    \n
    • \n
  • \n

    Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.

    \n
    • \n
  • \n

    You try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.

    \n
    • \n
  • \n

    Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).

    \n
    • \n
  • \n

    There are more than 25 requests in the batch.

    \n
    • \n
  • \n

    Any individual item in a batch exceeds 400 KB.

    \n
    • \n
  • \n

    The total request size exceeds 16 MB.

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

The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can transmit up to 16MB of\n data over the network, consisting of up to 25 item put or delete operations. While\n individual items can be up to 400 KB once stored, it's important to note that an item's\n representation might be greater than 400KB while being sent in DynamoDB's JSON format\n for the API call. For more details on this distinction, see Naming Rules and Data Types.

\n \n

\n BatchWriteItem cannot update items. To update items, use the\n UpdateItem action.

\n \n

The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n\n

With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

\n

If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

\n

Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

\n

If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

\n
    \n
  • \n

    One or more tables specified in the BatchWriteItem request does\n not exist.

    \n
    • \n
  • \n

    Primary key attributes specified on an item in the request do not match those\n in the corresponding table's primary key schema.

    \n
    • \n
  • \n

    You try to perform multiple operations on the same item in the same\n BatchWriteItem request. For example, you cannot put and delete\n the same item in the same BatchWriteItem request.

    \n
    • \n
  • \n

    Your request contains at least two items with identical hash and range keys\n (which essentially is two put operations).

    \n
    • \n
  • \n

    There are more than 25 requests in the batch.

    \n
    • \n
  • \n

    Any individual item in a batch exceeds 400 KB.

    \n
    • \n
  • \n

    The total request size exceeds 16 MB.

    \n
    • \n
" } }, "com.amazonaws.dynamodb#BatchWriteItemInput": { @@ -2146,7 +2146,7 @@ "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared\n before they were deleted. For DeleteItem, the valid values are:

\n
    \n
  • \n

    \n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)

    \n
    • \n
  • \n

    \n ALL_OLD - The content of the old item is returned.

    \n
    • \n
\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, DeleteItem does not recognize any values other than\n NONE or ALL_OLD.

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

Use ReturnValues if you want to get the item attributes as they appeared\n before they were deleted. For DeleteItem, the valid values are:

\n
    \n
  • \n

    \n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)

    \n
    • \n
  • \n

    \n ALL_OLD - The content of the old item is returned.

    \n
    • \n
\n

There is no additional cost associated with requesting a return value aside from the small \n network and processing overhead of receiving a larger response. No read capacity units are \n consumed.

\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, DeleteItem does not recognize any values other than\n NONE or ALL_OLD.

\n " } }, "ReturnConsumedCapacity": { @@ -3448,7 +3448,7 @@ "ReturnConsumedCapacity": { "target": "com.amazonaws.dynamodb#ReturnConsumedCapacity", "traits": { - "smithy.api#documentation": "

Determines the level of detail about either provisioned or on-demand throughput consumption that is\n returned in the response. For more information, see TransactGetItems and TransactWriteItems.

" + "smithy.api#documentation": "

Determines the level of detail about either provisioned or on-demand throughput\n consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.

" } } } @@ -3783,7 +3783,7 @@ "ExportTime": { "target": "com.amazonaws.dynamodb#ExportTime", "traits": { - "smithy.api#documentation": "

Time in the past from which to export table data. The table export will be a snapshot\n of the table's state at this point in time.

" + "smithy.api#documentation": "

Time in the past from which to export table data, counted in seconds from the start of\n the Unix epoch. The table export will be a snapshot of the table's state at this point\n in time.

" } }, "ClientToken": { @@ -4853,7 +4853,7 @@ } }, "traits": { - "smithy.api#documentation": "

There is no limit to the number of daily on-demand backups that can be taken.

\n

Up to 50 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary\n indexes. You can have up to 25 such requests running at a time; however, if the table or\n index specifications are complex, DynamoDB might temporarily reduce the number\n of concurrent operations.

\n

There is a soft account quota of 256 tables.

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

There is no limit to the number of daily on-demand backups that can be taken.

\n

Up to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary\n indexes. You can have up to 250 such requests running at a time; however, if the table or\n index specifications are complex, DynamoDB might temporarily reduce the number\n of concurrent operations.

\n

There is a soft account quota of 2,500 tables.

", "smithy.api#error": "client" } }, @@ -4922,7 +4922,7 @@ "BackupType": { "target": "com.amazonaws.dynamodb#BackupTypeFilter", "traits": { - "smithy.api#documentation": "

The backups from the table specified by BackupType are listed.

\n

Where BackupType can be:

\n
    \n
  • \n

    \n USER - On-demand backup created by you.

    \n
    • \n
  • \n

    \n SYSTEM - On-demand backup automatically created by DynamoDB.

    \n
    • \n
  • \n

    \n ALL - All types of on-demand backups (USER and SYSTEM).

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

The backups from the table specified by BackupType are listed.

\n

Where BackupType can be:

\n
    \n
  • \n

    \n USER - On-demand backup created by you. (The default setting if no other backup types are specified.)

    \n
    • \n
  • \n

    \n SYSTEM - On-demand backup automatically created by DynamoDB.

    \n
    • \n
  • \n

    \n ALL - All types of on-demand backups (USER and SYSTEM).

    \n
    • \n
" } } } @@ -5650,7 +5650,7 @@ "NonKeyAttributes": { "target": "com.amazonaws.dynamodb#NonKeyAttributeNameList", "traits": { - "smithy.api#documentation": "

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed\n across all of the local secondary indexes, must not exceed 20. If you project the same\n attribute into two different indexes, this counts as two distinct attributes when\n determining the total.

" + "smithy.api#documentation": "

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed\n across all of the local secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct attributes when\n determining the total.

" } } }, @@ -5853,7 +5853,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.

\n \n

This topic provides general information about the PutItem API.

\n

For information on how to call the PutItem API using the Amazon Web Services SDK in specific languages, see the following:

\n \n \n\n

When you add an item, the primary key attributes are the only required attributes.\n Attribute values cannot be null.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.

\n

Invalid Requests with empty values will be rejected with a\n ValidationException exception.

\n \n

To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.

\n \n

For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.

\n\n

When you add an item, the primary key attributes are the only required attributes.\n Attribute values cannot be null.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.

\n

Invalid Requests with empty values will be rejected with a\n ValidationException exception.

\n \n

To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.

\n \n

For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#PutItemInput": { @@ -5882,7 +5882,7 @@ "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared\n before they were updated with the PutItem request. For\n PutItem, the valid values are:

\n
    \n
  • \n

    \n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)

    \n
    • \n
  • \n

    \n ALL_OLD - If PutItem overwrote an attribute name-value\n pair, then the content of the old item is returned.

    \n
    • \n
\n

The values returned are strongly consistent.

\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, PutItem does not recognize any values other than\n NONE or ALL_OLD.

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

Use ReturnValues if you want to get the item attributes as they appeared\n before they were updated with the PutItem request. For\n PutItem, the valid values are:

\n
    \n
  • \n

    \n NONE - If ReturnValues is not specified, or if its\n value is NONE, then nothing is returned. (This setting is the\n default for ReturnValues.)

    \n
    • \n
  • \n

    \n ALL_OLD - If PutItem overwrote an attribute name-value\n pair, then the content of the old item is returned.

    \n
    • \n
\n

The values returned are strongly consistent.

\n

There is no additional cost associated with requesting a return value aside from the small \n network and processing overhead of receiving a larger response. No read capacity units are \n consumed.

\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, PutItem does not recognize any values other than\n NONE or ALL_OLD.

\n " } }, "ReturnConsumedCapacity": { @@ -6033,7 +6033,7 @@ "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n
    \n
  • \n

    \n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.

    \n
    • \n
  • \n

    \n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.

    \n
    • \n
  • \n

    \n COUNT - Returns the number of matching items, rather than the\n matching items themselves.

    \n
    • \n
  • \n

    \n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n AttributesToGet. This return value is equivalent to specifying\n AttributesToGet without specifying any value for\n Select.

    \n

    If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation will read only the index and not\n the table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.

    \n

    If you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.

    \n
    • \n
\n

If neither Select nor AttributesToGet are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and AttributesToGet together in a single request,\n unless the value for Select is SPECIFIC_ATTRIBUTES. (This\n usage is equivalent to specifying AttributesToGet without any value for\n Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

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

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n
    \n
  • \n

    \n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.

    \n
    • \n
  • \n

    \n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.

    \n
    • \n
  • \n

    \n COUNT - Returns the number of matching items, rather than the\n matching items themselves.

    \n
    • \n
  • \n

    \n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.

    \n

    If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation will read only the index and not\n the table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.

    \n

    If you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.

    \n
    • \n
\n

If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

\n " } }, "AttributesToGet": { @@ -6096,7 +6096,7 @@ "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n

A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n

A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, "KeyConditionExpression": { @@ -6755,7 +6755,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents one of the following:

\n
    \n
  • \n

    A new replica to be added to an existing regional table or global table. This\n request invokes the CreateTableReplica action in the destination\n Region.

    \n
    • \n
  • \n

    New parameters for an existing replica. This request invokes the\n UpdateTable action in the destination Region.

    \n
    • \n
  • \n

    An existing replica to be deleted. The request invokes the\n DeleteTableReplica action in the destination Region, deleting\n the replica and all if its items in the destination Region.

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

Represents one of the following:

\n
    \n
  • \n

    A new replica to be added to an existing regional table or global table. This\n request invokes the CreateTableReplica action in the destination\n Region.

    \n
    • \n
  • \n

    New parameters for an existing replica. This request invokes the\n UpdateTable action in the destination Region.

    \n
    • \n
  • \n

    An existing replica to be deleted. The request invokes the\n DeleteTableReplica action in the destination Region, deleting\n the replica and all if its items in the destination Region.

    \n
    • \n
\n \n

When you manually remove a table or global table replica, you do not \n automatically remove any associated scalable targets, scaling policies, or \n CloudWatch alarms.

\n " } }, "com.amazonaws.dynamodb#ReplicationGroupUpdateList": { @@ -7383,7 +7383,7 @@ "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n
    \n
  • \n

    \n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.

    \n
    • \n
  • \n

    \n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.

    \n
    • \n
  • \n

    \n COUNT - Returns the number of matching items, rather than the\n matching items themselves.

    \n
    • \n
  • \n

    \n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n AttributesToGet. This return value is equivalent to specifying\n AttributesToGet without specifying any value for\n Select.

    \n

    If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation reads only the index and not the\n table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.

    \n

    If you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.

    \n
    • \n
\n

If neither Select nor AttributesToGet are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and AttributesToGet together in a single request,\n unless the value for Select is SPECIFIC_ATTRIBUTES. (This\n usage is equivalent to specifying AttributesToGet without any value for\n Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

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

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n
    \n
  • \n

    \n ALL_ATTRIBUTES - Returns all of the item attributes from the\n specified table or index. If you query a local secondary index, then for each\n matching item in the index, DynamoDB fetches the entire item from the parent\n table. If the index is configured to project all item attributes, then all of\n the data can be obtained from the local secondary index, and no fetching is\n required.

    \n
    • \n
  • \n

    \n ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index.\n Retrieves all attributes that have been projected into the index. If the index\n is configured to project all attributes, this return value is equivalent to\n specifying ALL_ATTRIBUTES.

    \n
    • \n
  • \n

    \n COUNT - Returns the number of matching items, rather than the\n matching items themselves.

    \n
    • \n
  • \n

    \n SPECIFIC_ATTRIBUTES - Returns only the attributes listed in\n ProjectionExpression. This return value is equivalent to\n specifying ProjectionExpression without specifying any value for\n Select.

    \n

    If you query or scan a local secondary index and request only attributes that\n are projected into that index, the operation reads only the index and not the\n table. If any of the requested attributes are not projected into the local\n secondary index, DynamoDB fetches each of these attributes from the parent\n table. This extra fetching incurs additional throughput cost and latency.

    \n

    If you query or scan a global secondary index, you can only request attributes\n that are projected into the index. Global secondary index queries cannot fetch\n attributes from the parent table.

    \n
    • \n
\n

If neither Select nor ProjectionExpression are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and ProjectionExpression together in a single\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying ProjectionExpression without any\n value for Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

\n " } }, "ScanFilter": { @@ -7428,7 +7428,7 @@ "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeNames": { @@ -7871,13 +7871,13 @@ "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n collection cannot exceed 10 GB. Each element is composed of:

\n
    \n
  • \n

    \n IndexName - The name of the local secondary index.

    \n
    • \n
  • \n

    \n KeySchema - Specifies the complete index key schema. The attribute\n names in the key schema must be between 1 and 255 characters (inclusive). The\n key schema must begin with the same partition key as the table.

    \n
    • \n
  • \n

    \n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:

    \n
      \n
    • \n

      \n ProjectionType - One of the following:

      \n
        \n
      • \n

        \n KEYS_ONLY - Only the index and primary keys are\n projected into the index.

        \n
        • \n
      • \n

        \n INCLUDE - Only the specified table attributes are\n projected into the index. The list of projected attributes is in\n NonKeyAttributes.

        \n
        • \n
      • \n

        \n ALL - All of the table attributes are projected\n into the index.

        \n
        • \n
      \n
      • \n
    • \n

      \n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 20. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.

      \n
      • \n
    \n
    • \n
  • \n

    \n IndexSizeBytes - Represents the total size of the index, in bytes.\n DynamoDB updates this value approximately every six hours. Recent changes might\n not be reflected in this value.

    \n
    • \n
  • \n

    \n ItemCount - Represents the number of items in the index. DynamoDB\n updates this value approximately every six hours. Recent changes might not be\n reflected in this value.

    \n
    • \n
\n

If the table is in the DELETING state, no information about indexes will\n be returned.

" + "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n collection cannot exceed 10 GB. Each element is composed of:

\n
    \n
  • \n

    \n IndexName - The name of the local secondary index.

    \n
    • \n
  • \n

    \n KeySchema - Specifies the complete index key schema. The attribute\n names in the key schema must be between 1 and 255 characters (inclusive). The\n key schema must begin with the same partition key as the table.

    \n
    • \n
  • \n

    \n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:

    \n
      \n
    • \n

      \n ProjectionType - One of the following:

      \n
        \n
      • \n

        \n KEYS_ONLY - Only the index and primary keys are\n projected into the index.

        \n
        • \n
      • \n

        \n INCLUDE - Only the specified table attributes are\n projected into the index. The list of projected attributes is in\n NonKeyAttributes.

        \n
        • \n
      • \n

        \n ALL - All of the table attributes are projected\n into the index.

        \n
        • \n
      \n
      • \n
    • \n

      \n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.

      \n
      • \n
    \n
    • \n
  • \n

    \n IndexSizeBytes - Represents the total size of the index, in bytes.\n DynamoDB updates this value approximately every six hours. Recent changes might\n not be reflected in this value.

    \n
    • \n
  • \n

    \n ItemCount - Represents the number of items in the index. DynamoDB\n updates this value approximately every six hours. Recent changes might not be\n reflected in this value.

    \n
    • \n
\n

If the table is in the DELETING state, no information about indexes will\n be returned.

" } }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:

\n
    \n
  • \n

    \n Backfilling - If true, then the index is currently in the\n backfilling phase. Backfilling occurs only when a new global secondary index is\n added to the table. It is the process by which DynamoDB populates the new index\n with data from the table. (This attribute does not appear for indexes that were\n created during a CreateTable operation.)

    \n

    You can delete an index that is being created during the\n Backfilling phase when IndexStatus is set to\n CREATING and Backfilling is true. You can't delete the index that\n is being created when IndexStatus is set to CREATING and\n Backfilling is false. (This attribute does not appear for\n indexes that were created during a CreateTable operation.)

    \n
    • \n
  • \n

    \n IndexName - The name of the global secondary index.

    \n
    • \n
  • \n

    \n IndexSizeBytes - The total size of the global secondary index, in\n bytes. DynamoDB updates this value approximately every six hours. Recent changes\n might not be reflected in this value.

    \n
    • \n
  • \n

    \n IndexStatus - The current status of the global secondary\n index:

    \n
      \n
    • \n

      \n CREATING - The index is being created.

      \n
      • \n
    • \n

      \n UPDATING - The index is being updated.

      \n
      • \n
    • \n

      \n DELETING - The index is being deleted.

      \n
      • \n
    • \n

      \n ACTIVE - The index is ready for use.

      \n
      • \n
    \n
    • \n
  • \n

    \n ItemCount - The number of items in the global secondary index.\n DynamoDB updates this value approximately every six hours. Recent changes might\n not be reflected in this value.

    \n
    • \n
  • \n

    \n KeySchema - Specifies the complete index key schema. The attribute\n names in the key schema must be between 1 and 255 characters (inclusive). The\n key schema must begin with the same partition key as the table.

    \n
    • \n
  • \n

    \n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:

    \n
      \n
    • \n

      \n ProjectionType - One of the following:

      \n
        \n
      • \n

        \n KEYS_ONLY - Only the index and primary keys are\n projected into the index.

        \n
        • \n
      • \n

        \n INCLUDE - In addition to the attributes described\n in KEYS_ONLY, the secondary index will include\n other non-key attributes that you specify.

        \n
        • \n
      • \n

        \n ALL - All of the table attributes are projected\n into the index.

        \n
        • \n
      \n
      • \n
    • \n

      \n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 20. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.

      \n
      • \n
    \n
    • \n
  • \n

    \n ProvisionedThroughput - The provisioned throughput settings for the\n global secondary index, consisting of read and write capacity units, along with\n data about increases and decreases.

    \n
    • \n
\n

If the table is in the DELETING state, no information about indexes will\n be returned.

" + "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:

\n
    \n
  • \n

    \n Backfilling - If true, then the index is currently in the\n backfilling phase. Backfilling occurs only when a new global secondary index is\n added to the table. It is the process by which DynamoDB populates the new index\n with data from the table. (This attribute does not appear for indexes that were\n created during a CreateTable operation.)

    \n

    You can delete an index that is being created during the\n Backfilling phase when IndexStatus is set to\n CREATING and Backfilling is true. You can't delete the index that\n is being created when IndexStatus is set to CREATING and\n Backfilling is false. (This attribute does not appear for\n indexes that were created during a CreateTable operation.)

    \n
    • \n
  • \n

    \n IndexName - The name of the global secondary index.

    \n
    • \n
  • \n

    \n IndexSizeBytes - The total size of the global secondary index, in\n bytes. DynamoDB updates this value approximately every six hours. Recent changes\n might not be reflected in this value.

    \n
    • \n
  • \n

    \n IndexStatus - The current status of the global secondary\n index:

    \n
      \n
    • \n

      \n CREATING - The index is being created.

      \n
      • \n
    • \n

      \n UPDATING - The index is being updated.

      \n
      • \n
    • \n

      \n DELETING - The index is being deleted.

      \n
      • \n
    • \n

      \n ACTIVE - The index is ready for use.

      \n
      • \n
    \n
    • \n
  • \n

    \n ItemCount - The number of items in the global secondary index.\n DynamoDB updates this value approximately every six hours. Recent changes might\n not be reflected in this value.

    \n
    • \n
  • \n

    \n KeySchema - Specifies the complete index key schema. The attribute\n names in the key schema must be between 1 and 255 characters (inclusive). The\n key schema must begin with the same partition key as the table.

    \n
    • \n
  • \n

    \n Projection - Specifies attributes that are copied (projected) from\n the table into the index. These are in addition to the primary key attributes\n and index key attributes, which are automatically projected. Each attribute\n specification is composed of:

    \n
      \n
    • \n

      \n ProjectionType - One of the following:

      \n
        \n
      • \n

        \n KEYS_ONLY - Only the index and primary keys are\n projected into the index.

        \n
        • \n
      • \n

        \n INCLUDE - In addition to the attributes described\n in KEYS_ONLY, the secondary index will include\n other non-key attributes that you specify.

        \n
        • \n
      • \n

        \n ALL - All of the table attributes are projected\n into the index.

        \n
        • \n
      \n
      • \n
    • \n

      \n NonKeyAttributes - A list of one or more non-key attribute\n names that are projected into the secondary index. The total count of\n attributes provided in NonKeyAttributes, summed across all\n of the secondary indexes, must not exceed 100. If you project the same\n attribute into two different indexes, this counts as two distinct\n attributes when determining the total.

      \n
      • \n
    \n
    • \n
  • \n

    \n ProvisionedThroughput - The provisioned throughput settings for the\n global secondary index, consisting of read and write capacity units, along with\n data about increases and decreases.

    \n
    • \n
\n

If the table is in the DELETING state, no information about indexes will\n be returned.

" } }, "StreamSpecification": { @@ -7981,7 +7981,7 @@ } }, "traits": { - "smithy.api#documentation": "

A source table with the name TableName does not currently exist within\n the subscriber's account.

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

A source table with the name TableName does not currently exist within\n the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

", "smithy.api#error": "client" } }, @@ -8068,6 +8068,9 @@ "input": { "target": "com.amazonaws.dynamodb#TagResourceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.dynamodb#InternalServerError" @@ -8447,7 +8450,7 @@ } }, "traits": { - "smithy.api#documentation": "

The entire transaction request was canceled.

\n

DynamoDB cancels a TransactWriteItems request under the following\n circumstances:

\n
    \n
  • \n

    A condition in one of the condition expressions is not met.

    \n
    • \n
  • \n

    A table in the TransactWriteItems request is in a different\n account or region.

    \n
    • \n
  • \n

    More than one action in the TransactWriteItems operation\n targets the same item.

    \n
    • \n
  • \n

    There is insufficient provisioned capacity for the transaction to be\n completed.

    \n
    • \n
  • \n

    An item size becomes too large (larger than 400 KB), or a local secondary\n index (LSI) becomes too large, or a similar validation error occurs because of\n changes made by the transaction.

    \n
    • \n
  • \n

    There is a user error, such as an invalid data format.

    \n
    • \n
\n\n

DynamoDB cancels a TransactGetItems request under the\n following circumstances:

\n
    \n
  • \n

    There is an ongoing TransactGetItems operation that conflicts\n with a concurrent PutItem, UpdateItem,\n DeleteItem or TransactWriteItems request. In this\n case the TransactGetItems operation fails with a\n TransactionCanceledException.

    \n
    • \n
  • \n

    A table in the TransactGetItems request is in a different\n account or region.

    \n
    • \n
  • \n

    There is insufficient provisioned capacity for the transaction to be\n completed.

    \n
    • \n
  • \n

    There is a user error, such as an invalid data format.

    \n
    • \n
\n\n \n

If using Java, DynamoDB lists the cancellation reasons on the\n CancellationReasons property. This property is not set for other\n languages. Transaction cancellation reasons are ordered in the order of requested\n items, if an item has no error it will have NONE code and\n Null message.

\n \n

Cancellation reason codes and possible error messages:

\n
    \n
  • \n

    No Errors:

    \n
      \n
    • \n

      Code: NONE\n

      \n
      • \n
    • \n

      Message: null\n

      \n
      • \n
    \n
    • \n
  • \n

    Conditional Check Failed:

    \n
      \n
    • \n

      Code: ConditionalCheckFailed\n

      \n
      • \n
    • \n

      Message: The conditional request failed.

      \n
      • \n
    \n
    • \n
  • \n

    Item Collection Size Limit Exceeded:

    \n
      \n
    • \n

      Code: ItemCollectionSizeLimitExceeded\n

      \n
      • \n
    • \n

      Message: Collection size exceeded.

      \n
      • \n
    \n
    • \n
  • \n

    Transaction Conflict:

    \n
      \n
    • \n

      Code: TransactionConflict\n

      \n
      • \n
    • \n

      Message: Transaction is ongoing for the item.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned Throughput Exceeded:

    \n
      \n
    • \n

      Code: ProvisionedThroughputExceeded\n

      \n
      • \n
    • \n

      Messages:

      \n
        \n
      • \n

        The level of configured provisioned throughput for the\n table was exceeded. Consider increasing your provisioning level\n with the UpdateTable API.

        \n \n

        This Message is received when provisioned throughput is\n exceeded is on a provisioned DynamoDB\n table.

        \n         \n
        • \n
      • \n

        The level of configured provisioned throughput for one or\n more global secondary indexes of the table was exceeded.\n Consider increasing your provisioning level for the\n under-provisioned global secondary indexes with the UpdateTable\n API.

        \n \n

        This message is returned when provisioned throughput is\n exceeded is on a provisioned GSI.

        \n         \n
        • \n
      \n\n
      • \n
    \n
    • \n
  • \n

    Throttling Error:

    \n
      \n
    • \n

      Code: ThrottlingError\n

      \n
      • \n
    • \n

      Messages:

      \n
        \n
      • \n

        Throughput exceeds the current capacity of your table or\n index. DynamoDB is automatically scaling your table or\n index so please try again shortly. If exceptions persist, check\n if you have a hot key:\n https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.

        \n \n

        This message is returned when writes get throttled on an\n On-Demand table as DynamoDB is automatically\n scaling the table.

        \n         \n
        • \n
      • \n

        Throughput exceeds the current capacity for one or more\n global secondary indexes. DynamoDB is automatically\n scaling your index so please try again shortly.

        \n \n

        This message is returned when when writes get throttled on\n an On-Demand GSI as DynamoDB is automatically\n scaling the GSI.

        \n         \n
        • \n
      \n\n
      • \n
    \n
    • \n
  • \n

    Validation Error:

    \n
      \n
    • \n

      Code: ValidationError\n

      \n
      • \n
    • \n

      Messages:

      \n
        \n
      • \n

        One or more parameter values were invalid.

        \n
        • \n
      • \n

        The update expression attempted to update the secondary\n index key beyond allowed size limits.

        \n
        • \n
      • \n

        The update expression attempted to update the secondary\n index key to unsupported type.

        \n
        • \n
      • \n

        An operand in the update expression has an incorrect data\n type.

        \n
        • \n
      • \n

        Item size to update has exceeded the maximum allowed\n size.

        \n
        • \n
      • \n

        Number overflow. Attempting to store a number with\n magnitude larger than supported range.

        \n
        • \n
      • \n

        Type mismatch for attribute to update.

        \n
        • \n
      • \n

        Nesting Levels have exceeded supported limits.

        \n
        • \n
      • \n

        The document path provided in the update expression is\n invalid for update.

        \n
        • \n
      • \n

        The provided expression refers to an attribute that does\n not exist in the item.

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

The entire transaction request was canceled.

\n

DynamoDB cancels a TransactWriteItems request under the following\n circumstances:

\n
    \n
  • \n

    A condition in one of the condition expressions is not met.

    \n
    • \n
  • \n

    A table in the TransactWriteItems request is in a different\n account or region.

    \n
    • \n
  • \n

    More than one action in the TransactWriteItems operation\n targets the same item.

    \n
    • \n
  • \n

    There is insufficient provisioned capacity for the transaction to be\n completed.

    \n
    • \n
  • \n

    An item size becomes too large (larger than 400 KB), or a local secondary\n index (LSI) becomes too large, or a similar validation error occurs because of\n changes made by the transaction.

    \n
    • \n
  • \n

    There is a user error, such as an invalid data format.

    \n
    • \n
\n\n

DynamoDB cancels a TransactGetItems request under the\n following circumstances:

\n
    \n
  • \n

    There is an ongoing TransactGetItems operation that conflicts\n with a concurrent PutItem, UpdateItem,\n DeleteItem or TransactWriteItems request. In this\n case the TransactGetItems operation fails with a\n TransactionCanceledException.

    \n
    • \n
  • \n

    A table in the TransactGetItems request is in a different\n account or region.

    \n
    • \n
  • \n

    There is insufficient provisioned capacity for the transaction to be\n completed.

    \n
    • \n
  • \n

    There is a user error, such as an invalid data format.

    \n
    • \n
\n\n \n

If using Java, DynamoDB lists the cancellation reasons on the\n CancellationReasons property. This property is not set for other\n languages. Transaction cancellation reasons are ordered in the order of requested\n items, if an item has no error it will have None code and\n Null message.

\n \n

Cancellation reason codes and possible error messages:

\n
    \n
  • \n

    No Errors:

    \n
      \n
    • \n

      Code: None\n

      \n
      • \n
    • \n

      Message: null\n

      \n
      • \n
    \n
    • \n
  • \n

    Conditional Check Failed:

    \n
      \n
    • \n

      Code: ConditionalCheckFailed\n

      \n
      • \n
    • \n

      Message: The conditional request failed.

      \n
      • \n
    \n
    • \n
  • \n

    Item Collection Size Limit Exceeded:

    \n
      \n
    • \n

      Code: ItemCollectionSizeLimitExceeded\n

      \n
      • \n
    • \n

      Message: Collection size exceeded.

      \n
      • \n
    \n
    • \n
  • \n

    Transaction Conflict:

    \n
      \n
    • \n

      Code: TransactionConflict\n

      \n
      • \n
    • \n

      Message: Transaction is ongoing for the item.

      \n
      • \n
    \n
    • \n
  • \n

    Provisioned Throughput Exceeded:

    \n
      \n
    • \n

      Code: ProvisionedThroughputExceeded\n

      \n
      • \n
    • \n

      Messages:

      \n
        \n
      • \n

        The level of configured provisioned throughput for the\n table was exceeded. Consider increasing your provisioning level\n with the UpdateTable API.

        \n \n

        This Message is received when provisioned throughput is\n exceeded is on a provisioned DynamoDB\n table.

        \n         \n
        • \n
      • \n

        The level of configured provisioned throughput for one or\n more global secondary indexes of the table was exceeded.\n Consider increasing your provisioning level for the\n under-provisioned global secondary indexes with the UpdateTable\n API.

        \n \n

        This message is returned when provisioned throughput is\n exceeded is on a provisioned GSI.

        \n         \n
        • \n
      \n\n
      • \n
    \n
    • \n
  • \n

    Throttling Error:

    \n
      \n
    • \n

      Code: ThrottlingError\n

      \n
      • \n
    • \n

      Messages:

      \n
        \n
      • \n

        Throughput exceeds the current capacity of your table or\n index. DynamoDB is automatically scaling your table or\n index so please try again shortly. If exceptions persist, check\n if you have a hot key:\n https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.

        \n \n

        This message is returned when writes get throttled on an\n On-Demand table as DynamoDB is automatically\n scaling the table.

        \n         \n
        • \n
      • \n

        Throughput exceeds the current capacity for one or more\n global secondary indexes. DynamoDB is automatically\n scaling your index so please try again shortly.

        \n \n

        This message is returned when when writes get throttled on\n an On-Demand GSI as DynamoDB is automatically\n scaling the GSI.

        \n         \n
        • \n
      \n\n
      • \n
    \n
    • \n
  • \n

    Validation Error:

    \n
      \n
    • \n

      Code: ValidationError\n

      \n
      • \n
    • \n

      Messages:

      \n
        \n
      • \n

        One or more parameter values were invalid.

        \n
        • \n
      • \n

        The update expression attempted to update the secondary\n index key beyond allowed size limits.

        \n
        • \n
      • \n

        The update expression attempted to update the secondary\n index key to unsupported type.

        \n
        • \n
      • \n

        An operand in the update expression has an incorrect data\n type.

        \n
        • \n
      • \n

        Item size to update has exceeded the maximum allowed\n size.

        \n
        • \n
      • \n

        Number overflow. Attempting to store a number with\n magnitude larger than supported range.

        \n
        • \n
      • \n

        Type mismatch for attribute to update.

        \n
        • \n
      • \n

        Nesting Levels have exceeded supported limits.

        \n
        • \n
      • \n

        The document path provided in the update expression is\n invalid for update.

        \n
        • \n
      • \n

        The provided expression refers to an attribute that does\n not exist in the item.

        \n
        • \n
      \n\n
      • \n
    \n
    • \n
", "smithy.api#error": "client" } }, @@ -8480,6 +8483,9 @@ "input": { "target": "com.amazonaws.dynamodb#UntagResourceInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.dynamodb#InternalServerError" @@ -8652,7 +8658,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the status for contributor insights for a specific table or index. CloudWatch\n Contributor Insights for DynamoDB graphs display the partition key and (if applicable)\n sort key of frequently accessed items and frequently throttled items in plaintext. If\n you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s\n partition key and sort key data with an Amazon Web Services managed key or customer managed key, you\n should not enable CloudWatch Contributor Insights for DynamoDB for this table.

" + "smithy.api#documentation": "

Updates the status for contributor insights for a specific table or index. CloudWatch\n Contributor Insights for DynamoDB graphs display the partition key and (if applicable)\n sort key of frequently accessed items and frequently throttled items in plaintext. If\n you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this\n table’s partition key and sort key data with an Amazon Web Services managed key or\n customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB\n for this table.

" } }, "com.amazonaws.dynamodb#UpdateContributorInsightsInput": { @@ -9104,7 +9110,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

\n

You can only perform one of the following operations at once:

\n
    \n
  • \n

    Modify the provisioned throughput settings of the table.

    \n
    • \n
  • \n

    Enable or disable DynamoDB Streams on the table.

    \n
    • \n
  • \n

    Remove a global secondary index from the table.

    \n
    • \n
  • \n

    Create a new global secondary index on the table. After the index begins\n backfilling, you can use UpdateTable to perform other\n operations.

    \n
    • \n
\n

\n UpdateTable is an asynchronous operation; while it is executing, the table\n status changes from ACTIVE to UPDATING. While it is\n UPDATING, you cannot issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.

" + "smithy.api#documentation": "

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

\n

You can only perform one of the following operations at once:

\n
    \n
  • \n

    Modify the provisioned throughput settings of the table.

    \n
    • \n
  • \n

    Remove a global secondary index from the table.

    \n
    • \n
  • \n

    Create a new global secondary index on the table. After the index begins\n backfilling, you can use UpdateTable to perform other\n operations.

    \n
    • \n
\n

\n UpdateTable is an asynchronous operation; while it is executing, the table\n status changes from ACTIVE to UPDATING. While it is\n UPDATING, you cannot issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.

" } }, "com.amazonaws.dynamodb#UpdateTableInput": { diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index 3ba777c84..70860006f 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -10506,7 +10506,7 @@ "target": "com.amazonaws.ec2#CreateCustomerGatewayResult" }, "traits": { - "smithy.api#documentation": "

Provides information to Amazon Web Services about your VPN customer gateway device. The\n customer gateway is the appliance at your end of the VPN connection. (The device on the\n Amazon Web Services side of the VPN connection is the virtual private gateway.) You\n must provide the internet-routable IP address of the customer gateway's external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

" + "smithy.api#documentation": "

Provides information to Amazon Web Services about your customer gateway device. The\n customer gateway device is the appliance at your end of the VPN connection. You\n must provide the IP address of the customer gateway device’s external\n interface. The IP address must be static and can be behind a device performing network\n address translation (NAT).

\n

For devices that use Border Gateway Protocol (BGP), you can also provide the device's\n BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network.\n If you don't have an ASN already, you can use a private ASN. For more information, see \n Customer gateway \n options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.

\n

To create more than one customer gateway with the same VPN type, IP address, and\n BGP ASN, specify a unique device name for each customer gateway. An identical request\n returns information about the existing customer gateway; it doesn't create a new customer\n gateway.

" } }, "com.amazonaws.ec2#CreateCustomerGatewayRequest": { @@ -10522,8 +10522,7 @@ "PublicIp": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Internet-routable IP address for the customer gateway's outside interface. The\n address must be static.

", - "smithy.api#xmlName": "IpAddress" + "smithy.api#documentation": "

\n This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The\n address must be static.

" } }, "CertificateArn": { @@ -10552,6 +10551,12 @@ "smithy.api#documentation": "

A name for the customer gateway device.

\n

Length Constraints: Up to 255 characters.

" } }, + "IpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

\n IPv4 address for the customer gateway device's outside interface. The address must be static.\n

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -15679,7 +15684,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

The Internet-routable IP address of the customer gateway's outside interface.

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

The IP address of the customer gateway device's outside interface.

", "smithy.api#xmlName": "ipAddress" } }, @@ -20616,7 +20621,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n bgp-asn - The customer gateway's Border Gateway Protocol (BGP)\n Autonomous System Number (ASN).

    \n
    • \n
  • \n

    \n customer-gateway-id - The ID of the customer gateway.

    \n
    • \n
  • \n

    \n ip-address - The IP address of the customer gateway's\n Internet-routable external interface.

    \n
    • \n
  • \n

    \n state - The state of the customer gateway (pending |\n available | deleting |\n deleted).

    \n
    • \n
  • \n

    \n type - The type of customer gateway. Currently, the only\n supported type is ipsec.1.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

One or more filters.

\n
    \n
  • \n

    \n bgp-asn - The customer gateway's Border Gateway Protocol (BGP)\n Autonomous System Number (ASN).

    \n
    • \n
  • \n

    \n customer-gateway-id - The ID of the customer gateway.

    \n
    • \n
  • \n

    \n ip-address - The IP address of the customer gateway\n device's external interface.

    \n
    • \n
  • \n

    \n state - The state of the customer gateway (pending |\n available | deleting |\n deleted).

    \n
    • \n
  • \n

    \n type - The type of customer gateway. Currently, the only\n supported type is ipsec.1.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", "smithy.api#xmlName": "Filter" } }, @@ -80109,6 +80114,22 @@ "smithy.api#xmlName": "remoteIpv6NetworkCidr" } }, + "OutsideIpAddressType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutsideIpAddressType", + "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

", + "smithy.api#xmlName": "outsideIpAddressType" + } + }, + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "TransportTransitGatewayAttachmentId", + "smithy.api#documentation": "

The transit gateway attachment ID in use for the VPN tunnel.

", + "smithy.api#xmlName": "transportTransitGatewayAttachmentId" + } + }, "TunnelInsideIpVersion": { "target": "com.amazonaws.ec2#TunnelInsideIpVersion", "traits": { @@ -80182,6 +80203,18 @@ "traits": { "smithy.api#documentation": "

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

\n

Default: ::/0\n

" } + }, + "OutsideIpAddressType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The type of IPv4 address assigned to the outside interface of the customer gateway device.

\n

Valid values: PrivateIpv4 | PublicIpv4\n

\n

Default: PublicIpv4\n

" + } + }, + "TransportTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "

The transit gateway attachment ID to use for the VPN tunnel.

\n

Required if OutsideIpAddressType is set to PrivateIpv4.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/ecs.json b/aws/sdk/aws-models/ecs.json index 4dafab903..ed8f13a32 100644 --- a/aws/sdk/aws-models/ecs.json +++ b/aws/sdk/aws-models/ecs.json @@ -86,7 +86,7 @@ "name": "ecs" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Elastic Container Service\n\t\t

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes\n\t\t\tit easy to run, stop, and manage Docker containers on a cluster. You can host your\n\t\t\tcluster on a serverless infrastructure that's managed by Amazon ECS by launching your\n\t\t\tservices or tasks on Fargate. For more control, you can host your tasks on a cluster\n\t\t\tof Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.

\n\t\t

Amazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls. This makes it easy to get the state of your cluster from a centralized service,\n\t\t\tand gives you access to many familiar Amazon EC2 features.

\n\t\t

You can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. With Amazon ECS, you\n\t\t\tdon't need to operate your own cluster management and configuration management systems.\n\t\t\tYou also don't need to worry about scaling your management infrastructure.

", + "smithy.api#documentation": "Amazon Elastic Container Service\n\t\t

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes\n\t\t\tit easy to run, stop, and manage Docker containers. You can host your cluster on a\n\t\t\tserverless infrastructure that's managed by Amazon ECS by launching your services or tasks on\n\t\t\tFargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)\n\t\t\tor External (on-premises) instances that you manage.

\n\t\t

Amazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls. This makes it easy to get the state of your cluster from a centralized service,\n\t\t\tand gives you access to many familiar Amazon EC2 features.

\n\t\t

You can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. With Amazon ECS, you\n\t\t\tdon't need to operate your own cluster management and configuration management systems.\n\t\t\tYou also don't need to worry about scaling your management infrastructure.

", "smithy.api#title": "Amazon EC2 Container Service", "smithy.api#xmlNamespace": { "uri": "http://ecs.amazonaws.com/doc/2014-11-13/" @@ -369,7 +369,7 @@ } }, "traits": { - "smithy.api#documentation": "

An attribute is a name-value pair that's associated with an Amazon ECS object. Use attributes\n\t\t\tto extend the Amazon ECS data model by adding custom metadata to your resources.\n\t\t\tFor more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

An attribute is a name-value pair that's associated with an Amazon ECS object. Use\n\t\t\tattributes to extend the Amazon ECS data model by adding custom metadata to your resources.\n\t\t\tFor more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#AttributeLimitExceededException": { @@ -694,7 +694,7 @@ "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the Amazon Web Services account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the cluster. For more information about the ARN\n\t\t\tformat, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" } }, "clusterName": { @@ -772,13 +772,13 @@ "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "

The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe Auto Scaling plan that's created is returned as a cluster attachment.

" + "smithy.api#documentation": "

The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe capacity provider and associated resources are returned as cluster\n\t\t\tattachments.

" } }, "attachmentsStatus": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that are returned.

\n\t\t
\n
UPDATE_IN_PROGRESS
\n
\n\t\t\t\t\t

The available capacity providers for the cluster are updating. This occurs\n\t\t\t\t\t\twhen the Auto Scaling plan is provisioning or deprovisioning.

\n\t\t\t\t
\n
UPDATE_COMPLETE
\n
\n\t\t\t\t\t

The capacity providers have successfully updated.

\n\t\t\t\t
\n
UPDATE_FAILED
\n
\n\t\t\t\t\t

The capacity provider updates failed.

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

The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that are returned.

\n\t\t
\n
UPDATE_IN_PROGRESS
\n
\n\t\t\t\t\t

The available capacity providers for the cluster are updating.

\n\t\t\t\t
\n
UPDATE_COMPLETE
\n
\n\t\t\t\t\t

The capacity providers have successfully updated.

\n\t\t\t\t
\n
UPDATE_FAILED
\n
\n\t\t\t\t\t

The capacity provider updates failed.

\n\t\t\t\t
\n
" } } }, @@ -1127,7 +1127,7 @@ "memory": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the Create a container section of the\n\t\t\tDocker Remote API and the --memory option to docker run.

\n\t\t

If using the Fargate launch type, this parameter is optional.

\n\t\t

If using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.

\n\t\t

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of\n\t\t\tmemory for a container, so you should not specify fewer than 6 MiB of\n\t\t\tmemory for your containers.

\n\t\t

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB\n\t\t\tof memory for a container, so you should not specify fewer than 4 MiB of\n\t\t\tmemory for your containers.

" + "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the Create a container section of the\n\t\t\tDocker Remote API and the --memory option to docker run.

\n\t\t

If using the Fargate launch type, this parameter is optional.

\n\t\t

If using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.

\n\t\t

The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 6 MiB of memory for your containers.

\n\t\t

The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a\n\t\t\tcontainer. So, don't specify less than 4 MiB of memory for your containers.

" } }, "memoryReservation": { @@ -1217,7 +1217,7 @@ "stopTimeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.

\n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t
    \n
  • \n\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Windows platform version 1.0.0 or later.

    \n\t\t\t
    • \n
\n\t\t

The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.

\n\t\t

For tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to use a container stop\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.

\n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t
    \n
  • \n\t\t\t\t

    Linux platform version 1.3.0 or later.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Windows platform version 1.0.0 or later.

    \n\t\t\t
    • \n
\n\t\t

The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.

\n\t\t

For tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to use a container stop timeout\n\t\t\tvalue. However, we recommend using the latest container agent version. For information\n\t\t\tabout checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide. If you're using an Amazon ECS-optimized Linux AMI, your\n\t\t\tinstance needs at least version 1.26.0-1 of the ecs-init package. If your\n\t\t\tcontainer instances are launched from version 20190301 or later, then they\n\t\t\tcontain the required versions of the container agent and ecs-init. For more\n\t\t\tinformation, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "hostname": { @@ -1379,7 +1379,7 @@ "containerInstanceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the container instance. For more information about the ARN format,\n\t\t\tsee Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" } }, "ec2InstanceId": { @@ -1421,7 +1421,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.

\n\t\t

If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.

\n\t\t

The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks aren't placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container Instance Draining in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.

\n\t\t

If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.

\n\t\t

The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks aren't placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container instance draining in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "statusReason": { @@ -1433,7 +1433,7 @@ "agentConnected": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

This parameter returns true if the agent is connected to Amazon ECS.\n\t\t\tRegistered instances with an agent that may be unhealthy or stopped return\n\t\t\t\tfalse. Only instances connected to an agent can accept placement\n\t\t\trequests.

" + "smithy.api#documentation": "

This parameter returns true if the agent is connected to Amazon ECS. An\n\t\t\tinstance with an agent that may be unhealthy or stopped return false. Only\n\t\t\tinstances connected to an agent can accept task placement requests.

" } }, "runningTasksCount": { @@ -1469,7 +1469,7 @@ "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "

The resources attached to a container instance, such as elastic network\n\t\t\tinterfaces.

" + "smithy.api#documentation": "

The resources attached to a container instance, such as an elastic network\n\t\t\tinterface.

" } }, "tags": { @@ -1486,7 +1486,7 @@ } }, "traits": { - "smithy.api#documentation": "

An EC2 instance that's running the Amazon ECS agent and has been registered with a\n\t\t\tcluster.

" + "smithy.api#documentation": "

An Amazon EC2 or External instance that's running the Amazon ECS agent and has been registered\n\t\t\twith a cluster.

" } }, "com.amazonaws.ecs#ContainerInstanceField": { @@ -1772,7 +1772,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.

\n\t\t \n\t\t\t

When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the IAM user\n\t\t\t\tthat makes the call doesn't have permissions to create the service-linked role, it\n\t\t\t\tisn't created. For more information, see Using\n\t\t\t\t\tService-Linked Roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

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

Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.

\n\t\t \n\t\t\t

When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the IAM user\n\t\t\t\tthat makes the call doesn't have permissions to create the service-linked role, it\n\t\t\t\tisn't created. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t " } }, "com.amazonaws.ecs#CreateClusterRequest": { @@ -1862,7 +1862,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.

\n\t\t

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

\n\t\t

There are two service scheduler strategies available:

\n\t\t
    \n
  • \n\t\t\t\t

    \n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

    \n\t\t\t
    • \n
\n\t\t

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n\t\t

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n\t\t

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n\t\t

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n\t\t

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster using the following logic:

\n\t\t
    \n
  • \n\t\t\t\t

    Determine which of the container instances in your cluster can support the\n\t\t\t\t\ttask definition of your service. For example, they have the required CPU,\n\t\t\t\t\tmemory, ports, and container instance attributes.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner. This is the case even if you can choose a\n\t\t\t\t\tdifferent placement strategy with the placementStrategy\n\t\t\t\t\tparameter.

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      Sort the valid container instances, giving priority to instances that\n\t\t\t\t\t\t\thave the fewest number of running tasks for this service in their\n\t\t\t\t\t\t\trespective Availability Zone. For example, if zone A has one running\n\t\t\t\t\t\t\tservice task and zones B and C each have zero, valid container instances\n\t\t\t\t\t\t\tin either zone B or C are considered optimal for placement.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      Place the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone based on the previous steps, favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.

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

Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.

\n\t\t

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.

\n\t\t

There are two service scheduler strategies available:

\n\t\t
    \n
  • \n\t\t\t\t

    \n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

    \n\t\t\t
    • \n
\n\t\t

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n\t\t

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n\t\t

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n\t\t

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n\t\t

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster using the following logic:

\n\t\t
    \n
  • \n\t\t\t\t

    Determine which of the container instances in your cluster can support the\n\t\t\t\t\ttask definition of your service. For example, they have the required CPU,\n\t\t\t\t\tmemory, ports, and container instance attributes.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner. This is the case even if you can choose a\n\t\t\t\t\tdifferent placement strategy with the placementStrategy\n\t\t\t\t\tparameter.

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      Sort the valid container instances, giving priority to instances that\n\t\t\t\t\t\t\thave the fewest number of running tasks for this service in their\n\t\t\t\t\t\t\trespective Availability Zone. For example, if zone A has one running\n\t\t\t\t\t\t\tservice task and zones B and C each have zero, valid container instances\n\t\t\t\t\t\t\tin either zone B or C are considered optimal for placement.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      Place the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone based on the previous steps, favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.

      \n\t\t\t\t\t
      • \n
    \n\t\t\t
    • \n
" } }, "com.amazonaws.ecs#CreateServiceRequest": { @@ -1890,7 +1890,7 @@ "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.

\n\t\t

If you use the CODE_DEPLOY deployment controller, these values can be changed\n\t\t\twhen updating the service.

\n\t\t

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.

\n\t\t

For Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted. When\n\t\t\ta task from this service is placed on a container instance, the container instance is\n\t\t\tregistered with the load balancer that's specified here.

\n\t\t

Services with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.

" + "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service load balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.

\n\t\t

If you use the CODE_DEPLOY deployment controller, these values can be\n\t\t\tchanged when updating the service.

\n\t\t

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.

\n\t\t

For Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted.\n\t\t\tWhen a task from this service is placed on a container instance, the container instance\n\t\t\tis registered with the load balancer that's specified here.

\n\t\t

Services with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.

" } }, "serviceRegistries": { @@ -1962,7 +1962,7 @@ "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only used when your\n\t\t\tservice is configured to use a load balancer. If your service has a load balancer\n\t\t\tdefined and you don't specify a health check grace period value, the default value of\n\t\t\t\t0 is used.

\n\t\t

If you do not use an Elastic Load Balancing, we recomend that you use the startPeriod in the task definition healtch check parameters. For more information, see Health check.

\n\t\t

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to\n\t\t\t2,147,483,647\n\t\t\tseconds (about 69 years). During that time, the Amazon ECS service\n\t\t\tscheduler ignores health check status. This grace period can prevent the service\n\t\t\tscheduler from marking tasks as unhealthy and stopping them before they have time to\n\t\t\tcome up.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only used when your\n\t\t\tservice is configured to use a load balancer. If your service has a load balancer\n\t\t\tdefined and you don't specify a health check grace period value, the default value of\n\t\t\t\t0 is used.

\n\t\t

If you do not use an Elastic Load Balancing, we recomend that you use the startPeriod in\n\t\t\tthe task definition healtch check parameters. For more information, see Health\n\t\t\t\tcheck.

\n\t\t

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to\n\t\t\t2,147,483,647\n\t\t\tseconds (about 69 years). During that time, the Amazon ECS service\n\t\t\tscheduler ignores health check status. This grace period can prevent the service\n\t\t\tscheduler from marking tasks as unhealthy and stopping them before they have time to\n\t\t\tcome up.

" } }, "schedulingStrategy": { @@ -1986,7 +1986,7 @@ "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging your Amazon ECS\n\t\t\t\tresources in the Amazon Elastic Container Service Developer Guide.

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

Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL deployment controller type. For more information, see\n\t\t\t\tAmazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL deployment controller type. For more information, see\n\t\t\t\tAmazon ECS deployment\n\t\t\t\ttypes in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#CreateTaskSetRequest": { @@ -2103,13 +2103,13 @@ "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "

The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.

" + "smithy.api#documentation": "

The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.

" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The launch type that new tasks in the task set uses. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" + "smithy.api#documentation": "

The launch type that new tasks in the task set uses. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

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

Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\tEXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#DeleteTaskSetRequest": { @@ -2624,7 +2624,7 @@ "enable": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether to use the deployment circuit breaker logic for the\n\t\t\tservice.

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

Determines whether to use the deployment circuit breaker logic for the service.

", "smithy.api#required": {} } }, @@ -2637,7 +2637,7 @@ } }, "traits": { - "smithy.api#documentation": "\n\t\t\t

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type that aren't behind a Classic Load Balancer.

\n\t\t \n\t\t

The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If enabled, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also configure Amazon ECS to roll back your service to the last completed deployment after a\n\t\t\tfailure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.

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

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type that aren't behind a Classic Load Balancer.

\n\t\t \n\t\t

The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If enabled, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also configure Amazon ECS to roll back your service to the last completed deployment\n\t\t\tafter a failure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#DeploymentConfiguration": { @@ -2652,13 +2652,13 @@ "maximumPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximum percent parameter represents an upper limit\n\t\t\ton the number of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded down to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to define the deployment batch\n\t\t\tsize. For example, if your service has a desired number of four tasks and a maximum\n\t\t\tpercent value of 200%, the scheduler may start four new tasks before stopping the four\n\t\t\tolder tasks (provided that the cluster resources required to do this are available). The\n\t\t\tdefault value for maximum percent is 200%.

\n\t\t

If a service is using the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and tasks that use the EC2\n\t\t\tlaunch type, the maximum percent value is set to the\n\t\t\tdefault value and is used to define the upper limit on the number of the tasks in the\n\t\t\tservice that remain in the RUNNING state while the container instances are\n\t\t\tin the DRAINING state. If the tasks in the service use the\n\t\t\tFargate launch type, the maximum percent value is not used, although it is\n\t\t\treturned when describing your service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tmaximumPercent parameter represents an upper limit on the number of\n\t\t\tyour service's tasks that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the\n\t\t\t\tdesiredCount (rounded down to the nearest integer). This parameter\n\t\t\tenables you to define the deployment batch size. For example, if your service is using\n\t\t\tthe REPLICA service scheduler and has a desiredCount of four\n\t\t\ttasks and a maximumPercent value of 200%, the scheduler may start four new\n\t\t\ttasks before stopping the four older tasks (provided that the cluster resources required\n\t\t\tto do this are available). The default maximumPercent value for a service\n\t\t\tusing the REPLICA service scheduler is 200%.

\n\t\t

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and tasks that use the EC2\n\t\t\tlaunch type, the maximum percent value is set to the\n\t\t\tdefault value and is used to define the upper limit on the number of the tasks in the\n\t\t\tservice that remain in the RUNNING state while the container instances are\n\t\t\tin the DRAINING state. If the tasks in the service use the\n\t\t\tFargate launch type, the maximum percent value is not used, although it is\n\t\t\treturned when describing your service.

" } }, "minimumHealthyPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimum healthy percent represents a lower limit on\n\t\t\tthe number of tasks in a service that must remain in the RUNNING state\n\t\t\tduring a deployment, as a percentage of the desired number of tasks (rounded up to the\n\t\t\tnearest integer), and while any container instances are in the DRAINING\n\t\t\tstate if the service contains tasks using the EC2 launch type. This\n\t\t\tparameter enables you to deploy without using additional cluster capacity. For example,\n\t\t\tif your service has a desired number of four tasks and a minimum healthy percent of 50%,\n\t\t\tthe scheduler may stop two existing tasks to free up cluster capacity before starting\n\t\t\ttwo new tasks. Tasks for services that do not use a load balancer\n\t\t\tare considered healthy if they're in the RUNNING state; tasks for services\n\t\t\tthat do use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state and they're reported as healthy by the load balancer. The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n\t\t

If a service is using the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and tasks that use the EC2\n\t\t\tlaunch type, the minimum healthy percent value is set\n\t\t\tto the default value and is used to define the lower limit on the number of the tasks in\n\t\t\tthe service that remain in the RUNNING state while the container instances\n\t\t\tare in the DRAINING state. If the tasks in the service use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimumHealthyPercent represents a lower limit on the number of your\n\t\t\tservice's tasks that must remain in the RUNNING state during a deployment,\n\t\t\tas a percentage of the desiredCount (rounded up to the nearest integer).\n\t\t\tThis parameter enables you to deploy without using additional cluster capacity. For\n\t\t\texample, if your service has a desiredCount of four tasks and a\n\t\t\t\tminimumHealthyPercent of 50%, the service scheduler may stop two\n\t\t\texisting tasks to free up cluster capacity before starting two new tasks.

\n\t\t

For services that do not use a load balancer, the following\n\t\t\tshould be noted:

\n\t\t
    \n
  • \n\t\t\t\t

    A service is considered healthy if all essential containers within the tasks\n\t\t\t\t\tin the service pass their health checks.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for 40 seconds after a task reaches a RUNNING\n\t\t\t\t\tstate before the task is counted towards the minimum healthy percent\n\t\t\t\t\ttotal.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If a task has one or more essential containers with a health check defined,\n\t\t\t\t\tthe service scheduler will wait for the task to reach a healthy status before\n\t\t\t\t\tcounting it towards the minimum healthy percent total. A task is considered\n\t\t\t\t\thealthy when all essential containers within the task have passed their health\n\t\t\t\t\tchecks. The amount of time the service scheduler can wait for is determined by\n\t\t\t\t\tthe container health check settings.

    \n\t\t\t
    • \n
\n\t\t

For services are that do use a load balancer, the following\n\t\t\tshould be noted:

\n\t\t
    \n
  • \n\t\t\t\t

    If a task has no essential containers with a health check defined, the service\n\t\t\t\t\tscheduler will wait for the load balancer target group health check to return a\n\t\t\t\t\thealthy status before counting the task towards the minimum healthy percent\n\t\t\t\t\ttotal.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If a task has an essential container with a health check defined, the service\n\t\t\t\t\tscheduler will wait for both the task to reach a healthy status and the load\n\t\t\t\t\tbalancer target group health check to return a healthy status before counting\n\t\t\t\t\tthe task towards the minimum healthy percent total.

    \n\t\t\t
    • \n
\n\t\t

If a service is using either the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and is running tasks that use the\n\t\t\tEC2 launch type, the minimum healthy\n\t\t\t\tpercent value is set to the default value and is used to define the lower\n\t\t\tlimit on the number of the tasks in the service that remain in the RUNNING\n\t\t\tstate while the container instances are in the DRAINING state. If a service\n\t\t\tis using either the blue/green (CODE_DEPLOY) or EXTERNAL\n\t\t\tdeployment types and is running tasks that use the Fargate launch type,\n\t\t\tthe minimum healthy percent value is not used, although it is returned when describing\n\t\t\tyour service.

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

The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The deployment controller to use for the service. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#DeploymentControllerType": { @@ -2763,7 +2763,7 @@ "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container instance ID or full ARN of the container instance to deregister.\n\t\t\tThe ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

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

The container instance ID or full ARN of the container instance to deregister. For\n\t\t\tmore information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

", "smithy.api#required": {} } }, @@ -3080,6 +3080,51 @@ } ], "minDelay": 15 + }, + "ServicesStable": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "failures[].reason", + "expected": "MISSING", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "services[].status", + "expected": "DRAINING", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "services[].status", + "expected": "INACTIVE", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0`", + "expected": "true", + "comparator": "booleanEquals" + } + } + } + ], + "minDelay": 15 } } } @@ -3292,7 +3337,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a specified task or tasks.

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

Describes a specified task or tasks.

\n\t\t

Currently, stopped tasks appear in the returned results for at least one hour.

", "smithy.waiters#waitable": { "TasksRunning": { "acceptors": [ @@ -3491,7 +3536,7 @@ "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container instance ID or full ARN of the container instance.\n\t\t\tThe ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" + "smithy.api#documentation": "

The container instance ID or full ARN of the container instance. For more\n\t\t\tinformation about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" } }, "cluster": { @@ -3575,13 +3620,13 @@ "accessPointId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration must either be omitted or set\n\t\t\tto / which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration. For more information, see Working with Amazon\n\t\t\t\tEFS Access Points in the Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration must either be omitted or set\n\t\t\tto / which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration. For more information, see Working with Amazon\n\t\t\t\tEFS access points in the Amazon Elastic File System User Guide.

" } }, "iam": { "target": "com.amazonaws.ecs#EFSAuthorizationConfigIAM", "traits": { - "smithy.api#documentation": "

Determines whether to use the Amazon ECS task IAM role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration. If this parameter is omitted, the default value\n\t\t\tof DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Determines whether to use the Amazon ECS task IAM role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration. If this parameter is omitted, the default value\n\t\t\tof DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS access points in the Amazon Elastic Container Service Developer Guide.

" } } }, @@ -3638,13 +3683,13 @@ "transitEncryption": { "target": "com.amazonaws.ecs#EFSTransitEncryption", "traits": { - "smithy.api#documentation": "

Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS\n\t\t\thost and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization\n\t\t\tis used. If this parameter is omitted, the default value of DISABLED is\n\t\t\tused. For more information, see Encrypting Data in Transit in\n\t\t\tthe Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is\n\t\t\tused. If this parameter is omitted, the default value of DISABLED is used.\n\t\t\tFor more information, see Encrypting data in transit in\n\t\t\tthe Amazon Elastic File System User Guide.

" } }, "transitEncryptionPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n\t\t\tserver. If you do not specify a transit encryption port, it will use the port selection\n\t\t\tstrategy that the Amazon EFS mount helper uses. For more information, see EFS Mount\n\t\t\t\tHelper in the Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n\t\t\tserver. If you do not specify a transit encryption port, it will use the port selection\n\t\t\tstrategy that the Amazon EFS mount helper uses. For more information, see EFS mount\n\t\t\t\thelper in the Amazon Elastic File System User Guide.

" } }, "authorizationConfig": { @@ -3655,7 +3700,7 @@ } }, "traits": { - "smithy.api#documentation": "

This parameter is specified when you're using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS Volumes in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

This parameter is specified when you're using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS volumes in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#EnvironmentFile": { @@ -3715,7 +3760,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate using Linux\n\t\t\t\tplatform version 1.4.0 or later. This parameter is not supported for\n\t\t\t\tWindows containers on Fargate.

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate using\n\t\t\t\tLinux platform version 1.4.0 or later. This parameter is not supported\n\t\t\t\tfor Windows containers on Fargate.

\n\t\t " } }, "com.amazonaws.ecs#ExecuteCommand": { @@ -3747,7 +3792,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs a command remotely on a container within a task.

" + "smithy.api#documentation": "

Runs a command remotely on a container within a task.

\n\t\t

If you use a condition key in your IAM policy to refine the conditions for the policy\n\t\t\tstatement, for example limit the actions to a specific cluster, you recevie an\n\t\t\t\tAccessDeniedException when there is a mismatch between the condition\n\t\t\tkey value and the corresponding parameter value.

" } }, "com.amazonaws.ecs#ExecuteCommandConfiguration": { @@ -3918,7 +3963,7 @@ "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The authorization credential option to use. The authorization credential options can\n\t\t\tbe provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM\n\t\t\tParameter Store parameter. The ARNs refer to the stored credentials.

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

The authorization credential option to use. The authorization credential options can\n\t\t\tbe provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM Parameter Store\n\t\t\tparameter. The ARN refers to the stored credentials.

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

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon Elastic\n\t\t\t\tContainer Service API Reference.

\n\t\t

For more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon ECS API\n\t\t\t\tReference.

\n\t\t

For more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration": { @@ -3960,7 +4005,7 @@ } }, "traits": { - "smithy.api#documentation": "

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.

\n\t\t

For more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.

\n\t\t

For more information and the input format, see Amazon FSx for Windows File Server volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#Failure": { @@ -4008,12 +4053,12 @@ "options": { "target": "com.amazonaws.ecs#FirelensConfigurationOptionsMap", "traits": { - "smithy.api#documentation": "

The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n\t\t\tFor more information, see Creating\n\t\t\t\ta Task Definition that Uses a FireLens Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

Tasks hosted on Fargate only support the file configuration file\n\t\t\t\ttype.

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

The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}.\n\t\t\tFor more information, see Creating\n\t\t\t\ta task definition that uses a FireLens configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

Tasks hosted on Fargate only support the file configuration file\n\t\t\t\ttype.

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

The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom Log Routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom log routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#FirelensConfigurationOptionsMap": { @@ -4082,7 +4127,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).

\n\t\t \n\t\t\t

The Amazon ECS container agent only monitors and reports on the health\n\t\t\t\tchecks specified in the task definition. Amazon ECS does not monitor\n\t\t\t\tDocker health checks that are embedded in a container image and not\n\t\t\t\tspecified in the container definition. Health check parameters that\n\t\t\t\tare specified in a container definition override any Docker health\n\t\t\t\tchecks that exist in the container image.

\n\t\t \n\t\t

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n\t\t

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n\t\t
    \n
  • \n\t\t\t\t

    \n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNHEALTHY-The container health check has failed.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNKNOWN-The container health check is being evaluated or\n\t\t\t\t\tthere's no container health check defined.

    \n\t\t\t
    • \n
\n\t\t

The following describes the possible healthStatus values for a task. The\n\t\t\tcontainer health check status of nonessential containers do not have an effect on the\n\t\t\thealth status of a task.

\n\t\t
    \n
  • \n\t\t\t\t

    \n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNKNOWN-The essential containers within the task are still\n\t\t\t\t\thaving their health checks evaluated or there are no container health checks\n\t\t\t\t\tdefined.

    \n\t\t\t
    • \n
\n\t\t

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n\t\t

The following are notes about container health check support:

\n\t\t
    \n
  • \n\t\t\t\t

    Container health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS Container Agent.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more information, see Fargate\n\t\t\t\t\t\tPlatform Versions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.

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

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).

\n\t\t \n\t\t\t

The Amazon ECS container agent only monitors and reports on the health checks specified\n\t\t\t\tin the task definition. Amazon ECS does not monitor Docker health checks that are\n\t\t\t\tembedded in a container image and not specified in the container definition. Health\n\t\t\t\tcheck parameters that are specified in a container definition override any Docker\n\t\t\t\thealth checks that exist in the container image.

\n\t\t \n\t\t

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n\t\t

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n\t\t
    \n
  • \n\t\t\t\t

    \n HEALTHY-The container health check has passed\n\t\t\t\t\tsuccessfully.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNHEALTHY-The container health check has failed.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNKNOWN-The container health check is being evaluated or\n\t\t\t\t\tthere's no container health check defined.

    \n\t\t\t
    • \n
\n\t\t

The following describes the possible healthStatus values for a task. The\n\t\t\tcontainer health check status of nonessential containers do not have an effect on the\n\t\t\thealth status of a task.

\n\t\t
    \n
  • \n\t\t\t\t

    \n HEALTHY-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNHEALTHY-One or more essential containers have failed\n\t\t\t\t\ttheir health check.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UNKNOWN-The essential containers within the task are still\n\t\t\t\t\thaving their health checks evaluated or there are no container health checks\n\t\t\t\t\tdefined.

    \n\t\t\t
    • \n
\n\t\t

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n\t\t

The following are notes about container health check support:

\n\t\t
    \n
  • \n\t\t\t\t

    Container health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS container agent.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Container health checks are supported for Fargate tasks if\n\t\t\t\t\tyou're using platform version 1.1.0 or greater. For more\n\t\t\t\t\tinformation, see Fargate\n\t\t\t\t\t\tplatform versions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Container health checks aren't supported for tasks that are part of a service\n\t\t\t\t\tthat's configured to use a Classic Load Balancer.

    \n\t\t\t
    • \n
" } }, "com.amazonaws.ecs#HealthStatus": { @@ -5152,7 +5197,7 @@ "targetGroupArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.

\n\t\t

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a\n\t\t\tClassic Load Balancer, omit the target group ARN.

\n\t\t

For services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering Multiple Target Groups with a Service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.

\n\t\t

For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.

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

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.

\n\t\t

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a\n\t\t\tClassic Load Balancer, omit the target group ARN.

\n\t\t

For services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering multiple target groups with a service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.

\n\t\t

For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/green deployment with CodeDeploy in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.

\n\t\t " } }, "loadBalancerName": { @@ -5175,7 +5220,7 @@ } }, "traits": { - "smithy.api#documentation": "

The load balancer configuration to use with a service or task set.

\n\t\t

For specific notes and restrictions regarding the use of load balancers with services\n\t\t\tand task sets, see the CreateService and CreateTaskSet actions.

\n\t\t

When you add, update, or remove a load balancer configuration, Amazon ECS starts a new deployment\n\t\t\twith the updated Elastic Load Balancing configuration. This causes tasks to register to and deregister\n\t\t\tfrom load balancers.

\n\t\t

We recommend that you verify this on a test environment before you update the Elastic Load Balancing\n\t\t\tconfiguration.

\n\t\t

A service-linked role is required for services that use multiple target groups. For\n\t\t\tmore information, see Service-linked\n\t\t\t\troles in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The load balancer configuration to use with a service or task set.

\n\t\t

For specific notes and restrictions regarding the use of load balancers with services\n\t\t\tand task sets, see the CreateService and CreateTaskSet actions.

\n\t\t

When you add, update, or remove a load balancer configuration, Amazon ECS starts a new\n\t\t\tdeployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and\n\t\t\tderegister from load balancers.

\n\t\t

We recommend that you verify this on a test environment before you update the Elastic Load Balancing\n\t\t\tconfiguration.

\n\t\t

A service-linked role is required for services that use multiple target groups. For\n\t\t\tmore information, see Using\n\t\t\t\tservice-linked roles in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#LoadBalancers": { @@ -5203,7 +5248,7 @@ "secretOptions": { "target": "com.amazonaws.ecs#SecretList", "traits": { - "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The secrets to pass to the log configuration. For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.

" } } }, @@ -5387,7 +5432,7 @@ } }, "traits": { - "smithy.api#documentation": "

The managed scaling settings for the Auto Scaling group capacity provider.

\n\t\t

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.

" + "smithy.api#documentation": "

The managed scaling settings for the Auto Scaling group capacity provider.

\n\t\t

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using managed scaling in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.

" } }, "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod": { @@ -5684,7 +5729,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask Placement Constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If you're using the Fargate launch type, task placement constraints\n\t\t\t\taren't supported.

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

An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask placement constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If you're using the Fargate launch type, task placement constraints\n\t\t\t\taren't supported.

\n\t\t " } }, "com.amazonaws.ecs#PlacementConstraintType": { @@ -5731,7 +5776,7 @@ } }, "traits": { - "smithy.api#documentation": "

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The task placement strategy for a task or service. For more information, see Task placement strategies in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#PlacementStrategyType": { @@ -5931,7 +5976,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n\t\t

If you change the account setting for the root user, the default settings for all of\n\t\t\tthe IAM users and roles that no individual account setting was specified are reset for.\n\t\t\tFor more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource is\n\t\t\tdefined by the opt-in status of the IAM user or role that created the resource. You must\n\t\t\tturn on this setting to use Amazon ECS features such as resource tagging.

\n\t\t

When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When containerInsights is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n\t\t

If you change the account setting for the root user, the default settings for all of\n\t\t\tthe IAM users and roles that no individual account setting was specified are reset for.\n\t\t\tFor more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n\t\t\tis defined by the opt-in status of the IAM user or role that created the resource. You\n\t\t\tmust turn on this setting to use Amazon ECS features such as resource tagging.

\n\t\t

When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When containerInsights is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#PutAccountSettingDefault": { @@ -6007,7 +6052,7 @@ "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n\t\t\tspecify the root user, it modifies the account setting for all IAM users, IAM roles, and\n\t\t\tthe root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.

\n\t\t \n\t\t\t

Federated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.

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

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tyou specify the root user, it modifies the account setting for all IAM users, IAM roles,\n\t\t\tand the root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.

\n\t\t \n\t\t\t

Federated users assume the account setting of the root user and can't have\n\t\t\t\texplicit account settings set for them.

\n\t\t " } } } @@ -6395,7 +6440,7 @@ "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.

\n\t\t \n\t\t\t

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same\n\t\t\t\tRegion as the task that you're launching then you can use either the full ARN or the\n\t\t\t\tname of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the\n\t\t\t\tsecret.

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

The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.

\n\t\t \n\t\t\t

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same\n\t\t\t\tRegion as the task that you're launching then you can use either the full ARN or\n\t\t\t\tthe name of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN\n\t\t\t\tof the secret.

\n\t\t ", "smithy.api#required": {} } } @@ -6565,7 +6610,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new task using the specified task definition.

\n\t\t

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n\t\t

The Amazon ECS API follows an eventual consistency model. This is because of the distributed\n\t\t\tnature of the system supporting the API. This means that the result of an API command\n\t\t\tyou run that affects your Amazon ECS resources might not be immediately visible to all\n\t\t\tsubsequent commands you run. Keep this in mind when you carry out an API command that\n\t\t\timmediately follows a previous API command.

\n\t\t

To manage eventual consistency, you can do the following:

\n\t\t
    \n
  • \n\t\t\t\t

    Confirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Add wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.

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

Starts a new task using the specified task definition.

\n\t\t

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n\t\t

The Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.

\n\t\t

To manage eventual consistency, you can do the following:

\n\t\t
    \n
  • \n\t\t\t\t

    Confirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Add wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.

    \n\t\t\t
    • \n
" } }, "com.amazonaws.ecs#RunTaskRequest": { @@ -6598,7 +6643,7 @@ "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether to use the execute command functionality for the containers in\n\t\t\tthis task. If true, this enables execute command functionality on all\n\t\t\tcontainers in the task.

\n\t\t

If true, then the task definition must have a task role, or you must\n\t\t\tprovide one as an override.

" + "smithy.api#documentation": "

Determines whether to use the execute command functionality for the containers in this\n\t\t\ttask. If true, this enables execute command functionality on all containers\n\t\t\tin the task.

\n\t\t

If true, then the task definition must have a task role, or you must\n\t\t\tprovide one as an override.

" } }, "group": { @@ -6670,7 +6715,7 @@ "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.

\n\t\t

When you create an IAM policy for run-task, you can set the resource to be the latest task definition revision, or a specific revision.

\n\t\t

The full ARN value must match the value that you specified as the Resource of\n\t\t\tthe IAM principal's permissions policy.

\n\t\t

When you specify the policy resource as the latest task definition version (by setting the\n\t\t\t\tResource in the policy to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName),\n\t\t\tthen set this value to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

\n\t\t

When you specify the policy resource as a specific task definition version (by setting the\n\t\t\t\tResource in the policy to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 or\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*),\n\t\t\tthen set this value to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.

\n\t\t

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service\n\t\t\tdeveloper Guide.

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

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.

\n\t\t

When you create an IAM policy for run-task, you can set the resource to be the latest\n\t\t\ttask definition revision, or a specific revision.

\n\t\t

The full ARN value must match the value that you specified as the\n\t\t\t\tResource of the IAM principal's permissions policy.

\n\t\t

When you specify the policy resource as the latest task definition version (by setting\n\t\t\tthe Resource in the policy to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName),\n\t\t\tthen set this value to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

\n\t\t

When you specify the policy resource as a specific task definition version (by setting\n\t\t\tthe Resource in the policy to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1 or\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*),\n\t\t\tthen set this value to\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:1.

\n\t\t

For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service developer Guide.

", "smithy.api#required": {} } } @@ -6699,7 +6744,7 @@ "cpuArchitecture": { "target": "com.amazonaws.ecs#CPUArchitecture", "traits": { - "smithy.api#documentation": "

The CPU architecture.

\n\t\t

You can run your Linux tasks on an ARM-based platform by setting the value to ARM64. This option is avaiable\n\t\t\tfor tasks that run on Linuc Amazon EC2 instance or Linux containers on Fargate.

" + "smithy.api#documentation": "

The CPU architecture.

\n\t\t

You can run your Linux tasks on an ARM-based platform by setting the value to\n\t\t\t\tARM64. This option is avaiable for tasks that run on Linux Amazon EC2\n\t\t\tinstance or Linux containers on Fargate.

" } }, "operatingSystemFamily": { @@ -6787,13 +6832,13 @@ "valueFrom": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The secret to expose to the container. The supported values are either the full ARN of\n\t\t\tthe Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

\n\t\t

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter store) in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If the SSM Parameter Store parameter exists in the same Region as the task\n\t\t\t\tyou're launching, then you can use either the full ARN or name of the parameter. If\n\t\t\t\tthe parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.

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

The secret to expose to the container. The supported values are either the full ARN\n\t\t\tof the Secrets Manager secret or the full ARN of the parameter in the SSM Parameter\n\t\t\tStore.

\n\t\t

For information about the require Identity and Access Management permissions, see Required IAM permissions for Amazon ECS secrets (for Secrets Manager) or Required IAM permissions for Amazon ECS secrets (for Systems Manager Parameter\n\t\t\tstore) in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If the SSM Parameter Store parameter exists in the same Region as the task\n\t\t\t\tyou're launching, then you can use either the full ARN or name of the parameter.\n\t\t\t\tIf the parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.

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

An object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:

\n\t\t
    \n
  • \n\t\t\t\t

    To inject sensitive data into your containers as environment variables, use\n\t\t\t\t\tthe secrets container definition parameter.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    To reference sensitive information in the log configuration of a container,\n\t\t\t\t\tuse the secretOptions container definition parameter.

    \n\t\t\t
    • \n
\n\t\t

For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

An object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:

\n\t\t
    \n
  • \n\t\t\t\t

    To inject sensitive data into your containers as environment variables, use\n\t\t\t\t\tthe secrets container definition parameter.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    To reference sensitive information in the log configuration of a container,\n\t\t\t\t\tuse the secretOptions container definition parameter.

    \n\t\t\t
    • \n
\n\t\t

For more information, see Specifying\n\t\t\t\tsensitive data in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#SecretList": { @@ -6826,7 +6871,7 @@ "serviceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the Amazon Web Services account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

" + "smithy.api#documentation": "

The ARN that identifies the service. For more information about the ARN format,\n\t\t\tsee Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

" } }, "serviceName": { @@ -6970,7 +7015,7 @@ "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { - "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n\t\t

There are two service scheduler strategies available.

\n\t\t
    \n
  • \n\t\t\t\t

    \n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DAEMON-The daemon scheduling strategy deploys exactly one task on each\n\t\t\t\t\tactive container instance. This task meets all of the task placement constraints\n\t\t\t\t\tthat you specify in your cluster. The service scheduler also evaluates the task\n\t\t\t\t\tplacement constraints for running tasks. It stop tasks that don't meet the\n\t\t\t\t\tplacement constraints.

    \n\t\t\t\t \n\t\t\t\t\t

    Fargate tasks don't support the DAEMON\n\t\t\t\t\t\tscheduling strategy.

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

The scheduling strategy to use for the service. For more information, see Services.

\n\t\t

There are two service scheduler strategies available.

\n\t\t
    \n
  • \n\t\t\t\t

    \n REPLICA-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DAEMON-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance. This task meets all of the task\n\t\t\t\t\tplacement constraints that you specify in your cluster. The service scheduler\n\t\t\t\t\talso evaluates the task placement constraints for running tasks. It stop tasks\n\t\t\t\t\tthat don't meet the placement constraints.

    \n\t\t\t\t \n\t\t\t\t\t

    Fargate tasks don't support the DAEMON\n\t\t\t\t\t\tscheduling strategy.

    \n\t\t\t\t     \n\t\t\t
    • \n
" } }, "deploymentController": { @@ -7122,7 +7167,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details for the service registry.

\n\t\t

Each service may be associated with one service registry. Multiple service registries for\n\t\t\teach service are not supported.

\n\t\t

When you add, update, or remove the service registries configuration, Amazon ECS starts a\n\t\t\tnew deployment. New tasks are registered and deregistered to the updated service\n\t\t\tregistry configuration.

" + "smithy.api#documentation": "

The details for the service registry.

\n\t\t

Each service may be associated with one service registry. Multiple service registries\n\t\t\tfor each service are not supported.

\n\t\t

When you add, update, or remove the service registries configuration, Amazon ECS starts a\n\t\t\tnew deployment. New tasks are registered and deregistered to the updated service\n\t\t\tregistry configuration.

" } }, "com.amazonaws.ecs#Services": { @@ -7143,7 +7188,7 @@ "streamUrl": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

A URL\n\t\t\t\t\t\tto the managed agent on the container that the SSM Session Manager client\n\t\t\tuses to send commands and receive output from the container.

" + "smithy.api#documentation": "

A URL to the managed agent on the container that the SSM Session Manager client uses\n\t\t\tto send commands and receive output from the container.

" } }, "tokenValue": { @@ -7841,7 +7886,7 @@ } }, "traits": { - "smithy.api#documentation": "

The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:

\n\t\t
    \n
  • \n

    Incorrect IAM permissions

    \n
    • \n
  • \n

    The SSM agent is not installed or is not running

    \n
    • \n
  • \n

    There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for for Systems Manager Session Manager

    \n
    • \n
\n\t\t\t

For information about how to troubleshoot the\n\t\t\tissues, see Troubleshooting issues with ECS Exec in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

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

The execute command cannot run. This error can be caused by any of the following\n\t\t\tconfiguration issues:

\n\t\t
    \n
  • \n\t\t\t\t

    Incorrect IAM permissions

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The SSM agent is not installed or is not running

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for\n\t\t\t\t\tfor Systems Manager Session Manager

    \n\t\t\t
    • \n
\n\t\t

For information about how to troubleshoot the issues, see Troubleshooting issues with ECS\n\t\t\t\tExec in the Amazon Elastic Container Service Developer Guide.

", "smithy.api#error": "client" } }, @@ -9181,7 +9226,7 @@ } ], "traits": { - "smithy.api#documentation": "\n\t\t\t

Updating the task placement strategies and constraints on an Amazon ECS service remains\n\t\t\t\tin preview and is a Beta Service as defined by and subject to the Beta Service\n\t\t\t\tParticipation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms\n\t\t\t\tapply to your participation in this preview.

\n\t\t \n\t\t

Modifies the parameters of a service.

\n\t\t

For services using the rolling update (ECS) you can update the desired count,\n\t\t\tdeployment configuration, network configuration, load balancers, service registries,\n\t\t\tenable ECS managed tags option, propagate tags option, task placement constraints and\n\t\t\tstrategies, and task definition. When you update any of these parameters, Amazon ECS starts\n\t\t\tnew tasks with the new configuration.

\n\t\t

For services using the blue/green (CODE_DEPLOY) deployment controller, only the\n\t\t\tdesired count, deployment configuration, health check grace period, task placement\n\t\t\tconstraints and strategies, enable ECS managed tags option, and propagate tags can be\n\t\t\tupdated using this API. If the network configuration, platform version, task definition,\n\t\t\tor load balancer need to be updated, create a new CodeDeploy deployment. For more\n\t\t\tinformation, see CreateDeployment in the CodeDeploy API Reference.

\n\t\t

For services using an external deployment controller, you can update only the desired count,\n\t\t\ttask placement constraints and strategies, health check grace period, enable ECS managed\n\t\t\ttags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.

\n\t\t

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n\t\t

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n\t\t \n\t\t\t

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n\t\t \n\t\t

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n\t\t
    \n
  • \n\t\t\t\t

    If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and are reported\n\t\t\t\t\tas healthy by the load balancer.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).

    \n\t\t\t
    • \n
\n\t\t

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n\t\t
    \n
  • \n\t\t\t\t

    Determine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      Sort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      Place the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.

      \n\t\t\t\t\t
      • \n
    \n\t\t\t
    • \n
\n\t\t\n\t\t

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

\n\t\t
    \n
  • \n\t\t\t\t

    Sort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Stop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.

    \n\t\t\t
    • \n
\n\t\t \n\t\t

You must have a service-linked role when you update any of the following service properties.\n\t\t\tIf you specified a custom IAM role when you created the service, Amazon ECS automatically\n\t\t\treplaces the roleARN associated with the service with the ARN of your service-linked\n\t\t\trole. For more information, see Service-linked\n\t\t\t\troles in the Amazon Elastic Container Service Developer Guide.

\n\t\t
    \n
  • \n\t\t\t\t

    \n loadBalancers,\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n serviceRegistries\n

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

Modifies the parameters of a service.

\n\t\t

For services using the rolling update (ECS) you can update the desired\n\t\t\tcount, deployment configuration, network configuration, load balancers, service\n\t\t\tregistries, enable ECS managed tags option, propagate tags option, task placement\n\t\t\tconstraints and strategies, and task definition. When you update any of these\n\t\t\tparameters, Amazon ECS starts new tasks with the new configuration.

\n\t\t

For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, health check grace period, task\n\t\t\tplacement constraints and strategies, enable ECS managed tags option, and propagate tags\n\t\t\tcan be updated using this API. If the network configuration, platform version, task\n\t\t\tdefinition, or load balancer need to be updated, create a new CodeDeploy deployment. For more\n\t\t\tinformation, see CreateDeployment in the CodeDeploy API Reference.

\n\t\t

For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, health check grace period, enable ECS\n\t\t\tmanaged tags option, and propagate tags option, using this API. If the launch type, load\n\t\t\tbalancer, network configuration, platform version, or task definition need to be\n\t\t\tupdated, create a new task set For more information, see CreateTaskSet.

\n\t\t

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n\t\t

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n\t\t \n\t\t\t

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n\t\t \n\t\t

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n\t\t
    \n
  • \n\t\t\t\t

    If minimumHealthyPercent is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that don't use a load balancer are considered healthy if they're in the\n\t\t\t\t\t\tRUNNING state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they're in the RUNNING state and are reported\n\t\t\t\t\tas healthy by the load balancer.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The maximumPercent parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment. You can use it to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).

    \n\t\t\t
    • \n
\n\t\t

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n\t\t
    \n
  • \n\t\t\t\t

    Determine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition. For example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner even though you can choose a different\n\t\t\t\t\tplacement strategy.

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      Sort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      Place the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.

      \n\t\t\t\t\t
      • \n
    \n\t\t\t
    • \n
\n\n\t\t

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

\n\t\t
    \n
  • \n\t\t\t\t

    Sort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Stop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.

    \n\t\t\t
    • \n
\n\t\t \n\t\t\t

You must have a service-linked role when you update any of the following service\n\t\t\t\tproperties. If you specified a custom IAM role when you created the service, Amazon ECS\n\t\t\t\tautomatically replaces the roleARN associated with the service with the ARN of your\n\t\t\t\tservice-linked role. For more information, see Service-linked roles in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    \n loadBalancers,\n

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n serviceRegistries\n

    \n\t\t\t\t
    • \n
\n\t\t " } }, "com.amazonaws.ecs#UpdateServicePrimaryTaskSet": { @@ -9347,13 +9392,13 @@ "enableECSManagedTags": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

\n\t\t

Only tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.

" + "smithy.api#documentation": "

Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

\n\t\t

Only tasks launched after the update will reflect the update. To update the tags on\n\t\t\tall tasks, set forceNewDeployment to true, so that Amazon ECS\n\t\t\tstarts new tasks with the updated tags.

" } }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.

\n\t\t

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with\n\t\t\tthe updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are\n\t\t\trunning.

\n\t\t

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups.\n\t\t\tYou can update from a single target group to multiple target groups and from multiple\n\t\t\ttarget groups to a single target group.

\n\t\t

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using\n\t\t\t\t\t\n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

For services that use the external deployment controller, you can add, update, or remove\n\t\t\tload balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

You can remove existing loadBalancers by passing an empty list.

" + "smithy.api#documentation": "

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.

\n\t\t

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks\n\t\t\twith the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks\n\t\t\tare running.

\n\t\t

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target\n\t\t\tgroups. You can update from a single target group to multiple target groups and from\n\t\t\tmultiple target groups to a single target group.

\n\t\t

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by\n\t\t\tusing \n CreateDeployment\n through CodeDeploy. Note that multiple target groups\n\t\t\tare not supported for blue/green deployments. For more information see Register\n\t\t\t\tmultiple target groups with a service in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

For services that use the external deployment controller, you can add, update, or\n\t\t\tremove load balancers by using CreateTaskSet.\n\t\t\tNote that multiple target groups are not supported for external deployments. For more\n\t\t\tinformation see Register\n\t\t\t\tmultiple target groups with a service in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

You can remove existing loadBalancers by passing an empty list.

" } }, "propagateTags": { @@ -9365,7 +9410,7 @@ "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "

The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.

\n\t\t

When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks\n\t\t\twith the updated service registries configuration, and then stops the old tasks when the\n\t\t\tnew tasks are running.

\n\t\t

You can remove existing serviceRegistries by passing an empty\n\t\t\tlist.

" + "smithy.api#documentation": "

The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.

\n\t\t

When you add, update, or remove the service registries configuration, Amazon ECS starts new\n\t\t\ttasks with the updated service registries configuration, and then stops the old tasks\n\t\t\twhen the new tasks are running.

\n\t\t

You can remove existing serviceRegistries by passing an empty\n\t\t\tlist.

" } } } diff --git a/aws/sdk/aws-models/finspace-data.json b/aws/sdk/aws-models/finspace-data.json index 37d3e54f9..f9bba30c5 100644 --- a/aws/sdk/aws-models/finspace-data.json +++ b/aws/sdk/aws-models/finspace-data.json @@ -48,6 +48,9 @@ }, "version": "2020-07-13", "operations": [ + { + "target": "com.amazonaws.finspacedata#AssociateUserToPermissionGroup" + }, { "target": "com.amazonaws.finspacedata#CreateChangeset" }, @@ -72,6 +75,9 @@ { "target": "com.amazonaws.finspacedata#DisableUser" }, + { + "target": "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroup" + }, { "target": "com.amazonaws.finspacedata#EnableUser" }, @@ -84,6 +90,9 @@ { "target": "com.amazonaws.finspacedata#GetDataView" }, + { + "target": "com.amazonaws.finspacedata#GetPermissionGroup" + }, { "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentials" }, @@ -105,9 +114,15 @@ { "target": "com.amazonaws.finspacedata#ListPermissionGroups" }, + { + "target": "com.amazonaws.finspacedata#ListPermissionGroupsByUser" + }, { "target": "com.amazonaws.finspacedata#ListUsers" }, + { + "target": "com.amazonaws.finspacedata#ListUsersByPermissionGroup" + }, { "target": "com.amazonaws.finspacedata#ResetUserPassword" }, @@ -204,6 +219,83 @@ "target": "com.amazonaws.finspacedata#ApplicationPermission" } }, + "com.amazonaws.finspacedata#AssociateUserToPermissionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#AssociateUserToPermissionGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#AssociateUserToPermissionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.

", + "smithy.api#http": { + "method": "POST", + "uri": "/permission-group/{permissionGroupId}/users/{userId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#AssociateUserToPermissionGroupRequest": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#AssociateUserToPermissionGroupResponse": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.finspacedata#StatusCode", + "traits": { + "smithy.api#documentation": "

The returned status code of the response.

", + "smithy.api#httpResponseCode": {} + } + } + } + }, "com.amazonaws.finspacedata#Boolean": { "type": "boolean", "traits": { @@ -464,7 +556,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.finspacedata#ColumnList": { @@ -1071,7 +1163,7 @@ "s3DestinationExportFileFormat": { "target": "com.amazonaws.finspacedata#ExportFileFormat", "traits": { - "smithy.api#documentation": "

Data view export file format.

\n
    \n
  • \n

    \n PARQUET – Parquet export file format.

    \n
    • \n
  • \n

    \n DELIMITED_TEXT – Delimited text export file format.

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

Dataview export file format.

\n
    \n
  • \n

    \n PARQUET – Parquet export file format.

    \n
    • \n
  • \n

    \n DELIMITED_TEXT – Delimited text export file format.

    \n
    • \n
" } }, "s3DestinationExportFileFormatOptions": { @@ -1324,10 +1416,10 @@ "traits": { "smithy.api#documentation": "Description of a dataset", "smithy.api#length": { - "min": 1, + "min": 0, "max": 1000 }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.finspacedata#DatasetId": { @@ -1644,6 +1736,84 @@ } } }, + "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#ConflictException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a user account from a permission group.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/permission-group/{permissionGroupId}/users/{userId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroupRequest": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.finspacedata#ClientToken", + "traits": { + "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroupResponse": { + "type": "structure", + "members": { + "statusCode": { + "target": "com.amazonaws.finspacedata#StatusCode", + "traits": { + "smithy.api#documentation": "

The returned status code of the response.

", + "smithy.api#httpResponseCode": {} + } + } + } + }, "com.amazonaws.finspacedata#Email": { "type": "string", "traits": { @@ -2227,6 +2397,61 @@ "smithy.api#documentation": "Response for the GetDataset operation" } }, + "com.amazonaws.finspacedata#GetPermissionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#GetPermissionGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#GetPermissionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details of a specific permission group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/permission-group/{permissionGroupId}", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#GetPermissionGroupRequest": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.finspacedata#GetPermissionGroupResponse": { + "type": "structure", + "members": { + "permissionGroup": { + "target": "com.amazonaws.finspacedata#PermissionGroup" + } + } + }, "com.amazonaws.finspacedata#GetProgrammaticAccessCredentials": { "type": "operation", "input": { @@ -2384,7 +2609,7 @@ "type": { "target": "com.amazonaws.finspacedata#UserType", "traits": { - "smithy.api#documentation": "

Indicates the type of user.

\n
    \n
  • \n

    \n SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
\n
    \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.

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

Indicates the type of user.

\n
    \n
  • \n

    \n SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
\n
    \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

    \n
    • \n
" } }, "apiAccess": { @@ -2872,6 +3097,85 @@ } } }, + "com.amazonaws.finspacedata#ListPermissionGroupsByUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#ListPermissionGroupsByUserRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#ListPermissionGroupsByUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the permission groups that are associated with a specific user account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/user/{userId}/permission-groups", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#ListPermissionGroupsByUserRequest": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that indicates where a results page should begin.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspacedata#ResultLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of results per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.finspacedata#ListPermissionGroupsByUserResponse": { + "type": "structure", + "members": { + "permissionGroups": { + "target": "com.amazonaws.finspacedata#PermissionGroupByUserList", + "traits": { + "smithy.api#documentation": "

A list of returned permission groups.

" + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that indicates where a results page should begin.

" + } + } + } + }, "com.amazonaws.finspacedata#ListPermissionGroupsRequest": { "type": "structure", "members": { @@ -2946,6 +3250,85 @@ } } }, + "com.amazonaws.finspacedata#ListUsersByPermissionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.finspacedata#ListUsersByPermissionGroupRequest" + }, + "output": { + "target": "com.amazonaws.finspacedata#ListUsersByPermissionGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.finspacedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.finspacedata#InternalServerException" + }, + { + "target": "com.amazonaws.finspacedata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.finspacedata#ThrottlingException" + }, + { + "target": "com.amazonaws.finspacedata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists details of all the users in a specific permission group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/permission-group/{permissionGroupId}/users", + "code": 200 + } + } + }, + "com.amazonaws.finspacedata#ListUsersByPermissionGroupRequest": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that indicates where a results page should begin.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.finspacedata#ResultLimit", + "traits": { + "smithy.api#documentation": "

The maximum number of results per page.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.finspacedata#ListUsersByPermissionGroupResponse": { + "type": "structure", + "members": { + "users": { + "target": "com.amazonaws.finspacedata#UserByPermissionGroupList", + "traits": { + "smithy.api#documentation": "

Lists details of all users in a specific permission group.

" + } + }, + "nextToken": { + "target": "com.amazonaws.finspacedata#PaginationToken", + "traits": { + "smithy.api#documentation": "

A token that indicates where a results page should begin.

" + } + } + } + }, "com.amazonaws.finspacedata#ListUsersRequest": { "type": "structure", "members": { @@ -2995,10 +3378,7 @@ } }, "com.amazonaws.finspacedata#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#documentation": "Pagination token for list operations" - } + "type": "string" }, "com.amazonaws.finspacedata#PartitionColumnList": { "type": "list", @@ -3058,12 +3438,50 @@ "traits": { "smithy.api#documentation": "

Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.\n

" } + }, + "membershipStatus": { + "target": "com.amazonaws.finspacedata#PermissionGroupMembershipStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of the user account within a permission group.

\n
    \n
  • \n

    \n ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

    \n
    • \n
  • \n

    \n ADDITION_SUCCESS – The user account is successfully added to the permission group.

    \n
    • \n
  • \n

    \n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

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

The structure for a permission group.

" } }, + "com.amazonaws.finspacedata#PermissionGroupByUser": { + "type": "structure", + "members": { + "permissionGroupId": { + "target": "com.amazonaws.finspacedata#PermissionGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the permission group.

" + } + }, + "name": { + "target": "com.amazonaws.finspacedata#PermissionGroupName", + "traits": { + "smithy.api#documentation": "

The name of the permission group.

" + } + }, + "membershipStatus": { + "target": "com.amazonaws.finspacedata#PermissionGroupMembershipStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of the user account within a permission group.

\n
    \n
  • \n

    \n ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

    \n
    • \n
  • \n

    \n ADDITION_SUCCESS – The user account is successfully added to the permission group.

    \n
    • \n
  • \n

    \n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

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

The structure of a permission group associated with a user account.

" + } + }, + "com.amazonaws.finspacedata#PermissionGroupByUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#PermissionGroupByUser" + } + }, "com.amazonaws.finspacedata#PermissionGroupDescription": { "type": "string", "traits": { @@ -3071,7 +3489,7 @@ "min": 1, "max": 4000 }, - "smithy.api#pattern": "\\S", + "smithy.api#pattern": "^[\\s\\S]*$", "smithy.api#sensitive": {} } }, @@ -3091,6 +3509,25 @@ "target": "com.amazonaws.finspacedata#PermissionGroup" } }, + "com.amazonaws.finspacedata#PermissionGroupMembershipStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ADDITION_IN_PROGRESS", + "name": "ADDITION_IN_PROGRESS" + }, + { + "value": "ADDITION_SUCCESS", + "name": "ADDITION_SUCCESS" + }, + { + "value": "REMOVAL_IN_PROGRESS", + "name": "REMOVAL_IN_PROGRESS" + } + ] + } + }, "com.amazonaws.finspacedata#PermissionGroupName": { "type": "string", "traits": { @@ -3249,7 +3686,6 @@ "com.amazonaws.finspacedata#ResultLimit": { "type": "integer", "traits": { - "smithy.api#documentation": "Maximum number of results to be returned as part of a list operation", "smithy.api#range": { "min": 1, "max": 100 @@ -3339,6 +3775,9 @@ "smithy.api#documentation": "Source Parameters of a Changeset" } }, + "com.amazonaws.finspacedata#StatusCode": { + "type": "integer" + }, "com.amazonaws.finspacedata#StringMapKey": { "type": "string", "traits": { @@ -3750,7 +4189,7 @@ "type": { "target": "com.amazonaws.finspacedata#UserType", "traits": { - "smithy.api#documentation": "

The option to indicate the type of user.

\n
    \n
  • \n

    \n SUPER_USER– A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.

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

The option to indicate the type of user.

\n
    \n
  • \n

    \n SUPER_USER– A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

    \n
    • \n
" } }, "firstName": { @@ -3833,7 +4272,7 @@ "type": { "target": "com.amazonaws.finspacedata#UserType", "traits": { - "smithy.api#documentation": "

Indicates the type of user.

\n
    \n
  • \n

    \n SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.

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

Indicates the type of user.

\n
    \n
  • \n

    \n SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

    \n
    • \n
" } }, "apiAccess": { @@ -3883,6 +4322,74 @@ "smithy.api#documentation": "

The details of the user account.

" } }, + "com.amazonaws.finspacedata#UserByPermissionGroup": { + "type": "structure", + "members": { + "userId": { + "target": "com.amazonaws.finspacedata#UserId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the user.

" + } + }, + "status": { + "target": "com.amazonaws.finspacedata#UserStatus", + "traits": { + "smithy.api#documentation": "

The current status of the user account.

\n
    \n
  • \n

    \n CREATING – The user account creation is in progress.

    \n
    • \n
  • \n

    \n ENABLED – The user account is created and is currently active.

    \n
    • \n
  • \n

    \n DISABLED – The user account is currently inactive.

    \n
    • \n
" + } + }, + "firstName": { + "target": "com.amazonaws.finspacedata#FirstName", + "traits": { + "smithy.api#documentation": "

The first name of the user.

" + } + }, + "lastName": { + "target": "com.amazonaws.finspacedata#LastName", + "traits": { + "smithy.api#documentation": "

The last name of the user.

" + } + }, + "emailAddress": { + "target": "com.amazonaws.finspacedata#Email", + "traits": { + "smithy.api#documentation": "

The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

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

Indicates the type of user.

\n
    \n
  • \n

    \n SUPER_USER – A user with permission to all the functionality and data in FinSpace.

    \n
    • \n
  • \n

    \n APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

    \n
    • \n
" + } + }, + "apiAccess": { + "target": "com.amazonaws.finspacedata#ApiAccess", + "traits": { + "smithy.api#documentation": "

Indicates whether the user can access FinSpace API operations.

\n
    \n
  • \n

    \n ENABLED – The user has permissions to use the API operations.

    \n
    • \n
  • \n

    \n DISABLED – The user does not have permissions to use any API operations.

    \n
    • \n
" + } + }, + "apiAccessPrincipalArn": { + "target": "com.amazonaws.finspacedata#RoleArn", + "traits": { + "smithy.api#documentation": "

The IAM ARN identifier that is attached to FinSpace API calls.

" + } + }, + "membershipStatus": { + "target": "com.amazonaws.finspacedata#PermissionGroupMembershipStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of the user account within a permission group.

\n
    \n
  • \n

    \n ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

    \n
    • \n
  • \n

    \n ADDITION_SUCCESS – The user account is successfully added to the permission group.

    \n
    • \n
  • \n

    \n REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

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

The structure of a user account associated with a permission group.

" + } + }, + "com.amazonaws.finspacedata#UserByPermissionGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.finspacedata#UserByPermissionGroup" + } + }, "com.amazonaws.finspacedata#UserId": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/forecast.json b/aws/sdk/aws-models/forecast.json index aea7d4644..6a28c7c60 100644 --- a/aws/sdk/aws-models/forecast.json +++ b/aws/sdk/aws-models/forecast.json @@ -705,7 +705,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports your training data to an Amazon Forecast dataset. You provide the location of your\n training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset\n that you want to import the data to.

\n

You must specify a DataSource object that includes an\n AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy\n of your data and processes it in an internal AWS system. For more information, see Set up\n permissions.

\n

The training data must be in CSV format. The delimiter must be a comma (,).

\n

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3\n bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000\n files.

\n\n\n

Because dataset imports are not aggregated, your most recent dataset import is the one\n that is used when training a predictor or generating a forecast. Make sure that your most\n recent dataset import contains all of the data you want to model off of, and not just the new\n data collected since the previous import.

\n\n\n

To get a list of all your dataset import jobs, filtered by specified criteria, use the\n ListDatasetImportJobs operation.

" + "smithy.api#documentation": "

Imports your training data to an Amazon Forecast dataset. You provide the location of your\n training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset\n that you want to import the data to.

\n

You must specify a DataSource object that includes an\n AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy\n of your data and processes it in an internal AWS system. For more information, see Set up\n permissions.

\n

The training data must be in CSV or Parquet format. The delimiter must be a comma (,).

\n

You can specify the path to a specific file, the S3 bucket, or to a folder in the S3\n bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000\n files.

\n

Because dataset imports are not aggregated, your most recent dataset import is the one\n that is used when training a predictor or generating a forecast. Make sure that your most\n recent dataset import contains all of the data you want to model off of, and not just the new\n data collected since the previous import.

\n

To get a list of all your dataset import jobs, filtered by specified criteria, use the\n ListDatasetImportJobs operation.

" } }, "com.amazonaws.forecast#CreateDatasetImportJobRequest": { @@ -761,6 +761,12 @@ "traits": { "smithy.api#documentation": "

The optional metadata that you apply to the dataset import job to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
    • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
    • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
    • \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
    • \n
" } + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the imported data, CSV or PARQUET. The default value is CSV.

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

Optional metadata to help you categorize and organize your resources. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.

\n

The following restrictions apply to tags:

\n
    \n
  • \n

    For each resource, each tag key must be unique and each tag key must have one\n value.

    \n
    • \n
  • \n

    Maximum number of tags per resource: 50.

    \n
    • \n
  • \n

    Maximum key length: 128 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    Maximum value length: 256 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    Accepted characters: all letters and numbers, spaces representable in UTF-8,\n and + - = . _ : / @. If your tagging schema is used across other services and\n resources, the character restrictions of those services also apply.

    \n
    • \n
  • \n

    Key prefixes cannot include any upper or lowercase combination of\n aws: or AWS:. Values can have this prefix. If a\n tag value has aws as its prefix but the key does not, Forecast\n considers it to be a user tag and will count against the limit of 50 tags. Tags\n with only the key prefix of aws do not count against your tags per\n resource limit. You cannot edit or delete tag keys with this prefix.

    \n
    • \n
" } + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the exported data, CSV or PARQUET.

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

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was\n used to train the predictor. This is known as inference. To retrieve the forecast for a single\n item at low latency, use the operation. To\n export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

\n

The range of the forecast is determined by the ForecastHorizon value, which\n you specify in the CreatePredictor request. When you query a forecast, you\n can request a specific date range within the forecast.

\n

To get a list of all your forecasts, use the ListForecasts\n operation.

\n \n

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was\n used to create the predictor.

\n \n

For more information, see howitworks-forecast.

\n \n

The Status of the forecast must be ACTIVE before you can query\n or export the forecast. Use the DescribeForecast operation to get the\n status.

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

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was\n used to train the predictor. This is known as inference. To retrieve the forecast for a single\n item at low latency, use the operation. To\n export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

\n

The range of the forecast is determined by the ForecastHorizon value, which\n you specify in the CreatePredictor request. When you query a forecast, you\n can request a specific date range within the forecast.

\n

To get a list of all your forecasts, use the ListForecasts\n operation.

\n \n

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was\n used to create the predictor.

\n \n

For more information, see howitworks-forecast.

\n \n

The Status of the forecast must be ACTIVE before you can query\n or export the forecast. Use the DescribeForecast operation to get the\n status.

\n \n

By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor.\n However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

" } }, "com.amazonaws.forecast#CreateForecastExportJob": { @@ -1091,6 +1103,12 @@ "traits": { "smithy.api#documentation": "

The optional metadata that you apply to the forecast export job to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
    • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
    • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
    • \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
    • \n
" } + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the exported data, CSV or PARQUET. The default value is CSV.

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

The optional metadata that you apply to the forecast to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n
    \n
  • \n

    Maximum number of tags per resource - 50.

    \n
    • \n
  • \n

    For each resource, each tag key must be unique, and each tag key can have only one\n value.

    \n
    • \n
  • \n

    Maximum key length - 128 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    Maximum value length - 256 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    If your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.

    \n
    • \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

    Do not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.

    \n
    • \n
" } + }, + "TimeSeriesSelector": { + "target": "com.amazonaws.forecast#TimeSeriesSelector", + "traits": { + "smithy.api#documentation": "

Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

\n

The TimeSeriesIdentifiers object needs the following information:

\n
    \n
  • \n

    \n DataSource\n

    \n
    • \n
  • \n

    \n Format\n

    \n
    • \n
  • \n

    \n Schema\n

    \n
    • \n
" + } } } }, @@ -1267,7 +1291,7 @@ } ], "traits": { - "smithy.api#documentation": "

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two\n folders containing CSV files are exported to your specified S3 bucket.

\n

The export file names will match the following conventions:

\n

\n __.csv\n

\n

The component is in Java SimpleDate format\n (yyyy-MM-ddTHH-mm-ssZ).

\n

You must specify a DataDestination object that includes an Amazon S3\n bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket. For more information, see aws-forecast-iam-roles.

\n \n

The Status of the export job must be ACTIVE before you\n can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

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

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two\n folders containing CSV or Parquet files are exported to your specified S3 bucket.

\n

The export file names will match the following conventions:

\n

\n __.csv\n

\n

The component is in Java SimpleDate format\n (yyyy-MM-ddTHH-mm-ssZ).

\n

You must specify a DataDestination object that includes an Amazon S3\n bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket. For more information, see aws-forecast-iam-roles.

\n \n

The Status of the export job must be ACTIVE before you\n can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

\n " } }, "com.amazonaws.forecast#CreatePredictorBacktestExportJobRequest": { @@ -1298,6 +1322,12 @@ "traits": { "smithy.api#documentation": "

Optional metadata to help you categorize and organize your backtests. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.

\n

The following restrictions apply to tags:

\n
    \n
  • \n

    For each resource, each tag key must be unique and each tag key must have one\n value.

    \n
    • \n
  • \n

    Maximum number of tags per resource: 50.

    \n
    • \n
  • \n

    Maximum key length: 128 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    Maximum value length: 256 Unicode characters in UTF-8.

    \n
    • \n
  • \n

    Accepted characters: all letters and numbers, spaces representable in UTF-8,\n and + - = . _ : / @. If your tagging schema is used across other services and\n resources, the character restrictions of those services also apply.

    \n
    • \n
  • \n

    Key prefixes cannot include any upper or lowercase combination of\n aws: or AWS:. Values can have this prefix. If a\n tag value has aws as its prefix but the key does not, Forecast\n considers it to be a user tag and will count against the limit of 50 tags. Tags\n with only the key prefix of aws do not count against your tags per\n resource limit. You cannot edit or delete tag keys with this prefix.

    \n
    • \n
" } + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the exported data, CSV or PARQUET. The default value is CSV.

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

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
    • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
    • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

    \n
    • \n
" } + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the imported data, CSV or PARQUET.

" + } } } }, @@ -2610,7 +2646,7 @@ "ExplainabilityArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability export.

" } }, "Destination": { @@ -2639,6 +2675,12 @@ "traits": { "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
    • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
    • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

    \n
    • \n
" } + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the exported data, CSV or PARQUET.

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

The last time the resource was modified. The timestamp depends on the status of the job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
    • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
    • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

    \n
    • \n
" } + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the exported data, CSV or PARQUET.

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

The last time the resource was modified. The timestamp depends on the status of the job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
    • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
    • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

    \n
    • \n
" } + }, + "TimeSeriesSelector": { + "target": "com.amazonaws.forecast#TimeSeriesSelector", + "traits": { + "smithy.api#documentation": "

The time series to include in the forecast.

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

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n
    \n
  • \n

    \n CREATE_PENDING - The CreationTime.

    \n
    • \n
  • \n

    \n CREATE_IN_PROGRESS - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPING - The current timestamp.

    \n
    • \n
  • \n

    \n CREATE_STOPPED - When the job stopped.

    \n
    • \n
  • \n

    \n ACTIVE or CREATE_FAILED - When the job finished or\n failed.

    \n
    • \n
" } + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the exported data, CSV or PARQUET.

" + } } } }, @@ -3485,7 +3545,7 @@ "TimeSeriesGranularity": { "target": "com.amazonaws.forecast#TimeSeriesGranularity", "traits": { - "smithy.api#documentation": "

To create an Explainability for all time series in your datasets, use\n ALL. To create an Explainability for specific time series in your datasets,\n use SPECIFIC.

\n

Specify time series by uploading a CSV file to an Amazon S3 bucket and set the location\n within the DataDestination data type.

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

To create an Explainability for all time series in your datasets, use\n ALL. To create an Explainability for specific time series in your datasets,\n use SPECIFIC.

\n

Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location\n within the DataDestination data type.

", "smithy.api#required": {} } }, @@ -3966,6 +4026,16 @@ "target": "com.amazonaws.forecast#ForecastSummary" } }, + "com.amazonaws.forecast#Format": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 7 + }, + "smithy.api#pattern": "^CSV|PARQUET$" + } + }, "com.amazonaws.forecast#Frequency": { "type": "string", "traits": { @@ -6224,6 +6294,40 @@ ] } }, + "com.amazonaws.forecast#TimeSeriesIdentifiers": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.forecast#DataSource" + }, + "Schema": { + "target": "com.amazonaws.forecast#Schema" + }, + "Format": { + "target": "com.amazonaws.forecast#Format", + "traits": { + "smithy.api#documentation": "

The format of the data, either CSV or PARQUET.

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

Details about the import file that contains the time series for which you want to create forecasts.

" + } + }, + "com.amazonaws.forecast#TimeSeriesSelector": { + "type": "structure", + "members": { + "TimeSeriesIdentifiers": { + "target": "com.amazonaws.forecast#TimeSeriesIdentifiers", + "traits": { + "smithy.api#documentation": "

Details about the import file that contains the time series for which you want to create forecasts.

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

Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

\n

The TimeSeriesIdentifiers object needs the following information:

\n
    \n
  • \n

    \n DataSource\n

    \n
    • \n
  • \n

    \n Format\n

    \n
    • \n
  • \n

    \n Schema\n

    \n
    • \n
" + } + }, "com.amazonaws.forecast#TimeZone": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/frauddetector.json b/aws/sdk/aws-models/frauddetector.json index 734b75af6..937f105ab 100644 --- a/aws/sdk/aws-models/frauddetector.json +++ b/aws/sdk/aws-models/frauddetector.json @@ -43,7 +43,7 @@ "name": "frauddetector" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

This is the Amazon Fraud Detector API Reference. This guide is for developers who need\n detailed information about Amazon Fraud Detector API actions, data types, and errors. For\n more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.

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

This is the Amazon Fraud Detector API Reference. This guide is for developers who need\n detailed information about Amazon Fraud Detector API actions, data types, and errors. For\n more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.

\n \n

We provide the Query API as well as AWS software development kits (SDK) for Amazon Fraud Detector in Java and Python programming languages.

\n

The Amazon Fraud Detector Query API provides HTTPS requests that use the HTTP verb GET or POST and a Query parameter Action. AWS SDK provides libraries, \n sample code, tutorials, and other resources for software developers who prefer to build applications using language-specific APIs instead of submitting a request over \n HTTP or HTTPS. These libraries provide basic functions that automatically take care of tasks such as cryptographically signing your requests, retrying requests, and \n handling error responses, so that it is easier for you to get started. For more information about the AWS SDKs, see Tools to build on AWS.\n

", "smithy.api#title": "Amazon Fraud Detector", "smithy.api#xmlNamespace": { "uri": "http://hawksnest.amazonaws.com/doc/2019-11-15" @@ -1505,7 +1505,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes data that was batch imported to Amazon Fraud Detector.

" + "smithy.api#documentation": "

Deletes the specified batch import job ID record. This action does not delete the data that was batch imported.

" } }, "com.amazonaws.frauddetector#DeleteBatchImportJobRequest": { @@ -3756,7 +3756,7 @@ "predictionTimestamp": { "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

\nThe timestamp that defines when the prediction was generated. \n

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

\n The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.

\n

We recommend calling ListEventPredictions\n first, and using the predictionTimestamp value in the response to provide an accurate prediction timestamp value.

", "smithy.api#required": {} } } @@ -3852,7 +3852,7 @@ "predictionTimestamp": { "target": "com.amazonaws.frauddetector#time", "traits": { - "smithy.api#documentation": "

The timestamp that defines when the prediction was generated.\n

" + "smithy.api#documentation": "

The timestamp that defines when the prediction was generated.

" } } } @@ -4119,6 +4119,9 @@ }, "com.amazonaws.frauddetector#GetKMSEncryptionKey": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.frauddetector#GetKMSEncryptionKeyResult" }, @@ -7120,7 +7123,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the status of a model version.

\n

You can perform the following status updates:

\n
    \n
  1. \n

    Change the TRAINING_COMPLETE status to ACTIVE.

    \n
    2. \n
  2. \n

    Change ACTIVE to INACTIVE.

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

Updates the status of a model version.

\n

You can perform the following status updates:

\n
    \n
  1. \n

    Change the TRAINING_IN_PROGRESS status to TRAINING_CANCELLED.

    \n
    2. \n
  2. \n

    Change the TRAINING_COMPLETE status to ACTIVE.

    \n
    3. \n
  3. \n

    Change ACTIVE to INACTIVE.

    \n
    4. \n
" } }, "com.amazonaws.frauddetector#UpdateModelVersionStatusRequest": { diff --git a/aws/sdk/aws-models/guardduty.json b/aws/sdk/aws-models/guardduty.json index d589425b8..f423054f0 100644 --- a/aws/sdk/aws-models/guardduty.json +++ b/aws/sdk/aws-models/guardduty.json @@ -29,6 +29,65 @@ ] }, "shapes": { + "com.amazonaws.guardduty#AcceptAdministratorInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Accepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/administrator", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#AcceptAdministratorInvitationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty member account.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AdministratorId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The account ID of the GuardDuty administrator account whose invitation you're accepting.

", + "smithy.api#jsonName": "administratorId", + "smithy.api#required": {} + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The value that is used to validate the administrator account to the member account.

", + "smithy.api#jsonName": "invitationId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.guardduty#AcceptAdministratorInvitationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.guardduty#AcceptInvitation": { "type": "operation", "input": { @@ -46,6 +105,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use AcceptAdministratorInvitation instead" + }, "smithy.api#documentation": "

Accepts the invitation to be monitored by a GuardDuty administrator account.

", "smithy.api#http": { "method": "POST", @@ -82,11 +144,21 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This input is deprecated, use AcceptAdministratorInvitationRequest instead" + } } }, "com.amazonaws.guardduty#AcceptInvitationResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use AcceptAdministratorInvitationResponse instead" + } + } }, "com.amazonaws.guardduty#AccessControlList": { "type": "structure", @@ -182,6 +254,34 @@ } } }, + "com.amazonaws.guardduty#AccountFreeTrialInfo": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The account identifier of the GuardDuty member account.

", + "smithy.api#jsonName": "accountId" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourcesFreeTrial", + "traits": { + "smithy.api#documentation": "

Describes the data source enabled for the GuardDuty member account.

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

Provides details of the GuardDuty member account that uses a free trial service.

" + } + }, + "com.amazonaws.guardduty#AccountFreeTrialInfos": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AccountFreeTrialInfo" + } + }, "com.amazonaws.guardduty#AccountId": { "type": "string", "traits": { @@ -321,6 +421,51 @@ } } }, + "com.amazonaws.guardduty#Administrator": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the account used as the administrator account.

", + "smithy.api#jsonName": "accountId" + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The value that is used to validate the administrator account to the member account.

", + "smithy.api#jsonName": "invitationId" + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The status of the relationship between the administrator and member accounts.

", + "smithy.api#jsonName": "relationshipStatus" + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The timestamp when the invitation was sent.

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

Contains information about the administrator account and invitation.

" + } + }, + "com.amazonaws.guardduty#AffectedResources": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#String" + } + }, "com.amazonaws.guardduty#ArchiveFindings": { "type": "operation", "input": { @@ -430,6 +575,13 @@ "smithy.api#documentation": "

The details of the Amazon Web Services account that made the API call. This field appears if the call was made from outside your account.

", "smithy.api#jsonName": "remoteAccountDetails" } + }, + "AffectedResources": { + "target": "com.amazonaws.guardduty#AffectedResources", + "traits": { + "smithy.api#documentation": "

The details of the Amazon Web Services account that made the API call. This field identifies the resources that were affected by this API call.

", + "smithy.api#jsonName": "affectedResources" + } } }, "traits": { @@ -1470,6 +1622,21 @@ "smithy.api#documentation": "

Contains information on the status of data sources for the detector.

" } }, + "com.amazonaws.guardduty#DataSourceFreeTrial": { + "type": "structure", + "members": { + "FreeTrialDaysRemaining": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "

A value that specifies the number of days left to use each enabled data source.

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

Contains information about which data sources are enabled for the GuardDuty member account.

" + } + }, "com.amazonaws.guardduty#DataSourceList": { "type": "list", "member": { @@ -1495,6 +1662,49 @@ } } }, + "com.amazonaws.guardduty#DataSourcesFreeTrial": { + "type": "structure", + "members": { + "CloudTrail": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "

Describes whether any AWS CloudTrail management event logs are enabled as data sources.

", + "smithy.api#jsonName": "cloudTrail" + } + }, + "DnsLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "

Describes whether any DNS logs are enabled as data sources.

", + "smithy.api#jsonName": "dnsLogs" + } + }, + "FlowLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "

Describes whether any VPC Flow logs are enabled as data sources.

", + "smithy.api#jsonName": "flowLogs" + } + }, + "S3Logs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "

Describes whether any S3 data event logs are enabled as data sources.

", + "smithy.api#jsonName": "s3Logs" + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#KubernetesDataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "

Describes whether any Kubernetes logs are enabled as data sources.

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

Contains information about which data sources are enabled for the GuardDuty member account.

" + } + }, "com.amazonaws.guardduty#DeclineInvitations": { "type": "operation", "input": { @@ -2247,6 +2457,49 @@ "type": "structure", "members": {} }, + "com.amazonaws.guardduty#DisassociateFromAdministratorAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates the current GuardDuty member account from its administrator account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/administrator/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DisassociateFromAdministratorAccountRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty member account.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.guardduty#DisassociateFromAdministratorAccountResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.guardduty#DisassociateFromMasterAccount": { "type": "operation", "input": { @@ -2264,6 +2517,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use DisassociateFromAdministratorAccount instead" + }, "smithy.api#documentation": "

Disassociates the current GuardDuty member account from its administrator account.

", "smithy.api#http": { "method": "POST", @@ -2284,11 +2540,21 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This input is deprecated, use DisassociateFromAdministratorAccountRequest instead" + } } }, "com.amazonaws.guardduty#DisassociateFromMasterAccountResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use DisassociateFromAdministratorAccountResponse instead" + } + } }, "com.amazonaws.guardduty#DisassociateMembers": { "type": "operation", @@ -2307,7 +2573,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) \n specified by the account IDs. Member accounts added through Invitation get deleted from the \n current GuardDuty administrator account after 30 days of disassociation.

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

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

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/disassociate", @@ -2359,6 +2625,20 @@ "smithy.api#documentation": "

The domain information for the API request.

", "smithy.api#jsonName": "domain" } + }, + "Protocol": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The network connection protocol observed in the activity that prompted GuardDuty to generate the finding.

", + "smithy.api#jsonName": "protocol" + } + }, + "Blocked": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the targeted port is blocked.

", + "smithy.api#jsonName": "blocked" + } } }, "traits": { @@ -2869,6 +3149,58 @@ "smithy.api#documentation": "

Contains information about the location of the remote IP address.

" } }, + "com.amazonaws.guardduty#GetAdministratorAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetAdministratorAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetAdministratorAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the details for the GuardDuty administrator account associated with the current\n GuardDuty member account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/administrator", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetAdministratorAccountRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty member account.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.guardduty#GetAdministratorAccountResponse": { + "type": "structure", + "members": { + "Administrator": { + "target": "com.amazonaws.guardduty#Administrator", + "traits": { + "smithy.api#documentation": "

The administrator account details.

", + "smithy.api#jsonName": "administrator", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.guardduty#GetDetector": { "type": "operation", "input": { @@ -3346,6 +3678,9 @@ } ], "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use GetAdministratorAccount instead" + }, "smithy.api#documentation": "

Provides the details for the GuardDuty administrator account associated with the current\n GuardDuty member account.

", "smithy.api#http": { "method": "GET", @@ -3366,6 +3701,11 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This input is deprecated, use GetAdministratorAccountRequest instead" + } } }, "com.amazonaws.guardduty#GetMasterAccountResponse": { @@ -3379,6 +3719,11 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use GetAdministratorAccountResponse instead" + } } }, "com.amazonaws.guardduty#GetMemberDetectors": { @@ -3517,6 +3862,71 @@ } } }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDays": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the number of days left for each data source used in the free trial period.

", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/freeTrial/daysRemaining", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "

The unique ID of the detector of the GuardDuty member account.

", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "

A list of account identifiers of the GuardDuty member account.

", + "smithy.api#jsonName": "accountIds" + } + } + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse": { + "type": "structure", + "members": { + "Accounts": { + "target": "com.amazonaws.guardduty#AccountFreeTrialInfos", + "traits": { + "smithy.api#documentation": "

The member accounts which were included in a request and were processed successfully.

", + "smithy.api#jsonName": "accounts" + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#documentation": "

The member account that was included in a request but for which the request could not be processed.

", + "smithy.api#jsonName": "unprocessedAccounts" + } + } + } + }, "com.amazonaws.guardduty#GetThreatIntelSet": { "type": "operation", "input": { @@ -3626,7 +4036,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector\n ID. For newly enabled detectors or data sources the cost returned will include only the usage\n so far under 30 days, this may differ from the cost metrics in the console, which projects\n usage over 30 days to provide a monthly cost estimate. For more information see Understanding How Usage Costs are Calculated.

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

Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector\n ID. For newly enabled detectors or data sources, the cost returned will include only the usage\n so far under 30 days. This may differ from the cost metrics in the console, which project\n usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated.

", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/usage/statistics", @@ -3729,11 +4139,14 @@ "name": "guardduty" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following data sources: VPC Flow Logs, Amazon Web Services CloudTrail event logs, and DNS logs. It uses\n threat intelligence feeds (such as lists of malicious IPs and domains) and machine learning to\n identify unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services\n environment. This can include issues like escalations of privileges, uses of exposed\n credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can\n detect compromised EC2 instances that serve malware or mine bitcoin.

\n

GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise. Some examples\n of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region\n that has never been used, or unusual API calls like a password policy change to reduce\n password strength.

\n

GuardDuty informs you of the status of your Amazon Web Services environment by producing security findings\n that you can view in the GuardDuty console or through Amazon CloudWatch events. For more\n information, see the \n Amazon\n GuardDuty User Guide\n .

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

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following data sources: VPC Flow Logs, AWS CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, and DNS logs.\n It uses threat intelligence\n feeds (such as lists of malicious IPs and domains) and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect\n compromised EC2 instances that serve malware or mine bitcoin.

\n

GuardDuty also monitors Amazon Web Services account access behavior for signs of compromise. Some examples\n of this are unauthorized infrastructure deployments such as EC2 instances deployed in a Region\n that has never been used, or unusual API calls like a password policy change to reduce\n password strength.

\n

GuardDuty informs you of the status of your Amazon Web Services environment by producing security findings\n that you can view in the GuardDuty console or through Amazon CloudWatch events. For more\n information, see the \n Amazon\n GuardDuty User Guide\n .

", "smithy.api#title": "Amazon GuardDuty" }, "version": "2017-11-28", "operations": [ + { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitation" + }, { "target": "com.amazonaws.guardduty#AcceptInvitation" }, @@ -3794,6 +4207,9 @@ { "target": "com.amazonaws.guardduty#DisableOrganizationAdminAccount" }, + { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccount" + }, { "target": "com.amazonaws.guardduty#DisassociateFromMasterAccount" }, @@ -3803,6 +4219,9 @@ { "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccount" }, + { + "target": "com.amazonaws.guardduty#GetAdministratorAccount" + }, { "target": "com.amazonaws.guardduty#GetDetector" }, @@ -3830,6 +4249,9 @@ { "target": "com.amazonaws.guardduty#GetMembers" }, + { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDays" + }, { "target": "com.amazonaws.guardduty#GetThreatIntelSet" }, @@ -4413,6 +4835,21 @@ "smithy.api#documentation": "

Describes whether any Kubernetes logs will be enabled as a data source.

" } }, + "com.amazonaws.guardduty#KubernetesDataSourceFreeTrial": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "

Describes whether Kubernetes audit logs are enabled as a data source.

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

Provides details about the Kubernetes resources when it is enabled as a data source.

" + } + }, "com.amazonaws.guardduty#KubernetesDetails": { "type": "structure", "members": { @@ -5440,6 +5877,13 @@ "smithy.api#jsonName": "updatedAt", "smithy.api#required": {} } + }, + "AdministratorId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The administrator account ID.

", + "smithy.api#jsonName": "administratorId" + } } }, "traits": { @@ -5977,14 +6421,14 @@ "target": "com.amazonaws.guardduty#String", "traits": { "smithy.api#documentation": "

The product code information.

", - "smithy.api#jsonName": "code" + "smithy.api#jsonName": "productCodeId" } }, "ProductType": { "target": "com.amazonaws.guardduty#String", "traits": { "smithy.api#documentation": "

The product code type.

", - "smithy.api#jsonName": "productType" + "smithy.api#jsonName": "productCodeType" } } }, @@ -6060,7 +6504,7 @@ "Affiliated": { "target": "com.amazonaws.guardduty#Boolean", "traits": { - "smithy.api#documentation": "

Details on whether the Amazon Web Services account of the remote API caller is related to your GuardDuty environment. If this value is True the API caller is affiliated to your account in some way. If it is False the API caller is from outside your environment.

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

Details on whether the Amazon Web Services account of the remote API caller is related to your GuardDuty environment. If this value is True the API caller is affiliated to your account in some way. If it is False the API caller is from outside your environment.

", "smithy.api#jsonName": "affiliated" } } @@ -6407,12 +6851,41 @@ "smithy.api#documentation": "

Feedback that was submitted about the finding.

", "smithy.api#jsonName": "userFeedback" } + }, + "AdditionalInfo": { + "target": "com.amazonaws.guardduty#ServiceAdditionalInfo", + "traits": { + "smithy.api#documentation": "

Contains additional information about the generated finding.

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

Contains additional information about the generated finding.

" } }, + "com.amazonaws.guardduty#ServiceAdditionalInfo": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

This field specifies the value of the additional information.

", + "smithy.api#jsonName": "value" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

Describes the type of the additional information.

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

Additional information about the generated finding.

" + } + }, "com.amazonaws.guardduty#SortCriteria": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/iam.json b/aws/sdk/aws-models/iam.json index c92430705..e523525ba 100644 --- a/aws/sdk/aws-models/iam.json +++ b/aws/sdk/aws-models/iam.json @@ -717,6 +717,9 @@ "input": { "target": "com.amazonaws.iam#AddClientIDToOpenIDConnectProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -759,6 +762,9 @@ "input": { "target": "com.amazonaws.iam#AddRoleToInstanceProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" @@ -804,6 +810,9 @@ "input": { "target": "com.amazonaws.iam#AddUserToGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -849,6 +858,9 @@ "input": { "target": "com.amazonaws.iam#AttachGroupPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -894,6 +906,9 @@ "input": { "target": "com.amazonaws.iam#AttachRolePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -942,6 +957,9 @@ "input": { "target": "com.amazonaws.iam#AttachUserPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -1030,6 +1048,9 @@ "input": { "target": "com.amazonaws.iam#ChangePasswordRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" @@ -1261,6 +1282,9 @@ "input": { "target": "com.amazonaws.iam#CreateAccountAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" @@ -1779,7 +1803,7 @@ "MaxSessionDuration": { "target": "com.amazonaws.iam#roleMaxSessionDurationType", "traits": { - "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default maximum of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.

\n

Anyone who assumes the role from the or API can use the DurationSeconds\n API parameter or the duration-seconds CLI parameter to request a longer\n session. The MaxSessionDuration setting determines the maximum duration\n that can be requested using the DurationSeconds parameter. If users don't\n specify a value for the DurationSeconds parameter, their security\n credentials are valid for one hour by default. This applies when you use the\n AssumeRole* API operations or the assume-role* CLI\n operations but does not apply when you use those operations to create a console URL. For\n more information, see Using IAM roles in the IAM User Guide.

" + "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default value of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.

\n

Anyone who assumes the role from the or API can use the DurationSeconds\n API parameter or the duration-seconds CLI parameter to request a longer\n session. The MaxSessionDuration setting determines the maximum duration\n that can be requested using the DurationSeconds parameter. If users don't\n specify a value for the DurationSeconds parameter, their security\n credentials are valid for one hour by default. This applies when you use the\n AssumeRole* API operations or the assume-role* CLI\n operations but does not apply when you use those operations to create a console URL. For\n more information, see Using IAM roles in the IAM User Guide.

" } }, "PermissionsBoundary": { @@ -2199,6 +2223,9 @@ "input": { "target": "com.amazonaws.iam#DeactivateMFADeviceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" @@ -2241,6 +2268,9 @@ "input": { "target": "com.amazonaws.iam#DeleteAccessKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -2279,6 +2309,9 @@ "input": { "target": "com.amazonaws.iam#DeleteAccountAliasRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -2308,6 +2341,12 @@ }, "com.amazonaws.iam#DeleteAccountPasswordPolicy": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -2345,6 +2384,9 @@ "input": { "target": "com.amazonaws.iam#DeleteGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" @@ -2368,6 +2410,9 @@ "input": { "target": "com.amazonaws.iam#DeleteGroupPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -2419,6 +2464,9 @@ "input": { "target": "com.amazonaws.iam#DeleteInstanceProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" @@ -2454,6 +2502,9 @@ "input": { "target": "com.amazonaws.iam#DeleteLoginProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" @@ -2489,6 +2540,9 @@ "input": { "target": "com.amazonaws.iam#DeleteOpenIDConnectProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -2521,6 +2575,9 @@ "input": { "target": "com.amazonaws.iam#DeletePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" @@ -2559,6 +2616,9 @@ "input": { "target": "com.amazonaws.iam#DeletePolicyVersionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" @@ -2604,6 +2664,9 @@ "input": { "target": "com.amazonaws.iam#DeleteRoleRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -2633,6 +2696,9 @@ "input": { "target": "com.amazonaws.iam#DeleteRolePermissionsBoundaryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" @@ -2665,6 +2731,9 @@ "input": { "target": "com.amazonaws.iam#DeleteRolePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -2719,6 +2788,9 @@ "input": { "target": "com.amazonaws.iam#DeleteSAMLProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -2754,6 +2826,9 @@ "input": { "target": "com.amazonaws.iam#DeleteSSHPublicKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" @@ -2787,6 +2862,9 @@ "input": { "target": "com.amazonaws.iam#DeleteServerCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" @@ -2869,6 +2947,9 @@ "input": { "target": "com.amazonaws.iam#DeleteServiceSpecificCredentialRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" @@ -2901,6 +2982,9 @@ "input": { "target": "com.amazonaws.iam#DeleteSigningCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -2939,6 +3023,9 @@ "input": { "target": "com.amazonaws.iam#DeleteUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -2965,6 +3052,9 @@ "input": { "target": "com.amazonaws.iam#DeleteUserPermissionsBoundaryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" @@ -2994,6 +3084,9 @@ "input": { "target": "com.amazonaws.iam#DeleteUserPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -3045,6 +3138,9 @@ "input": { "target": "com.amazonaws.iam#DeleteVirtualMFADeviceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#DeleteConflictException" @@ -3132,6 +3228,9 @@ "input": { "target": "com.amazonaws.iam#DetachGroupPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -3174,6 +3273,9 @@ "input": { "target": "com.amazonaws.iam#DetachRolePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -3219,6 +3321,9 @@ "input": { "target": "com.amazonaws.iam#DetachUserPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -3295,6 +3400,9 @@ "input": { "target": "com.amazonaws.iam#EnableMFADeviceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" @@ -3587,6 +3695,9 @@ }, "com.amazonaws.iam#GenerateCredentialReport": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.iam#GenerateCredentialReportResponse" }, @@ -3857,6 +3968,9 @@ }, "com.amazonaws.iam#GetAccountPasswordPolicy": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.iam#GetAccountPasswordPolicyResponse" }, @@ -3889,6 +4003,9 @@ }, "com.amazonaws.iam#GetAccountSummary": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.iam#GetAccountSummaryResponse" }, @@ -3998,6 +4115,9 @@ }, "com.amazonaws.iam#GetCredentialReport": { "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, "output": { "target": "com.amazonaws.iam#GetCredentialReportResponse" }, @@ -8793,6 +8913,9 @@ "input": { "target": "com.amazonaws.iam#PutGroupPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -8842,6 +8965,9 @@ "input": { "target": "com.amazonaws.iam#PutRolePermissionsBoundaryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -8887,6 +9013,9 @@ "input": { "target": "com.amazonaws.iam#PutRolePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -8939,6 +9068,9 @@ "input": { "target": "com.amazonaws.iam#PutUserPermissionsBoundaryRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -8981,6 +9113,9 @@ "input": { "target": "com.amazonaws.iam#PutUserPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -9048,6 +9183,9 @@ "input": { "target": "com.amazonaws.iam#RemoveClientIDFromOpenIDConnectProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -9087,6 +9225,9 @@ "input": { "target": "com.amazonaws.iam#RemoveRoleFromInstanceProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -9129,6 +9270,9 @@ "input": { "target": "com.amazonaws.iam#RemoveUserFromGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -9343,6 +9487,9 @@ "input": { "target": "com.amazonaws.iam#ResyncMFADeviceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidAuthenticationCodeException" @@ -10030,6 +10177,9 @@ "input": { "target": "com.amazonaws.iam#SetDefaultPolicyVersionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -10072,6 +10222,9 @@ "input": { "target": "com.amazonaws.iam#SetSecurityTokenServicePreferencesRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ServiceFailureException" @@ -10439,6 +10592,9 @@ "input": { "target": "com.amazonaws.iam#TagInstanceProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10484,6 +10640,9 @@ "input": { "target": "com.amazonaws.iam#TagMFADeviceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10529,6 +10688,9 @@ "input": { "target": "com.amazonaws.iam#TagOpenIDConnectProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10574,6 +10736,9 @@ "input": { "target": "com.amazonaws.iam#TagPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10619,6 +10784,9 @@ "input": { "target": "com.amazonaws.iam#TagRoleRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10664,6 +10832,9 @@ "input": { "target": "com.amazonaws.iam#TagSAMLProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10709,6 +10880,9 @@ "input": { "target": "com.amazonaws.iam#TagServerCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10754,6 +10928,9 @@ "input": { "target": "com.amazonaws.iam#TagUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10868,6 +11045,9 @@ "input": { "target": "com.amazonaws.iam#UntagInstanceProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10910,6 +11090,9 @@ "input": { "target": "com.amazonaws.iam#UntagMFADeviceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10952,6 +11135,9 @@ "input": { "target": "com.amazonaws.iam#UntagOpenIDConnectProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -10994,6 +11180,9 @@ "input": { "target": "com.amazonaws.iam#UntagPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -11036,6 +11225,9 @@ "input": { "target": "com.amazonaws.iam#UntagRoleRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -11075,6 +11267,9 @@ "input": { "target": "com.amazonaws.iam#UntagSAMLProviderRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -11117,6 +11312,9 @@ "input": { "target": "com.amazonaws.iam#UntagServerCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -11159,6 +11357,9 @@ "input": { "target": "com.amazonaws.iam#UntagUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" @@ -11198,6 +11399,9 @@ "input": { "target": "com.amazonaws.iam#UpdateAccessKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -11243,6 +11447,9 @@ "input": { "target": "com.amazonaws.iam#UpdateAccountPasswordPolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -11325,6 +11532,9 @@ "input": { "target": "com.amazonaws.iam#UpdateAssumeRolePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -11370,6 +11580,9 @@ "input": { "target": "com.amazonaws.iam#UpdateGroupRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" @@ -11417,6 +11630,9 @@ "input": { "target": "com.amazonaws.iam#UpdateLoginProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" @@ -11467,6 +11683,9 @@ "input": { "target": "com.amazonaws.iam#UpdateOpenIDConnectProviderThumbprintRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#InvalidInputException" @@ -11596,7 +11815,7 @@ "MaxSessionDuration": { "target": "com.amazonaws.iam#roleMaxSessionDurationType", "traits": { - "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default maximum of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.

\n

Anyone who assumes the role from the CLI or API can use the\n DurationSeconds API parameter or the duration-seconds CLI\n parameter to request a longer session. The MaxSessionDuration setting\n determines the maximum duration that can be requested using the\n DurationSeconds parameter. If users don't specify a value for the\n DurationSeconds parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole* API operations\n or the assume-role* CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM\n roles in the IAM User Guide.

" + "smithy.api#documentation": "

The maximum session duration (in seconds) that you want to set for the specified role.\n If you do not specify a value for this setting, the default value of one hour is\n applied. This setting can have a value from 1 hour to 12 hours.

\n

Anyone who assumes the role from the CLI or API can use the\n DurationSeconds API parameter or the duration-seconds CLI\n parameter to request a longer session. The MaxSessionDuration setting\n determines the maximum duration that can be requested using the\n DurationSeconds parameter. If users don't specify a value for the\n DurationSeconds parameter, their security credentials are valid for one\n hour by default. This applies when you use the AssumeRole* API operations\n or the assume-role* CLI operations but does not apply when you use those\n operations to create a console URL. For more information, see Using IAM\n roles in the IAM User Guide.

" } } } @@ -11669,6 +11888,9 @@ "input": { "target": "com.amazonaws.iam#UpdateSSHPublicKeyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" @@ -11709,6 +11931,9 @@ "input": { "target": "com.amazonaws.iam#UpdateServerCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#EntityAlreadyExistsException" @@ -11756,6 +11981,9 @@ "input": { "target": "com.amazonaws.iam#UpdateServiceSpecificCredentialRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#NoSuchEntityException" @@ -11795,6 +12023,9 @@ "input": { "target": "com.amazonaws.iam#UpdateSigningCertificateRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#LimitExceededException" @@ -11840,6 +12071,9 @@ "input": { "target": "com.amazonaws.iam#UpdateUserRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.iam#ConcurrentModificationException" diff --git a/aws/sdk/aws-models/iotsitewise.json b/aws/sdk/aws-models/iotsitewise.json index 2e92f0002..242b15219 100644 --- a/aws/sdk/aws-models/iotsitewise.json +++ b/aws/sdk/aws-models/iotsitewise.json @@ -1227,6 +1227,12 @@ "smithy.api#documentation": "

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.iotsitewise#Description", + "traits": { + "smithy.api#documentation": "

A description for the asset.

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

A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

", "smithy.api#required": {} } + }, + "description": { + "target": "com.amazonaws.iotsitewise#Description", + "traits": { + "smithy.api#documentation": "

A description for the asset.

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

A list of key-value pairs that contain metadata for the asset. For more information, see\n Tagging your IoT SiteWise\n resources in the IoT SiteWise User Guide.

" } + }, + "assetDescription": { + "target": "com.amazonaws.iotsitewise#Description", + "traits": { + "smithy.api#documentation": "

A description for the asset.

" + } } } }, @@ -4746,6 +4764,12 @@ "smithy.api#documentation": "

The current status of the asset, which contains a state and any error message.

", "smithy.api#required": {} } + }, + "assetDescription": { + "target": "com.amazonaws.iotsitewise#Description", + "traits": { + "smithy.api#documentation": "

A description for the asset.

" + } } } }, @@ -5483,7 +5507,7 @@ "storageType": { "target": "com.amazonaws.iotsitewise#StorageType", "traits": { - "smithy.api#documentation": "

The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:

\n
    \n
  • \n

    \n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.

    \n
    • \n
  • \n

    \n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.

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

The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:

\n
    \n
  • \n

    \n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.

    \n
    • \n
  • \n

    \n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. \n The cold tier is a customer-managed Amazon S3 bucket.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -8922,7 +8946,7 @@ "storageType": { "target": "com.amazonaws.iotsitewise#StorageType", "traits": { - "smithy.api#documentation": "

The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:

\n
    \n
  • \n

    \n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.

    \n
    • \n
  • \n

    \n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.

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

The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:

\n
    \n
  • \n

    \n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.

    \n
    • \n
  • \n

    \n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. \n The cold tier is a customer-managed Amazon S3 bucket.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -8949,7 +8973,7 @@ "storageType": { "target": "com.amazonaws.iotsitewise#StorageType", "traits": { - "smithy.api#documentation": "

The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:

\n
    \n
  • \n

    \n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.

    \n
    • \n
  • \n

    \n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the cold tier. \n The cold tier is a customer-managed Amazon S3 bucket.

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

The storage tier that you specified for your data. \n The storageType parameter can be one of the following values:

\n
    \n
  • \n

    \n SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. \n The hot tier is a service-managed database.

    \n
    • \n
  • \n

    \n MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. \n The cold tier is a customer-managed Amazon S3 bucket.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -9954,6 +9978,12 @@ "smithy.api#documentation": "

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

", "smithy.api#idempotencyToken": {} } + }, + "assetDescription": { + "target": "com.amazonaws.iotsitewise#Description", + "traits": { + "smithy.api#documentation": "

A description for the asset.

" + } } } }, diff --git a/aws/sdk/aws-models/kafka.json b/aws/sdk/aws-models/kafka.json index a3cc3e0d0..a421b532b 100644 --- a/aws/sdk/aws-models/kafka.json +++ b/aws/sdk/aws-models/kafka.json @@ -297,7 +297,7 @@ "ClientSubnets": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { - "smithy.api#documentation": "

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.

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

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.

", "smithy.api#jsonName": "clientSubnets", "smithy.api#required": {} } @@ -4020,6 +4020,9 @@ "input": { "target": "com.amazonaws.kafka#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" @@ -4177,6 +4180,9 @@ "input": { "target": "com.amazonaws.kafka#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.kafka#BadRequestException" diff --git a/aws/sdk/aws-models/kendra.json b/aws/sdk/aws-models/kendra.json index 777596254..79f5e7958 100644 --- a/aws/sdk/aws-models/kendra.json +++ b/aws/sdk/aws-models/kendra.json @@ -2675,6 +2675,12 @@ "traits": { "smithy.api#documentation": "

Provides the configuration information to connect to Jira as your \n data source.

" } + }, + "GitHubConfiguration": { + "target": "com.amazonaws.kendra#GitHubConfiguration", + "traits": { + "smithy.api#documentation": "

Provides the configuration information to connect to GitHub as \n your data source.

" + } } }, "traits": { @@ -3144,6 +3150,10 @@ { "value": "JIRA", "name": "JIRA" + }, + { + "value": "GITHUB", + "name": "GITHUB" } ] } @@ -4748,7 +4758,7 @@ "Id": { "target": "com.amazonaws.kendra#DocumentId", "traits": { - "smithy.api#documentation": "

A unique identifier of the document in the index.

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

A unique identifier of the document in the index.

\n

Note, each document ID must be unique per index. You cannot create a data source \n to index your documents with their unique IDs and then use the \n BatchPutDocument API to index the same documents, or vice versa. You \n can delete a data source and then use the BatchPutDocument API to index \n the same documents, or vice versa.

", "smithy.api#required": {} } }, @@ -6156,6 +6166,197 @@ } } }, + "com.amazonaws.kendra#GitHubConfiguration": { + "type": "structure", + "members": { + "SaaSConfiguration": { + "target": "com.amazonaws.kendra#SaaSConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information to connect to GitHub Enterprise Cloud (SaaS).

" + } + }, + "OnPremiseConfiguration": { + "target": "com.amazonaws.kendra#OnPremiseConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information to connect to GitHub Enterprise Server (on premises).

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

The type of GitHub service you want to connect to—GitHub Enterprise\n Cloud (SaaS) or GitHub Enterprise Server (on premises).

" + } + }, + "SecretArn": { + "target": "com.amazonaws.kendra#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains\n the key-value pairs required to connect to your GitHub. The secret must contain\n a JSON structure with the following keys:

\n ", + "smithy.api#required": {} + } + }, + "UseChangeLog": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to use the GitHub change log to determine which documents require\n updating in the index. Depending on the GitHub change log's size, it may take longer\n for Amazon Kendra to use the change log than to scan all of your documents in\n GitHub.

" + } + }, + "GitHubDocumentCrawlProperties": { + "target": "com.amazonaws.kendra#GitHubDocumentCrawlProperties", + "traits": { + "smithy.api#documentation": "

Configuration information to include certain types of GitHub content. You can\n configure to index repository files only, or also include issues and pull requests,\n comments, and comment attachments.

" + } + }, + "RepositoryFilter": { + "target": "com.amazonaws.kendra#RepositoryNames", + "traits": { + "smithy.api#documentation": "

A list of names of the specific repositories you want to index.

" + } + }, + "InclusionFolderNamePatterns": { + "target": "com.amazonaws.kendra#StringList", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to include certain folder names in your\n GitHub repository or repositories. Folder names that match the patterns are\n included in the index. Folder names that don't match the patterns are excluded\n from the index. If a folder matches both an inclusion and exclusion pattern, the\n exclusion pattern takes precedence and the folder isn't included in the index.

" + } + }, + "InclusionFileTypePatterns": { + "target": "com.amazonaws.kendra#StringList", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to include certain file types in your\n GitHub repository or repositories. File types that match the patterns are\n included in the index. File types that don't match the patterns are excluded\n from the index. If a file matches both an inclusion and exclusion pattern, the\n exclusion pattern takes precedence and the file isn't included in the index.

" + } + }, + "InclusionFileNamePatterns": { + "target": "com.amazonaws.kendra#StringList", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to include certain file names in your\n GitHub repository or repositories. File names that match the patterns are\n included in the index. File names that don't match the patterns are excluded\n from the index. If a file matches both an inclusion and exclusion pattern, the\n exclusion pattern takes precedence and the file isn't included in the index.

" + } + }, + "ExclusionFolderNamePatterns": { + "target": "com.amazonaws.kendra#StringList", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain folder names in your\n GitHub repository or repositories. Folder names that match the patterns are excluded\n from the index. Folder names that don't match the patterns are included in the index.\n If a folder matches both an exclusion and inclusion pattern, the exclusion pattern\n takes precedence and the folder isn't included in the index.

" + } + }, + "ExclusionFileTypePatterns": { + "target": "com.amazonaws.kendra#StringList", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain file types in your\n GitHub repository or repositories. File types that match the patterns are excluded\n from the index. File types that don't match the patterns are included in the index.\n If a file matches both an exclusion and inclusion pattern, the exclusion pattern\n takes precedence and the file isn't included in the index.

" + } + }, + "ExclusionFileNamePatterns": { + "target": "com.amazonaws.kendra#StringList", + "traits": { + "smithy.api#documentation": "

A list of regular expression patterns to exclude certain file names in your\n GitHub repository or repositories. File names that match the patterns are excluded\n from the index. File names that don't match the patterns are included in the index.\n If a file matches both an exclusion and inclusion pattern, the exclusion pattern\n takes precedence and the file isn't included in the index.

" + } + }, + "VpcConfiguration": { + "target": "com.amazonaws.kendra#DataSourceVpcConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration information of an Amazon Virtual Private Cloud to connect to your\n GitHub. For more information, see Configuring a VPC.

" + } + }, + "GitHubRepositoryConfigurationFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map GitHub\n repository attributes or field names to Amazon Kendra index field names.\n To create custom fields, use the UpdateIndex API before you map to\n GitHub fields. For more information, see Mapping data source fields.\n The GitHub data source field names must exist in your GitHub custom metadata.

" + } + }, + "GitHubCommitConfigurationFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map attributes\n or field names of GitHub commits to Amazon Kendra index field names. \n To create custom fields, use the UpdateIndex API before you map to\n GitHub fields. For more information, see Mapping data source fields.\n The GitHub data source field names must exist in your GitHub custom metadata.

" + } + }, + "GitHubIssueDocumentConfigurationFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map attributes\n or field names of GitHub issues to Amazon Kendra index field names.\n To create custom fields, use the UpdateIndex API before you map to\n GitHub fields. For more information, see Mapping data source fields.\n The GitHub data source field names must exist in your GitHub custom metadata.

" + } + }, + "GitHubIssueCommentConfigurationFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map attributes\n or field names of GitHub issue comments to Amazon Kendra index field names.\n To create custom fields, use the UpdateIndex API before you map to\n GitHub fields. For more information, see Mapping data source fields.\n The GitHub data source field names must exist in your GitHub custom metadata.

" + } + }, + "GitHubIssueAttachmentConfigurationFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map attributes\n or field names of GitHub issue attachments to Amazon Kendra index field names.\n To create custom fields, use the UpdateIndex API before you map to\n GitHub fields. For more information, see Mapping data source fields.\n The GitHub data source field names must exist in your GitHub custom metadata.

" + } + }, + "GitHubPullRequestCommentConfigurationFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map attributes\n or field names of GitHub pull request comments to Amazon Kendra index field names.\n To create custom fields, use the UpdateIndex API before you map to\n GitHub fields. For more information, see Mapping data source fields.\n The GitHub data source field names must exist in your GitHub custom metadata.

" + } + }, + "GitHubPullRequestDocumentConfigurationFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map attributes\n or field names of GitHub pull requests to Amazon Kendra index field names.\n To create custom fields, use the UpdateIndex API before you map to\n GitHub fields. For more information, see Mapping data source fields.\n The GitHub data source field names must exist in your GitHub custom metadata.

" + } + }, + "GitHubPullRequestDocumentAttachmentConfigurationFieldMappings": { + "target": "com.amazonaws.kendra#DataSourceToIndexFieldMappingList", + "traits": { + "smithy.api#documentation": "

A list of DataSourceToIndexFieldMapping objects that map attributes\n or field names of GitHub pull request attachments to Amazon Kendra index field names.\n To create custom fields, use the UpdateIndex API before you map to\n GitHub fields. For more information, see Mapping data source fields.\n The GitHub data source field names must exist in your GitHub custom metadata.

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

Provides the configuration information to connect to GitHub\n as your data source.

" + } + }, + "com.amazonaws.kendra#GitHubDocumentCrawlProperties": { + "type": "structure", + "members": { + "CrawlRepositoryDocuments": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to index all files with a repository.

" + } + }, + "CrawlIssue": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to index all issues within a repository.

" + } + }, + "CrawlIssueComment": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to index all comments on issues.

" + } + }, + "CrawlIssueCommentAttachment": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to include all comment attachments for issues.

" + } + }, + "CrawlPullRequest": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to index all pull requests within a repository.

" + } + }, + "CrawlPullRequestComment": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to index all comments on pull requests.

" + } + }, + "CrawlPullRequestCommentAttachment": { + "target": "com.amazonaws.kendra#Boolean", + "traits": { + "smithy.api#documentation": "

\n TRUE to include all comment attachments for pull requests.

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

Provides the configuration information to include certain types of GitHub content. You can\n configure to index repository files only, or also include issues and pull requests,\n comments, and comment attachments.

" + } + }, "com.amazonaws.kendra#GoogleDriveConfiguration": { "type": "structure", "members": { @@ -6822,7 +7023,7 @@ "SecretArn": { "target": "com.amazonaws.kendra#SecretArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Secrets Manager secret that \n contains the key-value pairs required to connect to your Jira \n data source. The secret must \n contain a JSON structure with the following keys:

\n
    \n
  • \n

    jira-id—The Active Directory user name, along with the \n Domain Name System (DNS) domain name. For example, \n user@corp.example.com.

    \n
    • \n
  • \n

    jiraCredentials—The password of the Jira account user.

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

The Amazon Resource Name (ARN) of an Secrets Manager secret that \n contains the key-value pairs required to connect to your Jira \n data source. The secret must \n contain a JSON structure with the following keys:

\n
    \n
  • \n

    jira-id—The ID of the Jira account.

    \n
    • \n
  • \n

    jiraCredentials—The password of the Jira account user.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -6904,6 +7105,9 @@ "smithy.api#documentation": "

Configuration information for an \n Amazon Virtual Private Cloud to connect to your Jira. Your Jira \n account must reside inside your VPC.

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

Provides the configuration information to connect to Jira as your \n data source.

" } }, "com.amazonaws.kendra#JiraStatus": { @@ -8178,6 +8382,35 @@ "smithy.api#box": {} } }, + "com.amazonaws.kendra#OnPremiseConfiguration": { + "type": "structure", + "members": { + "HostUrl": { + "target": "com.amazonaws.kendra#Url", + "traits": { + "smithy.api#documentation": "

The GitHub host URL or API endpoint URL. For example,\n https://on-prem-host-url/api/v3/\n

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

The name of the organization of the GitHub Enterprise Server (in-premise) account you want\n to connect to. You can find your organization name by logging into GitHub desktop and\n selecting Your organizations under your profile picture dropdown.

", + "smithy.api#required": {} + } + }, + "SslCertificateS3Path": { + "target": "com.amazonaws.kendra#S3Path", + "traits": { + "smithy.api#documentation": "

Information required to find a specific file in an Amazon S3 bucket.

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

Provides the configuration information to connect to GitHub Enterprise Server (on premises).

" + } + }, "com.amazonaws.kendra#OneDriveConfiguration": { "type": "structure", "members": { @@ -8298,6 +8531,16 @@ "smithy.api#pattern": "^d-[0-9a-fA-F]{10}$" } }, + "com.amazonaws.kendra#OrganizationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^[A-Za-z0-9_.-]+$" + } + }, "com.amazonaws.kendra#Persona": { "type": "string", "traits": { @@ -9188,6 +9431,22 @@ ] } }, + "com.amazonaws.kendra#RepositoryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9_.-]+$" + } + }, + "com.amazonaws.kendra#RepositoryNames": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#RepositoryName" + } + }, "com.amazonaws.kendra#ResourceAlreadyExistException": { "type": "structure", "members": { @@ -9342,6 +9601,28 @@ "smithy.api#documentation": "

Information required to find a specific file in an Amazon S3\n bucket.

" } }, + "com.amazonaws.kendra#SaaSConfiguration": { + "type": "structure", + "members": { + "OrganizationName": { + "target": "com.amazonaws.kendra#OrganizationName", + "traits": { + "smithy.api#documentation": "

The name of the organization of the GitHub Enterprise Cloud (SaaS) account you want\n to connect to. You can find your organization name by logging into GitHub desktop and\n selecting Your organizations under your profile picture dropdown.

", + "smithy.api#required": {} + } + }, + "HostUrl": { + "target": "com.amazonaws.kendra#Url", + "traits": { + "smithy.api#documentation": "

The GitHub host URL or API endpoint URL. For example, \n https://api.github.com.

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

Provides the configuration information to connect to GitHub Enterprise Cloud (SaaS).

" + } + }, "com.amazonaws.kendra#SalesforceChatterFeedConfiguration": { "type": "structure", "members": { @@ -9896,12 +10177,12 @@ "KmsKeyId": { "target": "com.amazonaws.kendra#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier of the KMScustomer master key (CMK). Amazon Kendra\n doesn't support asymmetric CMKs.

" + "smithy.api#documentation": "

The identifier of the KMS key. Amazon Kendra\n doesn't support asymmetric keys.

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

Provides the identifier of the KMScustomer master key (CMK)\n used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support\n asymmetric CMKs.

" + "smithy.api#documentation": "

Provides the identifier of the KMS key used to \n encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't \n support asymmetric keys.

" } }, "com.amazonaws.kendra#ServiceNowAuthenticationType": { @@ -10679,6 +10960,12 @@ } } }, + "com.amazonaws.kendra#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#String" + } + }, "com.amazonaws.kendra#SubmitFeedback": { "type": "operation", "input": { @@ -11206,6 +11493,21 @@ } } }, + "com.amazonaws.kendra#Type": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SAAS", + "name": "SAAS" + }, + { + "value": "ON_PREMISE", + "name": "ON_PREMISE" + } + ] + } + }, "com.amazonaws.kendra#UntagResource": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/lookoutmetrics.json b/aws/sdk/aws-models/lookoutmetrics.json index a644cd409..ea9d32862 100644 --- a/aws/sdk/aws-models/lookoutmetrics.json +++ b/aws/sdk/aws-models/lookoutmetrics.json @@ -195,6 +195,12 @@ "traits": { "smithy.api#documentation": "

The time at which the alert was created.

" } + }, + "AlertFilters": { + "target": "com.amazonaws.lookoutmetrics#AlertFilters", + "traits": { + "smithy.api#documentation": "

The configuration of the alert filters, containing MetricList and DimensionFilter.

" + } } }, "traits": { @@ -211,6 +217,26 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.lookoutmetrics#AlertFilters": { + "type": "structure", + "members": { + "MetricList": { + "target": "com.amazonaws.lookoutmetrics#MetricNameList", + "traits": { + "smithy.api#documentation": "

The list of measures that you want to get alerts for.

" + } + }, + "DimensionFilterList": { + "target": "com.amazonaws.lookoutmetrics#DimensionFilterList", + "traits": { + "smithy.api#documentation": "

The list of DimensionFilter objects that are used for dimension-based filtering.

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

The configuration of the alert filters.

" + } + }, "com.amazonaws.lookoutmetrics#AlertName": { "type": "string", "traits": { @@ -1019,6 +1045,12 @@ "traits": { "smithy.api#documentation": "

An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

" } + }, + "BackTestConfiguration": { + "target": "com.amazonaws.lookoutmetrics#BackTestConfiguration", + "traits": { + "smithy.api#documentation": "

Settings for backtest mode.

" + } } }, "traits": { @@ -1149,8 +1181,7 @@ "AlertSensitivityThreshold": { "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", "traits": { - "smithy.api#documentation": "

An integer from 0 to 100 specifying the alert sensitivity threshold.

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

An integer from 0 to 100 specifying the alert sensitivity threshold.

" } }, "AlertDescription": { @@ -1178,6 +1209,12 @@ "traits": { "smithy.api#documentation": "

A list of tags to apply to the alert.

" } + }, + "AlertFilters": { + "target": "com.amazonaws.lookoutmetrics#AlertFilters", + "traits": { + "smithy.api#documentation": "

The configuration of the alert filters, containing MetricList and DimensionFilterList.

" + } } } }, @@ -2285,6 +2322,38 @@ "target": "com.amazonaws.lookoutmetrics#DimensionContribution" } }, + "com.amazonaws.lookoutmetrics#DimensionFilter": { + "type": "structure", + "members": { + "DimensionName": { + "target": "com.amazonaws.lookoutmetrics#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the dimension to filter on.

" + } + }, + "DimensionValueList": { + "target": "com.amazonaws.lookoutmetrics#DimensionValueList", + "traits": { + "smithy.api#documentation": "

The list of values for the dimension specified in DimensionName that you want to filter on.

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

The dimension filter, containing DimensionName and DimensionValueList.

" + } + }, + "com.amazonaws.lookoutmetrics#DimensionFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#DimensionFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.lookoutmetrics#DimensionList": { "type": "list", "member": { @@ -2353,6 +2422,18 @@ "target": "com.amazonaws.lookoutmetrics#DimensionValueContribution" } }, + "com.amazonaws.lookoutmetrics#DimensionValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#DimensionValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.lookoutmetrics#ErrorMessage": { "type": "string", "traits": { @@ -3537,6 +3618,9 @@ { "target": "com.amazonaws.lookoutmetrics#UntagResource" }, + { + "target": "com.amazonaws.lookoutmetrics#UpdateAlert" + }, { "target": "com.amazonaws.lookoutmetrics#UpdateAnomalyDetector" }, @@ -3648,6 +3732,18 @@ "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" } }, + "com.amazonaws.lookoutmetrics#MetricNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#MetricName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.lookoutmetrics#MetricSetDescription": { "type": "string", "traits": { @@ -4150,7 +4246,7 @@ "SnsFormat": { "target": "com.amazonaws.lookoutmetrics#SnsFormat", "traits": { - "smithy.api#documentation": "

The format of the SNS topic.

" + "smithy.api#documentation": "

The format of the SNS topic.

\n
    \n
  • \n

    \n JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.

    \n
    • \n
  • \n

    \n LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.

    \n
    • \n
  • \n

    \n SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.

    \n
    • \n
" } } }, @@ -4657,6 +4753,87 @@ "type": "structure", "members": {} }, + "com.amazonaws.lookoutmetrics#UpdateAlert": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutmetrics#UpdateAlertRequest" + }, + "output": { + "target": "com.amazonaws.lookoutmetrics#UpdateAlertResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutmetrics#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" + }, + { + "target": "com.amazonaws.lookoutmetrics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Make changes to an existing alert.

", + "smithy.api#http": { + "method": "POST", + "uri": "/UpdateAlert", + "code": 200 + } + } + }, + "com.amazonaws.lookoutmetrics#UpdateAlertRequest": { + "type": "structure", + "members": { + "AlertArn": { + "target": "com.amazonaws.lookoutmetrics#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the alert to update.

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

A description of the alert.

" + } + }, + "AlertSensitivityThreshold": { + "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", + "traits": { + "smithy.api#documentation": "

An integer from 0 to 100 specifying the alert sensitivity threshold.

" + } + }, + "Action": { + "target": "com.amazonaws.lookoutmetrics#Action", + "traits": { + "smithy.api#documentation": "

Action that will be triggered when there is an alert.

" + } + }, + "AlertFilters": { + "target": "com.amazonaws.lookoutmetrics#AlertFilters", + "traits": { + "smithy.api#documentation": "

The configuration of the alert filters, containing MetricList and DimensionFilterList.

" + } + } + } + }, + "com.amazonaws.lookoutmetrics#UpdateAlertResponse": { + "type": "structure", + "members": { + "AlertArn": { + "target": "com.amazonaws.lookoutmetrics#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the updated alert.

" + } + } + } + }, "com.amazonaws.lookoutmetrics#UpdateAnomalyDetector": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/m2.json b/aws/sdk/aws-models/m2.json new file mode 100644 index 000000000..de7c724d1 --- /dev/null +++ b/aws/sdk/aws-models/m2.json @@ -0,0 +1,5175 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.m2#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The account or role doesn't have the right permissions to make the request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.m2#AlternateKey": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the alternate key.

" + } + }, + "offset": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

A positive integer value representing the offset to mark the start of the alternate key\n part in the record byte array.

", + "smithy.api#required": {} + } + }, + "length": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

A strictly positive integer value representing the length of the alternate key.

", + "smithy.api#required": {} + } + }, + "allowDuplicates": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the alternate key values are supposed to be unique for the given data\n set.

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

Defines an alternate key. This value is optional. A legacy data set might not have any\n alternate key defined but if those alternate keys definitions exist, provide them, as some\n applications will make use of them.

" + } + }, + "com.amazonaws.m2#AlternateKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#AlternateKey" + } + }, + "com.amazonaws.m2#Application": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier" + } + }, + "create": { + "target": "com.amazonaws.m2#CreateApplication" + }, + "read": { + "target": "com.amazonaws.m2#GetApplication" + }, + "update": { + "target": "com.amazonaws.m2#UpdateApplication" + }, + "delete": { + "target": "com.amazonaws.m2#DeleteApplication" + }, + "list": { + "target": "com.amazonaws.m2#ListApplications" + }, + "operations": [ + { + "target": "com.amazonaws.m2#CancelBatchJobExecution" + }, + { + "target": "com.amazonaws.m2#CreateDataSetImportTask" + }, + { + "target": "com.amazonaws.m2#CreateDeployment" + }, + { + "target": "com.amazonaws.m2#DeleteApplicationFromEnvironment" + }, + { + "target": "com.amazonaws.m2#GetApplicationVersion" + }, + { + "target": "com.amazonaws.m2#GetBatchJobExecution" + }, + { + "target": "com.amazonaws.m2#GetDataSetDetails" + }, + { + "target": "com.amazonaws.m2#GetDataSetImportTask" + }, + { + "target": "com.amazonaws.m2#GetDeployment" + }, + { + "target": "com.amazonaws.m2#ListApplicationVersions" + }, + { + "target": "com.amazonaws.m2#ListBatchJobDefinitions" + }, + { + "target": "com.amazonaws.m2#ListBatchJobExecutions" + }, + { + "target": "com.amazonaws.m2#ListDataSetImportHistory" + }, + { + "target": "com.amazonaws.m2#ListDataSets" + }, + { + "target": "com.amazonaws.m2#ListDeployments" + }, + { + "target": "com.amazonaws.m2#StartApplication" + }, + { + "target": "com.amazonaws.m2#StartBatchJob" + }, + { + "target": "com.amazonaws.m2#StopApplication" + } + ], + "traits": { + "aws.api#arn": { + "template": "app/{applicationId}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.m2#ApplicationDeploymentLifecycle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Deploying", + "name": "DEPLOYING" + }, + { + "value": "Deployed", + "name": "DEPLOYED" + } + ] + } + }, + "com.amazonaws.m2#ApplicationLifecycle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Creating", + "name": "CREATING" + }, + { + "value": "Created", + "name": "CREATED" + }, + { + "value": "Available", + "name": "AVAILABLE" + }, + { + "value": "Ready", + "name": "READY" + }, + { + "value": "Starting", + "name": "STARTING" + }, + { + "value": "Running", + "name": "RUNNING" + }, + { + "value": "Stopping", + "name": "STOPPING" + }, + { + "value": "Stopped", + "name": "STOPPED" + }, + { + "value": "Failed", + "name": "FAILED" + }, + { + "value": "Deleting", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.m2#ApplicationSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.m2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the application.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.m2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the application.

" + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#required": {} + } + }, + "applicationArn": { + "target": "com.amazonaws.m2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

", + "smithy.api#required": {} + } + }, + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The version of the application.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#ApplicationLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the application.

", + "smithy.api#required": {} + } + }, + "engineType": { + "target": "com.amazonaws.m2#EngineType", + "traits": { + "smithy.api#documentation": "

The type of the target platform for this application.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the application was created.

", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment that hosts this application.

" + } + }, + "lastStartTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the application was last started. Null until the application has\n started running for the first time.

" + } + }, + "versionStatus": { + "target": "com.amazonaws.m2#ApplicationVersionLifecycle", + "traits": { + "smithy.api#documentation": "

Indicates the status of the latest version of the application.

" + } + }, + "deploymentStatus": { + "target": "com.amazonaws.m2#ApplicationDeploymentLifecycle", + "traits": { + "smithy.api#documentation": "

Indicates whether there is an ongoing deployment or if the application has ever deployed\n successfully.

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

A subset of the possible application attributes. Used in the application list.

" + } + }, + "com.amazonaws.m2#ApplicationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#ApplicationSummary" + } + }, + "com.amazonaws.m2#ApplicationVersionLifecycle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Creating", + "name": "CREATING" + }, + { + "value": "Available", + "name": "AVAILABLE" + }, + { + "value": "Failed", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.m2#ApplicationVersionSummary": { + "type": "structure", + "members": { + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The application version.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#ApplicationVersionLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the application.

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

The reason for the reported status.

" + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the application version was created.

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

Defines an application version summary.

" + } + }, + "com.amazonaws.m2#ApplicationVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#ApplicationVersionSummary" + } + }, + "com.amazonaws.m2#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$" + } + }, + "com.amazonaws.m2#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.m2#AwsSupernovaControlPlaneService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "m2", + "sdkServiceId": "M2", + "serviceName": "m2", + "arnNamespace": "m2", + "cloudFormationName": "M2", + "cloudTrailEventSource": "m2.amazonaws.com", + "endpointPrefix": "m2" + }, + "aws.auth#sigv4": { + "name": "m2" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by a tag key and value pair of a resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by a tag key and value pair that is allowed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "String", + "documentation": "Filters access by a list of tag keys that are allowed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*,authorization,date,x-amz-date,x-amz-security-token,x-amz-target,content-type,x-amz-content-sha256,x-amz-user-agent,x-amzn-platform-id,x-amzn-trace-id,amz-sdk-invocation-id,amz-sdk-request" + ] + }, + "smithy.api#documentation": "

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and\n modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for\n analyzing existing mainframe applications, developing or updating mainframe applications\n using COBOL or PL/I, and implementing an automated pipeline for continuous integration and\n continuous delivery (CI/CD) of the applications.

", + "smithy.api#title": "AWSMainframeModernization" + }, + "version": "2021-04-28", + "operations": [ + { + "target": "com.amazonaws.m2#ListEngineVersions" + }, + { + "target": "com.amazonaws.m2#ListTagsForResource" + }, + { + "target": "com.amazonaws.m2#TagResource" + }, + { + "target": "com.amazonaws.m2#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.m2#Application" + }, + { + "target": "com.amazonaws.m2#Environment" + } + ] + }, + "com.amazonaws.m2#BatchJobDefinition": { + "type": "union", + "members": { + "fileBatchJobDefinition": { + "target": "com.amazonaws.m2#FileBatchJobDefinition", + "traits": { + "smithy.api#documentation": "

Specifies a file containing a batch job definition.

" + } + }, + "scriptBatchJobDefinition": { + "target": "com.amazonaws.m2#ScriptBatchJobDefinition", + "traits": { + "smithy.api#documentation": "

A script containing a batch job definition.

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

Defines the details of a batch job.

" + } + }, + "com.amazonaws.m2#BatchJobDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#BatchJobDefinition" + } + }, + "com.amazonaws.m2#BatchJobExecutionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Submitting", + "name": "SUBMITTING" + }, + { + "value": "Holding", + "name": "HOLDING" + }, + { + "value": "Dispatching", + "name": "DISPATCH" + }, + { + "value": "Running", + "name": "RUNNING" + }, + { + "value": "Cancelling", + "name": "CANCELLING" + }, + { + "value": "Cancelled", + "name": "CANCELLED" + }, + { + "value": "Succeeded", + "name": "SUCCEEDED" + }, + { + "value": "Failed", + "name": "FAILED" + }, + { + "value": "Succeeded With Warning", + "name": "SUCCEEDED_WITH_WARNING" + } + ] + } + }, + "com.amazonaws.m2#BatchJobExecutionSummary": { + "type": "structure", + "members": { + "executionId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of this execution of the batch job.

", + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application that hosts this batch job.

", + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.m2#String100", + "traits": { + "smithy.api#documentation": "

The unique identifier of a particular batch job.

" + } + }, + "jobName": { + "target": "com.amazonaws.m2#String100", + "traits": { + "smithy.api#documentation": "

The name of a particular batch job.

" + } + }, + "jobType": { + "target": "com.amazonaws.m2#BatchJobType", + "traits": { + "smithy.api#documentation": "

The type of a particular batch job execution.

" + } + }, + "status": { + "target": "com.amazonaws.m2#BatchJobExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of a particular batch job execution.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when a particular batch job execution started.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when this batch job execution ended.

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

A subset of the possible batch job attributes. Used in the batch job list.

" + } + }, + "com.amazonaws.m2#BatchJobExecutionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#BatchJobExecutionSummary" + } + }, + "com.amazonaws.m2#BatchJobIdentifier": { + "type": "union", + "members": { + "fileBatchJobIdentifier": { + "target": "com.amazonaws.m2#FileBatchJobIdentifier", + "traits": { + "smithy.api#documentation": "

Specifies a file associated with a specific batch job.

" + } + }, + "scriptBatchJobIdentifier": { + "target": "com.amazonaws.m2#ScriptBatchJobIdentifier", + "traits": { + "smithy.api#documentation": "

A batch job identifier in which the batch job to run is identified by the script name.

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

Identifies a specific batch job.

" + } + }, + "com.amazonaws.m2#BatchJobParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.m2#BatchParamKey" + }, + "value": { + "target": "com.amazonaws.m2#BatchParamValue" + }, + "traits": { + "smithy.api#documentation": "Job parameters are optional.\nCan contain up to 500 entries.", + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.m2#BatchJobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VSE", + "name": "VSE" + }, + { + "value": "JES2", + "name": "JES2" + }, + { + "value": "JES3", + "name": "JES3" + } + ] + } + }, + "com.amazonaws.m2#BatchParamKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "Parameter key: the first character must be alphabetic.\nCan be of up to 8 alphanumeric characters.", + "smithy.api#length": { + "min": 1, + "max": 8 + }, + "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9]{1,7}$" + } + }, + "com.amazonaws.m2#BatchParamValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "Parameter value can be of up to 44 alphanumeric characters.", + "smithy.api#length": { + "min": 0, + "max": 44 + } + } + }, + "com.amazonaws.m2#Boolean": { + "type": "boolean" + }, + "com.amazonaws.m2#CancelBatchJobExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#CancelBatchJobExecutionRequest" + }, + "output": { + "target": "com.amazonaws.m2#CancelBatchJobExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Cancels the running of a specific batch job execution.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/batch-job-executions/{executionId}/cancel", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + } + } + }, + "com.amazonaws.m2#CancelBatchJobExecutionRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the batch job execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#CancelBatchJobExecutionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.m2#CapacityValue": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.m2#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the conflicting resource.

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

The type of the conflicting resource.

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

The parameters provided in the request conflict with existing resources.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.m2#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.m2#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "aws.iam#requiredActions": [ + "s3:GetObject", + "s3:ListBucket" + ], + "smithy.api#documentation": "

Creates a new application with given parameters. Requires an existing environment and\n application definition file.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.m2#CreateApplicationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.m2#EntityName", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.m2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the application.

" + } + }, + "engineType": { + "target": "com.amazonaws.m2#EngineType", + "traits": { + "smithy.api#documentation": "

The type of the target platform for this application.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.m2#Definition", + "traits": { + "smithy.api#documentation": "

The application definition for this application. You can specify either inline JSON or\n an S3 bucket location.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.m2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags to apply to the application.

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

Unique, case-sensitive identifier the service generates to ensure the idempotency of the\n request to create an application. The service generates the clientToken when the API call\n is triggered. The token expires after one hour, so if you retry the API within this\n timeframe with the same clientToken, you will get the same response. The service also\n handles deleting the clientToken after it expires.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.m2#CreateApplicationResponse": { + "type": "structure", + "members": { + "applicationArn": { + "target": "com.amazonaws.m2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

", + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique application identifier.

", + "smithy.api#required": {} + } + }, + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The version number of the application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#CreateDataSetImportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#CreateDataSetImportTaskRequest" + }, + "output": { + "target": "com.amazonaws.m2#CreateDataSetImportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Starts a data set import task for a specific application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/dataset-import-task", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.m2#CreateDataSetImportTaskRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application for which you want to import data sets.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "importConfig": { + "target": "com.amazonaws.m2#DataSetImportConfig", + "traits": { + "smithy.api#documentation": "

The data set import task configuration.

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

Unique, case-sensitive identifier you provide to ensure the idempotency of the request\n to create a data set import. The service generates the clientToken when the API call is\n triggered. The token expires after one hour, so if you retry the API within this timeframe\n with the same clientToken, you will get the same response. The service also handles\n deleting the clientToken after it expires.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.m2#CreateDataSetImportTaskResponse": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#CreateDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#CreateDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.m2#CreateDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#requiredActions": [ + "elasticloadbalancing:CreateTargetGroup", + "elasticloadbalancing:CreateListener" + ], + "smithy.api#documentation": "

Creates and starts a deployment to deploy an application into an environment.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/deployments", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.m2#CreateDeploymentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the environment where this application will be deployed.

", + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The application identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The version of the application to deploy.

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

Unique, case-sensitive identifier you provide to ensure the idempotency of the request\n to create a deployment. The service generates the clientToken when the API call is\n triggered. The token expires after one hour, so if you retry the API within this timeframe\n with the same clientToken, you will get the same response. The service also handles\n deleting the clientToken after it expires.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.m2#Environment" + } + ] + } + }, + "com.amazonaws.m2#CreateDeploymentResponse": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the deployment.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#CreateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#CreateEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.m2#CreateEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "aws.iam#requiredActions": [ + "ec2:DescribeSecurityGroups", + "ec2:DescribeSubnets", + "ec2:DescribeVpcs", + "ec2:DescribeNetworkInterfaces", + "ec2:DescribeVpcAttribute", + "elasticloadbalancing:CreateLoadBalancer" + ], + "smithy.api#documentation": "

Creates a runtime environment for a given runtime engine.

", + "smithy.api#http": { + "method": "POST", + "uri": "/environments", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.m2#CreateEnvironmentRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.m2#EntityName", + "traits": { + "smithy.api#documentation": "

The unique identifier of the environment.

", + "smithy.api#required": {} + } + }, + "instanceType": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The type of instance for the environment.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.m2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the environment.

" + } + }, + "engineType": { + "target": "com.amazonaws.m2#EngineType", + "traits": { + "smithy.api#documentation": "

The engine type for the environment.

", + "smithy.api#required": {} + } + }, + "engineVersion": { + "target": "com.amazonaws.m2#EngineVersion", + "traits": { + "smithy.api#documentation": "

The version of the engine type for the environment.

" + } + }, + "subnetIds": { + "target": "com.amazonaws.m2#String50List", + "traits": { + "smithy.api#documentation": "

The list of subnets associated with the VPC for this environment.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.m2#String50List", + "traits": { + "smithy.api#documentation": "

The list of security groups for the VPC associated with this environment.

" + } + }, + "storageConfigurations": { + "target": "com.amazonaws.m2#StorageConfigurationList", + "traits": { + "smithy.api#documentation": "

Optional. The storage configurations for this environment.

" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the environment is publicly accessible.

" + } + }, + "highAvailabilityConfig": { + "target": "com.amazonaws.m2#HighAvailabilityConfig", + "traits": { + "smithy.api#documentation": "

The details of a high availability configuration for this runtime environment.

" + } + }, + "tags": { + "target": "com.amazonaws.m2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the environment.

" + } + }, + "preferredMaintenanceWindow": { + "target": "com.amazonaws.m2#String50", + "traits": { + "smithy.api#documentation": "

Configures a desired maintenance window for the environment. If you do not provide a\n value, a random system-generated value will be assigned.

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

Unique, case-sensitive identifier you provide to ensure the idempotency of the request\n to create an environment. The service generates the clientToken when the API call is\n triggered. The token expires after one hour, so if you retry the API within this timeframe\n with the same clientToken, you will get the same response. The service also handles\n deleting the clientToken after it expires.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.m2#CreateEnvironmentResponse": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of this environment.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#DataSet": { + "type": "structure", + "members": { + "storageType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The storage type of the data set: database or file system. For Micro Focus, database\n corresponds to datastore and file system corresponds to EFS/FSX. For Blu Age, there is no\n support of file system and database corresponds to Blusam.

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

The logical identifier for a specific data set (in mainframe format).

", + "smithy.api#required": {} + } + }, + "datasetOrg": { + "target": "com.amazonaws.m2#DatasetOrgAttributes", + "traits": { + "smithy.api#documentation": "

The type of dataset. Possible values include VSAM, IS, PS, GDG, PO, PS, UNKNOWN\n etc.

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

The relative location of the data set in the database or file system.

" + } + }, + "recordLength": { + "target": "com.amazonaws.m2#RecordLength", + "traits": { + "smithy.api#documentation": "

The length of a record.

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

Defines a data set.

" + } + }, + "com.amazonaws.m2#DataSetImportConfig": { + "type": "union", + "members": { + "s3Location": { + "target": "com.amazonaws.m2#String2000", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of the data sets.

" + } + }, + "dataSets": { + "target": "com.amazonaws.m2#DataSetImportList", + "traits": { + "smithy.api#documentation": "

The data sets.

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

Identifies one or more data sets you want to import with the CreateDataSetImportTask operation.

" + } + }, + "com.amazonaws.m2#DataSetImportItem": { + "type": "structure", + "members": { + "dataSet": { + "target": "com.amazonaws.m2#DataSet", + "traits": { + "smithy.api#documentation": "

The data set.

", + "smithy.api#required": {} + } + }, + "externalLocation": { + "target": "com.amazonaws.m2#ExternalLocation", + "traits": { + "smithy.api#documentation": "

The location of the data set.

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

Identifies a specific data set to import from an external location.

" + } + }, + "com.amazonaws.m2#DataSetImportList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#DataSetImportItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.m2#DataSetImportSummary": { + "type": "structure", + "members": { + "total": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The total number of data set imports.

", + "smithy.api#required": {} + } + }, + "succeeded": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The number of data set imports that have succeeded.

", + "smithy.api#required": {} + } + }, + "failed": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The number of data set imports that have failed.

", + "smithy.api#required": {} + } + }, + "pending": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The number of data set imports that are pending.

", + "smithy.api#required": {} + } + }, + "inProgress": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The number of data set imports that are in progress.

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

Represents a summary of data set imports.

" + } + }, + "com.amazonaws.m2#DataSetImportTask": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the data set import task.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#DataSetTaskLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the data set import task.

", + "smithy.api#required": {} + } + }, + "summary": { + "target": "com.amazonaws.m2#DataSetImportSummary", + "traits": { + "smithy.api#documentation": "

A summary of the data set import task.

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

Contains information about a data set import task.

" + } + }, + "com.amazonaws.m2#DataSetImportTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#DataSetImportTask" + } + }, + "com.amazonaws.m2#DataSetSummary": { + "type": "structure", + "members": { + "dataSetName": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The name of the data set.

", + "smithy.api#required": {} + } + }, + "dataSetOrg": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or\n unknown.

" + } + }, + "format": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The format of the data set.

" + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the data set was created.

" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the data set was updated.

" + } + }, + "lastReferencedTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the data set was referenced.

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

A subset of the possible data set attributes.

" + } + }, + "com.amazonaws.m2#DataSetTaskLifecycle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Creating", + "name": "CREATING" + }, + { + "value": "Running", + "name": "RUNNING" + }, + { + "value": "Completed", + "name": "COMPLETED" + } + ] + } + }, + "com.amazonaws.m2#DataSetsSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#DataSetSummary" + } + }, + "com.amazonaws.m2#DatasetDetailOrgAttributes": { + "type": "union", + "members": { + "vsam": { + "target": "com.amazonaws.m2#VsamDetailAttributes", + "traits": { + "smithy.api#documentation": "

The details of a VSAM data set.

" + } + }, + "gdg": { + "target": "com.amazonaws.m2#GdgDetailAttributes", + "traits": { + "smithy.api#documentation": "

The generation data group of the data set.

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

Additional details about the data set. Different attributes correspond to different data\n set organizations. The values are populated based on datasetOrg, storageType and backend\n (Blu Age or Micro Focus).

" + } + }, + "com.amazonaws.m2#DatasetOrgAttributes": { + "type": "union", + "members": { + "vsam": { + "target": "com.amazonaws.m2#VsamAttributes", + "traits": { + "smithy.api#documentation": "

The details of a VSAM data set.

" + } + }, + "gdg": { + "target": "com.amazonaws.m2#GdgAttributes", + "traits": { + "smithy.api#documentation": "

The generation data group of the data set.

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

Additional details about the data set. Different attributes correspond to different data\n set organizations. The values are populated based on datasetOrg, storageType and backend\n (Blu Age or Micro Focus).

" + } + }, + "com.amazonaws.m2#Definition": { + "type": "union", + "members": { + "s3Location": { + "target": "com.amazonaws.m2#String2000", + "traits": { + "smithy.api#documentation": "

The S3 bucket that contains the application definition.

" + } + }, + "content": { + "target": "com.amazonaws.m2#StringFree65000", + "traits": { + "smithy.api#documentation": "

The content of the application definition. This is a JSON object that contains the\n resource configuration/definitions that identify an application.

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

The application definition for a particular application.

" + } + }, + "com.amazonaws.m2#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.m2#DeleteApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#requiredActions": [ + "elasticloadbalancing:DeleteTargetGroup", + "elasticloadbalancing:DeleteListener" + ], + "smithy.api#documentation": "

Deletes a specific application. You cannot delete a running application.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.m2#DeleteApplicationFromEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#DeleteApplicationFromEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.m2#DeleteApplicationFromEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Deletes a specific application from a specified environment where it has been previously\n deployed. You cannot delete an environment using DeleteEnvironment, if any application has\n ever been deployed to it. This API removes the association of the application with the\n environment so you can delete the environment smoothly.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}/environment/{environmentId}", + "code": 200 + } + } + }, + "com.amazonaws.m2#DeleteApplicationFromEnvironmentRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment where the application was previously\n deployed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#DeleteApplicationFromEnvironmentResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.m2#DeleteApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#DeleteApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.m2#DeleteEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#DeleteEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.m2#DeleteEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#requiredActions": [ + "elasticloadbalancing:DeleteLoadBalancer" + ], + "smithy.api#documentation": "

Deletes a specific environment. The environment cannot contain deployed applications. If\n it does, you must delete those applications before you delete the environment.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/environments/{environmentId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.m2#DeleteEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#DeleteEnvironmentResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.m2#DeployedVersionSummary": { + "type": "structure", + "members": { + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The version of the deployed application.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#DeploymentLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the deployment.

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

The reason for the reported status.

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

Contains a summary of a deployed application.

" + } + }, + "com.amazonaws.m2#DeploymentLifecycle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Deploying", + "name": "DEPLOYING" + }, + { + "value": "Succeeded", + "name": "SUCCEEDED" + }, + { + "value": "Failed", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.m2#DeploymentList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#DeploymentSummary" + } + }, + "com.amazonaws.m2#DeploymentSummary": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the deployment.

", + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the environment.

", + "smithy.api#required": {} + } + }, + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The version of the application.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#DeploymentLifecycle", + "traits": { + "smithy.api#documentation": "

The current status of the deployment.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the deployment was created.

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

The reason for the reported status.

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

A subset of information about a specific deployment.

" + } + }, + "com.amazonaws.m2#EfsStorageConfiguration": { + "type": "structure", + "members": { + "fileSystemId": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The file system identifier.

", + "smithy.api#jsonName": "file-system-id", + "smithy.api#required": {} + } + }, + "mountPoint": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The mount point for the file system.

", + "smithy.api#jsonName": "mount-point", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the storage configuration for an Amazon EFS file system.

" + } + }, + "com.amazonaws.m2#EngineType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "microfocus", + "name": "MICROFOCUS" + }, + { + "value": "bluage", + "name": "BLUAGE" + } + ] + } + }, + "com.amazonaws.m2#EngineVersion": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,10}$" + } + }, + "com.amazonaws.m2#EngineVersionsSummary": { + "type": "structure", + "members": { + "engineType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of target platform for the application.

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

The version of the engine type used by the application.

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

A subset of information about the engine version for a specific application.

" + } + }, + "com.amazonaws.m2#EngineVersionsSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#EngineVersionsSummary" + } + }, + "com.amazonaws.m2#EntityDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.m2#EntityName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$" + } + }, + "com.amazonaws.m2#EntityNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#EntityName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.m2#Environment": { + "type": "resource", + "identifiers": { + "environmentId": { + "target": "com.amazonaws.m2#Identifier" + } + }, + "create": { + "target": "com.amazonaws.m2#CreateEnvironment" + }, + "read": { + "target": "com.amazonaws.m2#GetEnvironment" + }, + "update": { + "target": "com.amazonaws.m2#UpdateEnvironment" + }, + "delete": { + "target": "com.amazonaws.m2#DeleteEnvironment" + }, + "list": { + "target": "com.amazonaws.m2#ListEnvironments" + }, + "traits": { + "aws.api#arn": { + "template": "env/{environmentId}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.m2#EnvironmentLifecycle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Creating", + "name": "CREATING" + }, + { + "value": "Available", + "name": "AVAILABLE" + }, + { + "value": "Deleting", + "name": "DELETING" + }, + { + "value": "Failed", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.m2#EnvironmentSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.m2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the environment.

", + "smithy.api#required": {} + } + }, + "environmentArn": { + "target": "com.amazonaws.m2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a particular runtime environment.

", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of a particular runtime environment.

", + "smithy.api#required": {} + } + }, + "instanceType": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The instance type of the environment.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#EnvironmentLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the environment

", + "smithy.api#required": {} + } + }, + "engineType": { + "target": "com.amazonaws.m2#EngineType", + "traits": { + "smithy.api#documentation": "

The target platform for the environment.

", + "smithy.api#required": {} + } + }, + "engineVersion": { + "target": "com.amazonaws.m2#EngineVersion", + "traits": { + "smithy.api#documentation": "

The version of the runtime engine.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the environment was created.

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

Contains a subset of the possible environment attributes. Used in the environment\n list.

" + } + }, + "com.amazonaws.m2#EnvironmentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#EnvironmentSummary" + } + }, + "com.amazonaws.m2#ExternalLocation": { + "type": "union", + "members": { + "s3Location": { + "target": "com.amazonaws.m2#String2000", + "traits": { + "smithy.api#documentation": "

The URI of the Amazon S3 bucket.

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

Defines an external storage location.

" + } + }, + "com.amazonaws.m2#FileBatchJobDefinition": { + "type": "structure", + "members": { + "fileName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the file containing the batch job definition.

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

The path to the file containing the batch job definition.

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

A file containing a batch job definition.

" + } + }, + "com.amazonaws.m2#FileBatchJobIdentifier": { + "type": "structure", + "members": { + "fileName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The file name for the batch job identifier.

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

The relative path to the file name for the batch job identifier.

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

A batch job identifier in which the batch job to run is identified by the file name and\n the relative path to the file name.

" + } + }, + "com.amazonaws.m2#FsxStorageConfiguration": { + "type": "structure", + "members": { + "fileSystemId": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The file system identifier.

", + "smithy.api#jsonName": "file-system-id", + "smithy.api#required": {} + } + }, + "mountPoint": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The mount point for the file system.

", + "smithy.api#jsonName": "mount-point", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the storage configuration for an Amazon FSx file system.

" + } + }, + "com.amazonaws.m2#GdgAttributes": { + "type": "structure", + "members": { + "limit": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of generation data sets, up to 255, in a GDG.

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

The disposition of the data set in the catalog.

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

The required attributes for a generation data group data set. A generation data set is\n one of a collection of successive, historically related, catalogued data sets that together\n are known as a generation data group (GDG). Use this structure when you want to import a\n GDG. For more information on GDG, see Generation\n data sets.

" + } + }, + "com.amazonaws.m2#GdgDetailAttributes": { + "type": "structure", + "members": { + "limit": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of generation data sets, up to 255, in a GDG.

" + } + }, + "rollDisposition": { + "target": "com.amazonaws.m2#String50", + "traits": { + "smithy.api#documentation": "

The disposition of the data set in the catalog.

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

The required attributes for a generation data group data set. A generation data set is\n one of a collection of successive, historically related, catalogued data sets that together\n are known as a generation data group (GDG). Use this structure when you want to import a\n GDG. For more information on GDG, see Generation\n data sets.

" + } + }, + "com.amazonaws.m2#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#GetApplicationRequest" + }, + "output": { + "target": "com.amazonaws.m2#GetApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Describes the details of a specific application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#GetApplicationResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.m2#EntityName", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.m2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the application.

" + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

", + "smithy.api#required": {} + } + }, + "applicationArn": { + "target": "com.amazonaws.m2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#ApplicationLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the application.

", + "smithy.api#required": {} + } + }, + "latestVersion": { + "target": "com.amazonaws.m2#ApplicationVersionSummary", + "traits": { + "smithy.api#documentation": "

The latest version of the application.

", + "smithy.api#required": {} + } + }, + "deployedVersion": { + "target": "com.amazonaws.m2#DeployedVersionSummary", + "traits": { + "smithy.api#documentation": "

The version of the application that is deployed.

" + } + }, + "engineType": { + "target": "com.amazonaws.m2#EngineType", + "traits": { + "smithy.api#documentation": "

The type of the target platform for the application.

", + "smithy.api#required": {} + } + }, + "logGroups": { + "target": "com.amazonaws.m2#LogGroupSummaries", + "traits": { + "smithy.api#documentation": "

The list of log summaries. Each log summary includes the log type as well as the log\n group identifier. These are CloudWatch logs. The Amazon Web Services Mainframe Modernization application log is pushed to CloudWatch\n under the customer's account.

" + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when this application was created.

", + "smithy.api#required": {} + } + }, + "lastStartTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the application was last started. Null until the application has\n started running for the first time.

" + } + }, + "tags": { + "target": "com.amazonaws.m2#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags associated with the application.

" + } + }, + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the environment where the application will be deployed.

" + } + }, + "targetGroupArns": { + "target": "com.amazonaws.m2#ArnList", + "traits": { + "smithy.api#documentation": "

Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the\n network load balancer.

" + } + }, + "listenerArns": { + "target": "com.amazonaws.m2#ArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the network load balancer listener created in your\n Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener on your behalf the first time you deploy an\n application.

" + } + }, + "listenerPorts": { + "target": "com.amazonaws.m2#PortList", + "traits": { + "smithy.api#documentation": "

The port associated with the network load balancer listener created in your Amazon Web Services\n account.

" + } + }, + "loadBalancerDnsName": { + "target": "com.amazonaws.m2#String100", + "traits": { + "smithy.api#documentation": "

The public DNS name of the load balancer created in your Amazon Web Services account.

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

The reason for the reported status.

" + } + } + } + }, + "com.amazonaws.m2#GetApplicationVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#GetApplicationVersionRequest" + }, + "output": { + "target": "com.amazonaws.m2#GetApplicationVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Returns details about a specific version of a specific application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/versions/{applicationVersion}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetApplicationVersionRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The specific version of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#GetApplicationVersionResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.m2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the application version.

", + "smithy.api#required": {} + } + }, + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The specific version of the application.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.m2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The application description.

" + } + }, + "definitionContent": { + "target": "com.amazonaws.m2#StringFree65000", + "traits": { + "smithy.api#documentation": "

The content of the application definition. This is a JSON object that contains the\n resource configuration/definitions that identify an application.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#ApplicationVersionLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the application version.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the application version was created.

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

The reason for the reported status.

" + } + } + } + }, + "com.amazonaws.m2#GetBatchJobExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#GetBatchJobExecutionRequest" + }, + "output": { + "target": "com.amazonaws.m2#GetBatchJobExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Gets the details of a specific batch job execution for a specific application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/batch-job-executions/{executionId}", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetBatchJobExecutionRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the batch job execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#GetBatchJobExecutionResponse": { + "type": "structure", + "members": { + "executionId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for this batch job execution.

", + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

", + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.m2#String100", + "traits": { + "smithy.api#documentation": "

The unique identifier for this batch job.

" + } + }, + "jobName": { + "target": "com.amazonaws.m2#String100", + "traits": { + "smithy.api#documentation": "

The name of this batch job.

" + } + }, + "jobUser": { + "target": "com.amazonaws.m2#String100", + "traits": { + "smithy.api#documentation": "

The user for the job.

" + } + }, + "jobType": { + "target": "com.amazonaws.m2#BatchJobType", + "traits": { + "smithy.api#documentation": "

The type of job.

" + } + }, + "status": { + "target": "com.amazonaws.m2#BatchJobExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the batch job execution.

", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the batch job execution started.

", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the batch job execution ended.

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

The reason for the reported status.

" + } + } + } + }, + "com.amazonaws.m2#GetDataSetDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#GetDataSetDetailsRequest" + }, + "output": { + "target": "com.amazonaws.m2#GetDataSetDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Gets the details of a specific data set.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/datasets/{dataSetName}", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetDataSetDetailsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application that this data set is associated with.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSetName": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The name of the data set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#GetDataSetDetailsResponse": { + "type": "structure", + "members": { + "dataSetName": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The name of the data set.

", + "smithy.api#required": {} + } + }, + "dataSetOrg": { + "target": "com.amazonaws.m2#DatasetDetailOrgAttributes", + "traits": { + "smithy.api#documentation": "

The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or\n unknown.

" + } + }, + "recordLength": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The length of records in the data set.

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

The locaion where the data set is stored.

" + } + }, + "blocksize": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The size of the block on disk.

" + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the data set was created.

" + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the data set was updated.

" + } + }, + "lastReferencedTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the data set was referenced.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.m2#GetDataSetImportTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#GetDataSetImportTaskRequest" + }, + "output": { + "target": "com.amazonaws.m2#GetDataSetImportTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/dataset-import-tasks/{taskId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetDataSetImportTaskRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The application identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "taskId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The task identifier returned by the CreateDataSetImportTask operation.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#GetDataSetImportTaskResponse": { + "type": "structure", + "members": { + "taskId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The task identifier.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#DataSetTaskLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the task.

", + "smithy.api#required": {} + } + }, + "summary": { + "target": "com.amazonaws.m2#DataSetImportSummary", + "traits": { + "smithy.api#documentation": "

A summary of the status of the task.

" + } + } + } + }, + "com.amazonaws.m2#GetDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#GetDeploymentRequest" + }, + "output": { + "target": "com.amazonaws.m2#GetDeploymentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Gets details of a specific deployment with a given deployment identifier.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/deployments/{deploymentId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetDeploymentRequest": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier for the deployment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#GetDeploymentResponse": { + "type": "structure", + "members": { + "deploymentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the deployment.

", + "smithy.api#required": {} + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment.

", + "smithy.api#required": {} + } + }, + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The application version.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#DeploymentLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the deployment.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the deployment was created.

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

The reason for the reported status.

" + } + } + } + }, + "com.amazonaws.m2#GetEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#GetEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.m2#GetEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Describes a specific runtime environment.

", + "smithy.api#http": { + "method": "GET", + "uri": "/environments/{environmentId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#GetEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#GetEnvironmentResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.m2#EntityName", + "traits": { + "smithy.api#documentation": "

The name of the runtime environment.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.m2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the runtime environment.

" + } + }, + "environmentArn": { + "target": "com.amazonaws.m2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the runtime environment.

", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment.

", + "smithy.api#required": {} + } + }, + "instanceType": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The type of instance underlying the runtime environment.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.m2#EnvironmentLifecycle", + "traits": { + "smithy.api#documentation": "

The status of the runtime environment.

", + "smithy.api#required": {} + } + }, + "engineType": { + "target": "com.amazonaws.m2#EngineType", + "traits": { + "smithy.api#documentation": "

The target platform for the runtime environment.

", + "smithy.api#required": {} + } + }, + "engineVersion": { + "target": "com.amazonaws.m2#EngineVersion", + "traits": { + "smithy.api#documentation": "

The version of the runtime engine.

", + "smithy.api#required": {} + } + }, + "vpcId": { + "target": "com.amazonaws.m2#String50", + "traits": { + "smithy.api#documentation": "

The unique identifier for the VPC used with this runtime environment.

", + "smithy.api#required": {} + } + }, + "subnetIds": { + "target": "com.amazonaws.m2#String50List", + "traits": { + "smithy.api#documentation": "

The unique identifiers of the subnets assigned to this runtime environment.

", + "smithy.api#required": {} + } + }, + "securityGroupIds": { + "target": "com.amazonaws.m2#String50List", + "traits": { + "smithy.api#documentation": "

The unique identifiers of the security groups assigned to this runtime\n environment.

", + "smithy.api#required": {} + } + }, + "creationTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the runtime environment was created.

", + "smithy.api#required": {} + } + }, + "storageConfigurations": { + "target": "com.amazonaws.m2#StorageConfigurationList", + "traits": { + "smithy.api#documentation": "

The storage configurations defined for the runtime environment.

" + } + }, + "tags": { + "target": "com.amazonaws.m2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags defined for this runtime environment.

" + } + }, + "highAvailabilityConfig": { + "target": "com.amazonaws.m2#HighAvailabilityConfig", + "traits": { + "smithy.api#documentation": "

The desired capacity of the high availability configuration for the runtime\n environment.

" + } + }, + "publiclyAccessible": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#documentation": "

Whether applications running in this runtime environment are publicly accessible.\n

" + } + }, + "actualCapacity": { + "target": "com.amazonaws.m2#CapacityValue", + "traits": { + "smithy.api#documentation": "

The number of instances included in the runtime environment. A standalone runtime\n environment has a maxiumum of one instance. Currently, a high availability runtime\n environment has a maximum of two instances.

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

The Amazon Resource Name (ARN) for the load balancer used with the runtime\n environment.

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

The reason for the reported status.

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

Configures a desired maintenance window for the environment. If you do not provide a\n value, a random system-generated value will be assigned.

" + } + }, + "pendingMaintenance": { + "target": "com.amazonaws.m2#PendingMaintenance", + "traits": { + "smithy.api#documentation": "

Indicates the pending maintenance scheduled on this environment.

" + } + } + } + }, + "com.amazonaws.m2#HighAvailabilityConfig": { + "type": "structure", + "members": { + "desiredCapacity": { + "target": "com.amazonaws.m2#CapacityValue", + "traits": { + "smithy.api#documentation": "

The number of instances in a high availability configuration.

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

Defines the details of a high availability configuration.

" + } + }, + "com.amazonaws.m2#Identifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,80}$" + } + }, + "com.amazonaws.m2#IdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#Identifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.m2#Integer": { + "type": "integer" + }, + "com.amazonaws.m2#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds to wait before retrying the request.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

An unexpected error occurred during the processing of the request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.m2#ListApplicationVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListApplicationVersionsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListApplicationVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Returns a list of the application versions for a specific application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/versions", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "applicationVersions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListApplicationVersionsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of application versions to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#ListApplicationVersionsResponse": { + "type": "structure", + "members": { + "applicationVersions": { + "target": "com.amazonaws.m2#ApplicationVersionSummaryList", + "traits": { + "smithy.api#documentation": "

The list of application versions.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.m2#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Lists the applications associated with a specific Amazon Web Services account. You can provide the\n unique identifier of a specific environment in a query parameter to see all applications\n associated with that environment.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "applications" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to control the number of applications displayed in the list.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of applications to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "names": { + "target": "com.amazonaws.m2#EntityNameList", + "traits": { + "smithy.api#documentation": "

The names of the applications.

", + "smithy.api#httpQuery": "names" + } + }, + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment where the applications are\n deployed.

", + "smithy.api#httpQuery": "environmentId" + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.m2#Environment" + } + ] + } + }, + "com.amazonaws.m2#ListApplicationsResponse": { + "type": "structure", + "members": { + "applications": { + "target": "com.amazonaws.m2#ApplicationSummaryList", + "traits": { + "smithy.api#documentation": "

Returns a list of summary details for all the applications in an environment.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token that's returned when the response doesn't contain all\n applications.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.m2#ListBatchJobDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListBatchJobDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListBatchJobDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Lists all the available batch job definitions based on the batch job resources uploaded\n during the application creation. The listed batch job definitions can then be used to start\n a batch job.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/batch-job-definitions", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "batchJobDefinitions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListBatchJobDefinitionsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of batch job definitions to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "prefix": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search\n on the file names of FileBatchJobDefinitions.

", + "smithy.api#httpQuery": "prefix" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#ListBatchJobDefinitionsResponse": { + "type": "structure", + "members": { + "batchJobDefinitions": { + "target": "com.amazonaws.m2#BatchJobDefinitions", + "traits": { + "smithy.api#documentation": "

The list of batch job definitions.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.m2#ListBatchJobExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListBatchJobExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListBatchJobExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Lists historical, current, and scheduled batch job executions for a specific\n application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/batch-job-executions", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "batchJobExecutions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListBatchJobExecutionsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to control the number of batch job executions displayed in the\n list.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of batch job executions to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIds": { + "target": "com.amazonaws.m2#IdentifierList", + "traits": { + "smithy.api#documentation": "

The unique identifier of each batch job execution.

", + "smithy.api#httpQuery": "executionIds" + } + }, + "jobName": { + "target": "com.amazonaws.m2#String100", + "traits": { + "smithy.api#documentation": "

The name of each batch job execution.

", + "smithy.api#httpQuery": "jobName" + } + }, + "status": { + "target": "com.amazonaws.m2#BatchJobExecutionStatus", + "traits": { + "smithy.api#documentation": "

The status of the batch job executions.

", + "smithy.api#httpQuery": "status" + } + }, + "startedAfter": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time after which the batch job executions started.

", + "smithy.api#httpQuery": "startedAfter" + } + }, + "startedBefore": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time before the batch job executions started.

", + "smithy.api#httpQuery": "startedBefore" + } + } + } + }, + "com.amazonaws.m2#ListBatchJobExecutionsResponse": { + "type": "structure", + "members": { + "batchJobExecutions": { + "target": "com.amazonaws.m2#BatchJobExecutionSummaryList", + "traits": { + "smithy.api#documentation": "

Returns a list of batch job executions for an application.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token that's returned when the response doesn't contain all batch job\n executions.

" + } + } + } + }, + "com.amazonaws.m2#ListDataSetImportHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListDataSetImportHistoryRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListDataSetImportHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Lists the data set imports for the specified application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/dataset-import-tasks", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataSetImportTasks" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListDataSetImportHistoryRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of objects to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#ListDataSetImportHistoryResponse": { + "type": "structure", + "members": { + "dataSetImportTasks": { + "target": "com.amazonaws.m2#DataSetImportTaskList", + "traits": { + "smithy.api#documentation": "

The data set import tasks.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.m2#ListDataSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListDataSetsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListDataSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are\n associated with applications deployed on environments. This is known as importing data\n sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/datasets", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "dataSets" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListDataSetsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application for which you want to list the associated data\n sets.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of objects to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "prefix": { + "target": "com.amazonaws.m2#String200", + "traits": { + "smithy.api#documentation": "

The prefix of the data set name, which you can use to filter the list of data\n sets.

", + "smithy.api#httpQuery": "prefix" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#ListDataSetsResponse": { + "type": "structure", + "members": { + "dataSets": { + "target": "com.amazonaws.m2#DataSetsSummaryList", + "traits": { + "smithy.api#documentation": "

The list of data sets, containing ionformation including the creating time, the data set\n name, the data set organization, the data set format, and the last time the data set was\n referenced or updated.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.m2#ListDeployments": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListDeploymentsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListDeploymentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Returns a list of all deployments of a specific application. A deployment is a\n combination of a specific application and a specific version of that application. Each\n deployment is mapped to a particular application version.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/deployments", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "deployments" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListDeploymentsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of objects to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The application identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#ListDeploymentsResponse": { + "type": "structure", + "members": { + "deployments": { + "target": "com.amazonaws.m2#DeploymentList", + "traits": { + "smithy.api#documentation": "

The list of deployments that is returned.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.m2#ListEngineVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListEngineVersionsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListEngineVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Lists the available engine versions.

", + "smithy.api#http": { + "method": "GET", + "uri": "/engine-versions", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "engineVersions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListEngineVersionsRequest": { + "type": "structure", + "members": { + "engineType": { + "target": "com.amazonaws.m2#EngineType", + "traits": { + "smithy.api#documentation": "

The type of target platform.

", + "smithy.api#httpQuery": "engineType" + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of objects to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.m2#ListEngineVersionsResponse": { + "type": "structure", + "members": { + "engineVersions": { + "target": "com.amazonaws.m2#EngineVersionsSummaryList", + "traits": { + "smithy.api#documentation": "

Returns the engine versions.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" + } + } + } + }, + "com.amazonaws.m2#ListEnvironments": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListEnvironmentsRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListEnvironmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Lists the runtime environments.

", + "smithy.api#http": { + "method": "GET", + "uri": "/environments", + "headers": { + "Content-Type": "application/x-amz-json-1.1" + }, + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "environments" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.m2#ListEnvironmentsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token to control the number of environments displayed in the list.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.m2#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of environments to return.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "names": { + "target": "com.amazonaws.m2#EntityNameList", + "traits": { + "smithy.api#documentation": "

The name of the environment.

", + "smithy.api#httpQuery": "names" + } + }, + "engineType": { + "target": "com.amazonaws.m2#EngineType", + "traits": { + "smithy.api#documentation": "

The engine type for the environment.

", + "smithy.api#httpQuery": "engineType" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.m2#ListEnvironmentsResponse": { + "type": "structure", + "members": { + "environments": { + "target": "com.amazonaws.m2#EnvironmentSummaryList", + "traits": { + "smithy.api#documentation": "

Returns a list of summary details for all the environments in your account.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.m2#NextToken", + "traits": { + "smithy.api#documentation": "

A pagination token that's returned when the response doesn't contain all the\n environments.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.m2#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.m2#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Lists the tags for the specified resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.m2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.m2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.m2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#LogGroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.m2#LogGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#LogGroupSummary" + } + }, + "com.amazonaws.m2#LogGroupSummary": { + "type": "structure", + "members": { + "logType": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The type of log.

", + "smithy.api#required": {} + } + }, + "logGroupName": { + "target": "com.amazonaws.m2#LogGroupIdentifier", + "traits": { + "smithy.api#documentation": "

The name of the log group.

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

A subset of the attributes about a log group. In CloudWatch a log group is a group of log\n streams that share the same retention, monitoring, and access control settings.

" + } + }, + "com.amazonaws.m2#MaintenanceSchedule": { + "type": "structure", + "members": { + "startTime": { + "target": "com.amazonaws.m2#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the scheduled maintenance is to start.

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

The time the scheduled maintenance is to end.

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

The information about the maintenance schedule.

" + } + }, + "com.amazonaws.m2#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.m2#NextToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,2000}$" + } + }, + "com.amazonaws.m2#PendingMaintenance": { + "type": "structure", + "members": { + "schedule": { + "target": "com.amazonaws.m2#MaintenanceSchedule", + "traits": { + "smithy.api#documentation": "

The maintenance schedule for the engine version.

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

The specific runtime engine that the maintenance schedule applies to.

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

The scheduled maintenance for a runtime engine.

" + } + }, + "com.amazonaws.m2#PortList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#Integer" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.m2#PrimaryKey": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A name for the Primary Key.

" + } + }, + "offset": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

A positive integer value representing the offset to mark the start of the primary key in\n the record byte array.

", + "smithy.api#required": {} + } + }, + "length": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

A strictly positive integer value representing the length of the primary key.

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

The primary key for a KSDS data set.

" + } + }, + "com.amazonaws.m2#RecordLength": { + "type": "structure", + "members": { + "min": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The minimum record length of a record.

", + "smithy.api#required": {} + } + }, + "max": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum record length. In case of fixed, both minimum and maximum are the\n same.

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

The length of the records in the data set.

" + } + }, + "com.amazonaws.m2#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the missing resource.

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

The type of the missing resource.

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

The specified resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.m2#ScriptBatchJobDefinition": { + "type": "structure", + "members": { + "scriptName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the script containing the batch job definition.

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

A batch job definition contained in a script.

" + } + }, + "com.amazonaws.m2#ScriptBatchJobIdentifier": { + "type": "structure", + "members": { + "scriptName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the script containing the batch job definition.

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

A batch job identifier in which the batch job to run is identified by the script\n name.

" + } + }, + "com.amazonaws.m2#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the resource that is exceeding the quota limit.

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

The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.

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

A code that identifies the service that the exceeded quota belongs to.

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

The identifier of the exceeded quota.

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

One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.m2#StartApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#StartApplicationRequest" + }, + "output": { + "target": "com.amazonaws.m2#StartApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Starts an application that is currently stopped.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/start", + "code": 200 + } + } + }, + "com.amazonaws.m2#StartApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application you want to start.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#StartApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.m2#StartBatchJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#StartBatchJobRequest" + }, + "output": { + "target": "com.amazonaws.m2#StartBatchJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Starts a batch job and returns the unique identifier of this execution of the batch job.\n The associated application must be running in order to start the batch job.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/batch-job", + "code": 200 + } + } + }, + "com.amazonaws.m2#StartBatchJobRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application associated with this batch job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "batchJobIdentifier": { + "target": "com.amazonaws.m2#BatchJobIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the batch job.

", + "smithy.api#required": {} + } + }, + "jobParams": { + "target": "com.amazonaws.m2#BatchJobParametersMap", + "traits": { + "smithy.api#documentation": "

The collection of batch job parameters. For details about limits for keys and values,\n see Coding variables in JCL.

" + } + } + } + }, + "com.amazonaws.m2#StartBatchJobResponse": { + "type": "structure", + "members": { + "executionId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of this execution of the batch job.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#StopApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#StopApplicationRequest" + }, + "output": { + "target": "com.amazonaws.m2#StopApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Stops a running application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/stop", + "code": 200 + } + } + }, + "com.amazonaws.m2#StopApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application you want to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "forceStop": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#documentation": "

Stopping an application process can take a long time. Setting this parameter to true\n lets you force stop the application so you don't need to wait until the process finishes to\n apply another action on the application. The default value is false.

" + } + } + } + }, + "com.amazonaws.m2#StopApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.m2#StorageConfiguration": { + "type": "union", + "members": { + "efs": { + "target": "com.amazonaws.m2#EfsStorageConfiguration", + "traits": { + "smithy.api#documentation": "

Defines the storage configuration for an Amazon EFS file system.

" + } + }, + "fsx": { + "target": "com.amazonaws.m2#FsxStorageConfiguration", + "traits": { + "smithy.api#documentation": "

Defines the storage configuration for an Amazon FSx file system.

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

Defines the storage configuration for an environment.

" + } + }, + "com.amazonaws.m2#StorageConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#StorageConfiguration" + } + }, + "com.amazonaws.m2#String100": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,100}$" + } + }, + "com.amazonaws.m2#String20": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,20}$" + } + }, + "com.amazonaws.m2#String200": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,200}$" + } + }, + "com.amazonaws.m2#String2000": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,2000}$" + } + }, + "com.amazonaws.m2#String50": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\S{1,50}$" + } + }, + "com.amazonaws.m2#String50List": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#String50" + } + }, + "com.amazonaws.m2#StringFree65000": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65000 + } + } + }, + "com.amazonaws.m2#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:).+$" + } + }, + "com.amazonaws.m2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#TagKey" + } + }, + "com.amazonaws.m2#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.m2#TagKey" + }, + "value": { + "target": "com.amazonaws.m2#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.m2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.m2#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Adds one or more tags to the specified resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.m2#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.m2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.m2#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.m2#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.m2#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the service that the throttled request was made to.

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

The identifier of the throttled reuqest.

" + } + }, + "retryAfterSeconds": { + "target": "com.amazonaws.m2#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds to wait before retrying the request.

", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of requests made exceeds the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.m2#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.m2#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.m2#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#conditionKeys": [ + "aws:TagKeys" + ], + "smithy.api#documentation": "

Removes one or more tags from the specified resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.m2#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.m2#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.m2#TagKeyList", + "traits": { + "smithy.api#documentation": "

The keys of the tags to remove.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.m2#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.m2#UpdateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.iam#requiredActions": [ + "s3:GetObject", + "s3:ListBucket" + ], + "smithy.api#documentation": "

Updates an application and creates a new version.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/applications/{applicationId}", + "code": 200 + } + } + }, + "com.amazonaws.m2#UpdateApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the application you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.m2#EntityDescription", + "traits": { + "smithy.api#documentation": "

The description of the application to update.

" + } + }, + "currentApplicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The current version of the application to update.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.m2#Definition", + "traits": { + "smithy.api#documentation": "

The application definition for this application. You can specify either inline JSON or\n an S3 bucket location.

" + } + } + } + }, + "com.amazonaws.m2#UpdateApplicationResponse": { + "type": "structure", + "members": { + "applicationVersion": { + "target": "com.amazonaws.m2#Version", + "traits": { + "smithy.api#documentation": "

The new version of the application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#UpdateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.m2#UpdateEnvironmentRequest" + }, + "output": { + "target": "com.amazonaws.m2#UpdateEnvironmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.m2#AccessDeniedException" + }, + { + "target": "com.amazonaws.m2#ConflictException" + }, + { + "target": "com.amazonaws.m2#InternalServerException" + }, + { + "target": "com.amazonaws.m2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.m2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.m2#ThrottlingException" + }, + { + "target": "com.amazonaws.m2#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "

Updates the configuration details for a specific environment.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/environments/{environmentId}", + "code": 200 + } + } + }, + "com.amazonaws.m2#UpdateEnvironmentRequest": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "desiredCapacity": { + "target": "com.amazonaws.m2#CapacityValue", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The desired capacity for the environment to update.

" + } + }, + "instanceType": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The instance type for the environment to update.

" + } + }, + "engineVersion": { + "target": "com.amazonaws.m2#EngineVersion", + "traits": { + "smithy.api#documentation": "

The version of the runtime engine for the environment.

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

Configures a desired maintenance window for the environment. If you do not provide a\n value, a random system-generated value will be assigned.

" + } + }, + "applyDuringMaintenanceWindow": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to update the environment during the maintenance window. The default\n is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if\n applyDuringMaintenanceWindow is true. If any parameter other than\n engineVersion is provided in UpdateEnvironmentRequest, it will\n fail if applyDuringMaintenanceWindow is set to true.

" + } + } + } + }, + "com.amazonaws.m2#UpdateEnvironmentResponse": { + "type": "structure", + "members": { + "environmentId": { + "target": "com.amazonaws.m2#Identifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the runtime environment that was updated.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.m2#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.m2#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason why it failed service validation.

" + } + }, + "fieldList": { + "target": "com.amazonaws.m2#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

The list of fields that failed service validation.

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

One or more parameters provided in the request is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.m2#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the exception field.

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

The message of the exception field.

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

Contains information about a validation exception field.

" + } + }, + "com.amazonaws.m2#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.m2#ValidationExceptionField" + } + }, + "com.amazonaws.m2#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unknownOperation", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "cannotParse", + "name": "CANNOT_PARSE" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "other", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.m2#Version": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.m2#VsamAttributes": { + "type": "structure", + "members": { + "format": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The record format of the data set.

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

The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

" + } + }, + "compressed": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether indexes for this dataset are stored as compressed values. If you have\n a large data set (typically > 100 Mb), consider setting this flag to True.

" + } + }, + "primaryKey": { + "target": "com.amazonaws.m2#PrimaryKey", + "traits": { + "smithy.api#documentation": "

The primary key of the data set.

" + } + }, + "alternateKeys": { + "target": "com.amazonaws.m2#AlternateKeyList", + "traits": { + "smithy.api#documentation": "

The alternate key definitions, if any. A legacy dataset might not have any alternate key\n defined, but if those alternate keys definitions exist, provide them as some applications\n will make use of them.

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

The attributes of a VSAM type data set.

" + } + }, + "com.amazonaws.m2#VsamDetailAttributes": { + "type": "structure", + "members": { + "encoding": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

" + } + }, + "recordFormat": { + "target": "com.amazonaws.m2#String20", + "traits": { + "smithy.api#documentation": "

The record format of the data set.

" + } + }, + "compressed": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Indicates whether indexes for this dataset are stored as compressed values. If you have\n a large data set (typically > 100 Mb), consider setting this flag to True.

" + } + }, + "cacheAtStartup": { + "target": "com.amazonaws.m2#Boolean", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

If set to True, enforces loading the data set into cache before it’s used by the\n application.

" + } + }, + "primaryKey": { + "target": "com.amazonaws.m2#PrimaryKey", + "traits": { + "smithy.api#documentation": "

The primary key of the data set.

" + } + }, + "alternateKeys": { + "target": "com.amazonaws.m2#AlternateKeyList", + "traits": { + "smithy.api#documentation": "

The alternate key definitions, if any. A legacy dataset might not have any alternate key\n defined, but if those alternate keys definitions exist, provide them as some applications\n will make use of them.

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

The attributes of a VSAM type data set.

" + } + } + } +} diff --git a/aws/sdk/aws-models/mediaconvert.json b/aws/sdk/aws-models/mediaconvert.json index 9c4766178..35d3b90e4 100644 --- a/aws/sdk/aws-models/mediaconvert.json +++ b/aws/sdk/aws-models/mediaconvert.json @@ -1096,6 +1096,30 @@ "smithy.api#documentation": "Settings related to one audio tab on the MediaConvert console. In your job JSON, an instance of AudioDescription is equivalent to one audio tab in the console. Usually, one audio tab corresponds to one output audio track. Depending on how you set up your input audio selectors and whether you use audio selector groups, one audio tab can correspond to a group of output audio tracks." } }, + "com.amazonaws.mediaconvert#AudioDurationCorrection": { + "type": "string", + "traits": { + "smithy.api#documentation": "Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion.", + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "TRACK", + "name": "TRACK" + }, + { + "value": "FRAME", + "name": "FRAME" + } + ] + } + }, "com.amazonaws.mediaconvert#AudioLanguageCodeControl": { "type": "string", "traits": { @@ -1237,6 +1261,13 @@ "com.amazonaws.mediaconvert#AudioSelector": { "type": "structure", "members": { + "AudioDurationCorrection": { + "target": "com.amazonaws.mediaconvert#AudioDurationCorrection", + "traits": { + "smithy.api#documentation": "Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion.", + "smithy.api#jsonName": "audioDurationCorrection" + } + }, "CustomLanguageCode": { "target": "com.amazonaws.mediaconvert#__stringMin3Max3PatternAZaZ3", "traits": { @@ -10481,7 +10512,7 @@ "VideoGenerator": { "target": "com.amazonaws.mediaconvert#InputVideoGenerator", "traits": { - "smithy.api#documentation": "Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. When you include Video generator, MediaConvert creates a video input with black frames and without an audio track. You can specify a value for Video generator, or you can specify an Input file, but you cannot specify both.", + "smithy.api#documentation": "When you include Video generator, MediaConvert creates a video input with black frames. Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. You can specify Video generator, or you can specify an Input file, but you cannot specify both. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-generator.html", "smithy.api#jsonName": "videoGenerator" } }, @@ -10869,7 +10900,7 @@ } }, "traits": { - "smithy.api#documentation": "Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. When you include Video generator, MediaConvert creates a video input with black frames and without an audio track. You can specify a value for Video generator, or you can specify an Input file, but you cannot specify both." + "smithy.api#documentation": "When you include Video generator, MediaConvert creates a video input with black frames. Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. You can specify Video generator, or you can specify an Input file, but you cannot specify both. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-generator.html" } }, "com.amazonaws.mediaconvert#InsertableImage": { diff --git a/aws/sdk/aws-models/neptune.json b/aws/sdk/aws-models/neptune.json index 904675865..0aadddd7f 100644 --- a/aws/sdk/aws-models/neptune.json +++ b/aws/sdk/aws-models/neptune.json @@ -34,6 +34,9 @@ "input": { "target": "com.amazonaws.neptune#AddRoleToDBClusterMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.neptune#DBClusterNotFoundFault" @@ -129,6 +132,9 @@ "input": { "target": "com.amazonaws.neptune#AddTagsToResourceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.neptune#DBClusterNotFoundFault" @@ -230,6 +236,9 @@ { "target": "com.amazonaws.neptune#CreateEventSubscription" }, + { + "target": "com.amazonaws.neptune#CreateGlobalCluster" + }, { "target": "com.amazonaws.neptune#DeleteDBCluster" }, @@ -254,6 +263,9 @@ { "target": "com.amazonaws.neptune#DeleteEventSubscription" }, + { + "target": "com.amazonaws.neptune#DeleteGlobalCluster" + }, { "target": "com.amazonaws.neptune#DescribeDBClusterEndpoints" }, @@ -302,6 +314,9 @@ { "target": "com.amazonaws.neptune#DescribeEventSubscriptions" }, + { + "target": "com.amazonaws.neptune#DescribeGlobalClusters" + }, { "target": "com.amazonaws.neptune#DescribeOrderableDBInstanceOptions" }, @@ -314,6 +329,9 @@ { "target": "com.amazonaws.neptune#FailoverDBCluster" }, + { + "target": "com.amazonaws.neptune#FailoverGlobalCluster" + }, { "target": "com.amazonaws.neptune#ListTagsForResource" }, @@ -341,12 +359,18 @@ { "target": "com.amazonaws.neptune#ModifyEventSubscription" }, + { + "target": "com.amazonaws.neptune#ModifyGlobalCluster" + }, { "target": "com.amazonaws.neptune#PromoteReadReplicaDBCluster" }, { "target": "com.amazonaws.neptune#RebootDBInstance" }, + { + "target": "com.amazonaws.neptune#RemoveFromGlobalCluster" + }, { "target": "com.amazonaws.neptune#RemoveRoleFromDBCluster" }, @@ -811,6 +835,9 @@ { "target": "com.amazonaws.neptune#DBSubnetGroupNotFoundFault" }, + { + "target": "com.amazonaws.neptune#GlobalClusterNotFoundFault" + }, { "target": "com.amazonaws.neptune#InsufficientStorageClusterCapacityFault" }, @@ -823,6 +850,9 @@ { "target": "com.amazonaws.neptune#InvalidDBSubnetGroupStateFault" }, + { + "target": "com.amazonaws.neptune#InvalidGlobalClusterStateFault" + }, { "target": "com.amazonaws.neptune#InvalidSubnet" }, @@ -1138,6 +1168,12 @@ "traits": { "smithy.api#documentation": "

A value that indicates whether the DB cluster has deletion protection enabled.\n The database can't be deleted when deletion protection is enabled. By default,\n deletion protection is enabled.

" } + }, + "GlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The ID of the Neptune global database to which this new DB cluster\n should be added.

" + } } } }, @@ -1835,6 +1871,82 @@ } } }, + "com.amazonaws.neptune#CreateGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptune#CreateGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.neptune#CreateGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.neptune#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#GlobalClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.neptune#GlobalClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.neptune#InvalidDBClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a Neptune global database spread across multiple Amazon Regions.\n The global database contains a single primary cluster with read-write\n capability, and read-only secondary clusters that receive data from the\n primary cluster through high-speed replication performed by the Neptune\n storage subsystem.

\n\n

You can create a global database that is initially empty, and then\n add a primary cluster and secondary clusters to it, or you can specify\n an existing Neptune cluster during the create operation to become the\n primary cluster of the global database.

" + } + }, + "com.amazonaws.neptune#CreateGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The cluster identifier of the new global database cluster.

", + "smithy.api#required": {} + } + }, + "SourceDBClusterIdentifier": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

(Optional) The Amazon Resource Name (ARN) of\n an existing Neptune DB cluster to use as the primary cluster of the new\n global database.

" + } + }, + "Engine": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The name of the database engine to be used in the global database.

\n

Valid values: neptune\n

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The Neptune engine version to be used by the global database.

\n

Valid values: 1.2.0.0 or above.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The deletion protection setting for the new global database.\n The global database can't be deleted when deletion protection is\n enabled.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The storage encryption setting for the new global database\n cluster.

" + } + } + } + }, + "com.amazonaws.neptune#CreateGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.neptune#GlobalCluster" + } + } + }, "com.amazonaws.neptune#DBCluster": { "type": "structure", "members": { @@ -2911,6 +3023,12 @@ "traits": { "smithy.api#documentation": "

Indicates whether the database engine version supports read replicas.

" } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

" + } } }, "traits": { @@ -4001,6 +4119,9 @@ "input": { "target": "com.amazonaws.neptune#DeleteDBClusterParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.neptune#DBParameterGroupNotFoundFault" @@ -4139,6 +4260,9 @@ "input": { "target": "com.amazonaws.neptune#DeleteDBParameterGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.neptune#DBParameterGroupNotFoundFault" @@ -4168,6 +4292,9 @@ "input": { "target": "com.amazonaws.neptune#DeleteDBSubnetGroupMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.neptune#DBSubnetGroupNotFoundFault" @@ -4235,6 +4362,46 @@ } } }, + "com.amazonaws.neptune#DeleteGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptune#DeleteGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.neptune#DeleteGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.neptune#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a global database. The primary and all secondary clusters must\n already be detached or deleted first.

" + } + }, + "com.amazonaws.neptune#DeleteGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The cluster identifier of the global database cluster being deleted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.neptune#DeleteGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.neptune#GlobalCluster" + } + } + }, "com.amazonaws.neptune#DescribeDBClusterEndpoints": { "type": "operation", "input": { @@ -5256,6 +5423,46 @@ } } }, + "com.amazonaws.neptune#DescribeGlobalClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptune#DescribeGlobalClustersMessage" + }, + "output": { + "target": "com.amazonaws.neptune#GlobalClustersMessage" + }, + "errors": [ + { + "target": "com.amazonaws.neptune#GlobalClusterNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about Neptune global database clusters. This API\n supports pagination.

" + } + }, + "com.amazonaws.neptune#DescribeGlobalClustersMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The user-supplied DB cluster identifier. If this parameter is specified,\n only information about the specified DB cluster is returned. This parameter\n is not case-sensitive.

\n\n

Constraints: If supplied, must match an existing DB cluster identifier.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.neptune#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records\n exist than the specified MaxRecords value, a pagination marker token\n is included in the response that you can use to retrieve the remaining results.

\n

Default: 100\n

\n

Constraints: Minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

(Optional) A pagination token returned by a previous\n call to DescribeGlobalClusters. If this parameter is specified,\n the response will only include records beyond the marker, up to the number\n specified by MaxRecords.

" + } + } + } + }, "com.amazonaws.neptune#DescribeOrderableDBInstanceOptions": { "type": "operation", "input": { @@ -5855,6 +6062,59 @@ } } }, + "com.amazonaws.neptune#FailoverGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptune#FailoverGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.neptune#FailoverGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.neptune#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#InvalidDBClusterStateFault" + }, + { + "target": "com.amazonaws.neptune#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates the failover process for a Neptune global database.

\n

A failover for a Neptune global database promotes one of secondary\n read-only DB clusters to be the primary DB cluster and demotes the\n primary DB cluster to being a secondary (read-only) DB cluster. In other\n words, the role of the current primary DB cluster and the selected\n target secondary DB cluster are switched. The selected secondary DB cluster\n assumes full read/write capabilities for the Neptune global database.

\n\n \n

This action applies only to\n Neptune global databases. This action is only intended for use on healthy\n Neptune global databases with healthy Neptune DB clusters and no region-wide\n outages, to test disaster recovery scenarios or to reconfigure the global\n database topology.

\n " + } + }, + "com.amazonaws.neptune#FailoverGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

Identifier of the Neptune global database that should be failed over.\n The identifier is the unique key assigned by the user when the Neptune \n global database was created. In other words, it's the name of the global\n database that you want to fail over.

\n

Constraints: Must match the identifier of an existing Neptune global\n database.

", + "smithy.api#required": {} + } + }, + "TargetDbClusterIdentifier": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secondary Neptune DB cluster\n that you want to promote to primary for the global database.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.neptune#FailoverGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.neptune#GlobalCluster" + } + } + }, "com.amazonaws.neptune#Filter": { "type": "structure", "members": { @@ -5895,6 +6155,199 @@ } } }, + "com.amazonaws.neptune#GlobalCluster": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

Contains a user-supplied global database cluster identifier. This identifier\n is the unique key that identifies a global database.

" + } + }, + "GlobalClusterResourceId": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

An immutable identifier for the global database that is unique within in all\n regions. This identifier is found in CloudTrail log entries whenever the KMS\n key for the DB cluster is accessed.

" + } + }, + "GlobalClusterArn": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the global database.

" + } + }, + "Status": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

Specifies the current state of this global database.

" + } + }, + "Engine": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The Neptune database engine used by the global database\n (\"neptune\").

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The Neptune engine version used by the global database.

" + } + }, + "StorageEncrypted": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The storage encryption setting for the global database.

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

The deletion protection setting for the global database.

" + } + }, + "GlobalClusterMembers": { + "target": "com.amazonaws.neptune#GlobalClusterMemberList", + "traits": { + "smithy.api#documentation": "

A list of cluster ARNs and instance ARNs for all the DB clusters\n that are part of the global database.

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

Contains the details of an Amazon Neptune global database.

\n

This data type is used as a response element for the\n CreateGlobalCluster,\n DescribeGlobalClusters,\n ModifyGlobalCluster,\n DeleteGlobalCluster,\n FailoverGlobalCluster, and\n RemoveFromGlobalCluster actions.

" + } + }, + "com.amazonaws.neptune#GlobalClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.neptune#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

A message describing the details of the problem.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptune#GlobalClusterIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z][0-9A-Za-z-:._]*$" + } + }, + "com.amazonaws.neptune#GlobalClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.neptune#GlobalCluster", + "traits": { + "smithy.api#xmlName": "GlobalClusterMember" + } + } + }, + "com.amazonaws.neptune#GlobalClusterMember": { + "type": "structure", + "members": { + "DBClusterArn": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for each Neptune cluster.\n

" + } + }, + "Readers": { + "target": "com.amazonaws.neptune#ReadersArnList", + "traits": { + "smithy.api#documentation": "

\n The Amazon Resource Name (ARN) for each read-only secondary cluster\n associated with the Neptune global database.\n

" + } + }, + "IsWriter": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

\n Specifies whether the Neptune cluster is the primary cluster\n (that is, has read-write capability) for the Neptune global\n database with which it is associated.\n

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

\n A data structure with information about any primary and\n secondary clusters associated with an Neptune global database.\n

" + } + }, + "com.amazonaws.neptune#GlobalClusterMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.neptune#GlobalClusterMember", + "traits": { + "smithy.api#xmlName": "GlobalClusterMember" + } + } + }, + "com.amazonaws.neptune#GlobalClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.neptune#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

A message describing the details of the problem.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The GlobalClusterIdentifier doesn't refer to an existing global database cluster.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.neptune#GlobalClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.neptune#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

A message describing the details of the problem.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "GlobalClusterQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The number of global database clusters for this account is already at the maximum allowed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptune#GlobalClustersMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

A pagination token. If this parameter is returned in the response,\n more records are available, which can be retrieved by one or more additional\n calls to DescribeGlobalClusters.

" + } + }, + "GlobalClusters": { + "target": "com.amazonaws.neptune#GlobalClusterList", + "traits": { + "smithy.api#documentation": "

The list of global clusters and instances returned by this request.

" + } + } + } + }, "com.amazonaws.neptune#InstanceQuotaExceededFault": { "type": "structure", "members": { @@ -6184,6 +6637,26 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.neptune#InvalidGlobalClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.neptune#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

A message describing the details of the problem.

" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidGlobalClusterStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The global cluster is in an invalid state and can't perform the requested operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.neptune#InvalidRestoreFault": { "type": "structure", "members": { @@ -6488,7 +6961,7 @@ } }, "traits": { - "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Aurora DB cluster.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n ModifyDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DeleteDBClusterEndpoint\n

    \n
    • \n
\n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" + "smithy.api#documentation": "

This data type represents the information you need to connect to an Amazon Neptune DB cluster.\n This data type is used as a response element in the following actions:

\n
    \n
  • \n

    \n CreateDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DescribeDBClusterEndpoints\n

    \n
    • \n
  • \n

    \n ModifyDBClusterEndpoint\n

    \n
    • \n
  • \n

    \n DeleteDBClusterEndpoint\n

    \n
    • \n
\n

For the data structure that represents Amazon RDS DB instance endpoints,\n see Endpoint.

" } }, "com.amazonaws.neptune#ModifyDBClusterMessage": { @@ -7190,6 +7663,70 @@ } } }, + "com.amazonaws.neptune#ModifyGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptune#ModifyGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.neptune#ModifyGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.neptune#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modify a setting for an Amazon Neptune global cluster. You can change one\n or more database configuration parameters by specifying these parameters\n and their new values in the request.

" + } + }, + "com.amazonaws.neptune#ModifyGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The DB cluster identifier for the global cluster being modified. This parameter\n is not case-sensitive.

\n

Constraints: Must match the identifier of an existing global database cluster.

", + "smithy.api#required": {} + } + }, + "NewGlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

A new cluster identifier to assign to the global database. This value is\n stored as a lowercase string.

\n

Constraints:

\n
    \n
  • \n

    Must contain from 1 to 63 letters, numbers, or hyphens.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens

    \n
    • \n
\n

Example: my-cluster2\n

" + } + }, + "DeletionProtection": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the global database has deletion protection enabled. The\n global database cannot be deleted when deletion protection is enabled.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The version number of the database engine to which you want to upgrade.\n Changing this parameter will result in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.

\n

To list all of the available Neptune engine versions, use the following command:

" + } + }, + "AllowMajorVersionUpgrade": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether major version upgrades are allowed.

\n

Constraints: You must allow major version upgrades if you specify a value\n for the EngineVersion parameter that is a different major version\n than the DB cluster's current version.

\n

If you upgrade the major version of a global database, the cluster and\n DB instance parameter groups are set to the default parameter groups for the\n new version, so you will need to apply any custom parameter groups after\n completing the upgrade.

" + } + } + } + }, + "com.amazonaws.neptune#ModifyGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.neptune#GlobalCluster" + } + } + }, "com.amazonaws.neptune#OptionGroupMembership": { "type": "structure", "members": { @@ -7361,6 +7898,12 @@ "traits": { "smithy.api#documentation": "

Maximum provisioned IOPS per GiB for a DB instance.

" } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.neptune#Boolean", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes.

" + } } }, "traits": { @@ -7783,6 +8326,12 @@ } } }, + "com.amazonaws.neptune#ReadersArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.neptune#String" + } + }, "com.amazonaws.neptune#RebootDBInstance": { "type": "operation", "input": { @@ -7829,11 +8378,64 @@ } } }, + "com.amazonaws.neptune#RemoveFromGlobalCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptune#RemoveFromGlobalClusterMessage" + }, + "output": { + "target": "com.amazonaws.neptune#RemoveFromGlobalClusterResult" + }, + "errors": [ + { + "target": "com.amazonaws.neptune#DBClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#GlobalClusterNotFoundFault" + }, + { + "target": "com.amazonaws.neptune#InvalidGlobalClusterStateFault" + } + ], + "traits": { + "smithy.api#documentation": "

Detaches a Neptune DB cluster from a Neptune global database. A secondary\n cluster becomes a normal standalone cluster with read-write capability\n instead of being read-only, and no longer receives data from a the\n primary cluster.

" + } + }, + "com.amazonaws.neptune#RemoveFromGlobalClusterMessage": { + "type": "structure", + "members": { + "GlobalClusterIdentifier": { + "target": "com.amazonaws.neptune#GlobalClusterIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the Neptune global database from which to detach the\n specified Neptune DB cluster.

", + "smithy.api#required": {} + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.neptune#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifying the cluster to be detached\n from the Neptune global database cluster.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.neptune#RemoveFromGlobalClusterResult": { + "type": "structure", + "members": { + "GlobalCluster": { + "target": "com.amazonaws.neptune#GlobalCluster" + } + } + }, "com.amazonaws.neptune#RemoveRoleFromDBCluster": { "type": "operation", "input": { "target": "com.amazonaws.neptune#RemoveRoleFromDBClusterMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.neptune#DBClusterNotFoundFault" @@ -7926,6 +8528,9 @@ "input": { "target": "com.amazonaws.neptune#RemoveTagsFromResourceMessage" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.neptune#DBClusterNotFoundFault" @@ -8964,6 +9569,12 @@ "traits": { "smithy.api#documentation": "

A value that indicates whether a database engine is upgraded to a major version.

" } + }, + "SupportsGlobalDatabases": { + "target": "com.amazonaws.neptune#BooleanOptional", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you can use Neptune global databases with the target engine version.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/outposts.json b/aws/sdk/aws-models/outposts.json index 5e7878c3d..cdfb67610 100644 --- a/aws/sdk/aws-models/outposts.json +++ b/aws/sdk/aws-models/outposts.json @@ -223,6 +223,12 @@ "traits": { "smithy.api#documentation": "

\n Information about compute hardware assets. \n

" } + }, + "AssetLocation": { + "target": "com.amazonaws.outposts#AssetLocation", + "traits": { + "smithy.api#documentation": "

\n The position of an asset in a rack. \n

" + } } }, "traits": { @@ -235,6 +241,20 @@ "target": "com.amazonaws.outposts#AssetInfo" } }, + "com.amazonaws.outposts#AssetLocation": { + "type": "structure", + "members": { + "RackElevation": { + "target": "com.amazonaws.outposts#RackElevation", + "traits": { + "smithy.api#documentation": "

\n The position of an asset in a rack measured in rack units.\n

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

\n Information about the position of the asset in a rack. \n

" + } + }, "com.amazonaws.outposts#AssetType": { "type": "string", "traits": { @@ -292,6 +312,22 @@ } } }, + "com.amazonaws.outposts#CIDR": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 18 + }, + "smithy.api#pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}/[0-9]{1,2}$" + } + }, + "com.amazonaws.outposts#CIDRList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#CIDR" + } + }, "com.amazonaws.outposts#CancelOrder": { "type": "operation", "input": { @@ -502,6 +538,60 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.outposts#ConnectionDetails": { + "type": "structure", + "members": { + "ClientPublicKey": { + "target": "com.amazonaws.outposts#WireGuardPublicKey", + "traits": { + "smithy.api#documentation": "

\n The public key of the client.\n

" + } + }, + "ServerPublicKey": { + "target": "com.amazonaws.outposts#WireGuardPublicKey", + "traits": { + "smithy.api#documentation": "

\n The public key of the server.\n

" + } + }, + "ServerEndpoint": { + "target": "com.amazonaws.outposts#ServerEndpoint", + "traits": { + "smithy.api#documentation": "

\n The endpoint for the server.\n

" + } + }, + "ClientTunnelAddress": { + "target": "com.amazonaws.outposts#CIDR", + "traits": { + "smithy.api#documentation": "

\n The client tunnel address. \n

" + } + }, + "ServerTunnelAddress": { + "target": "com.amazonaws.outposts#CIDR", + "traits": { + "smithy.api#documentation": "

\n The server tunnel address.\n

" + } + }, + "AllowedIps": { + "target": "com.amazonaws.outposts#CIDRList", + "traits": { + "smithy.api#documentation": "

\n The allowed IP addresses.\n

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

\n Information about a connection. \n

" + } + }, + "com.amazonaws.outposts#ConnectionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^([\\w-]+)$" + } + }, "com.amazonaws.outposts#ContactName": { "type": "string", "traits": { @@ -890,6 +980,16 @@ "type": "structure", "members": {} }, + "com.amazonaws.outposts#DeviceSerialNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^(\\w+)$" + } + }, "com.amazonaws.outposts#DistrictOrCounty": { "type": "string", "traits": { @@ -1025,6 +1125,67 @@ } } }, + "com.amazonaws.outposts#GetConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#GetConnectionRequest" + }, + "output": { + "target": "com.amazonaws.outposts#GetConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n

\n Amazon Web Services uses this action to install Outpost servers.

\n \n

\n Gets information about a specified connection.\n

\n

\n Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For \n more information, see \n Amazon Web Services managed policies for Amazon Web Services Outposts and \n Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.\n

", + "smithy.api#http": { + "method": "GET", + "uri": "/connections/{ConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.outposts#GetConnectionRequest": { + "type": "structure", + "members": { + "ConnectionId": { + "target": "com.amazonaws.outposts#ConnectionId", + "traits": { + "smithy.api#documentation": "

\n The ID of the connection you request.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#GetConnectionResponse": { + "type": "structure", + "members": { + "ConnectionId": { + "target": "com.amazonaws.outposts#ConnectionId", + "traits": { + "smithy.api#documentation": "

\n The ID of the connection you receive.\n

" + } + }, + "ConnectionDetails": { + "target": "com.amazonaws.outposts#ConnectionDetails", + "traits": { + "smithy.api#documentation": "

\n Information about a connection.\n

" + } + } + } + }, "com.amazonaws.outposts#GetOrder": { "type": "operation", "input": { @@ -2053,6 +2214,15 @@ "smithy.api#pattern": "^\\S[\\S ]*$" } }, + "com.amazonaws.outposts#NetworkInterfaceDeviceIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.outposts#NotFoundException": { "type": "structure", "members": { @@ -2459,6 +2629,9 @@ { "target": "com.amazonaws.outposts#GetCatalogItem" }, + { + "target": "com.amazonaws.outposts#GetConnection" + }, { "target": "com.amazonaws.outposts#GetOrder" }, @@ -2492,6 +2665,9 @@ { "target": "com.amazonaws.outposts#ListTagsForResource" }, + { + "target": "com.amazonaws.outposts#StartConnection" + }, { "target": "com.amazonaws.outposts#TagResource" }, @@ -2638,6 +2814,16 @@ "com.amazonaws.outposts#Quantity": { "type": "string" }, + "com.amazonaws.outposts#RackElevation": { + "type": "float", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 99 + } + } + }, "com.amazonaws.outposts#RackId": { "type": "string", "traits": { @@ -2725,6 +2911,16 @@ ] } }, + "com.amazonaws.outposts#ServerEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 9, + "max": 21 + }, + "smithy.api#pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}:[0-9]{1,5}$" + } + }, "com.amazonaws.outposts#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -2861,6 +3057,87 @@ "smithy.api#pattern": "^OR-[A-Z0-9]{7}$" } }, + "com.amazonaws.outposts#StartConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.outposts#StartConnectionRequest" + }, + "output": { + "target": "com.amazonaws.outposts#StartConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.outposts#AccessDeniedException" + }, + { + "target": "com.amazonaws.outposts#InternalServerException" + }, + { + "target": "com.amazonaws.outposts#NotFoundException" + }, + { + "target": "com.amazonaws.outposts#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n

\n Amazon Web Services uses this action to install Outpost servers.

\n \n

\n Starts the connection required for Outpost server installation. \n

\n

\n Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For \n more information, see \n Amazon Web Services managed policies for Amazon Web Services Outposts and \n Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/connections", + "code": 200 + } + } + }, + "com.amazonaws.outposts#StartConnectionRequest": { + "type": "structure", + "members": { + "DeviceSerialNumber": { + "target": "com.amazonaws.outposts#DeviceSerialNumber", + "traits": { + "smithy.api#documentation": "

\n The serial number of the dongle. \n

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

\n The ID of the Outpost server. \n

", + "smithy.api#required": {} + } + }, + "ClientPublicKey": { + "target": "com.amazonaws.outposts#WireGuardPublicKey", + "traits": { + "smithy.api#documentation": "

\n The public key of the client.\n

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

\n The device index of the network interface on the Outpost server.\n

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.outposts#StartConnectionResponse": { + "type": "structure", + "members": { + "ConnectionId": { + "target": "com.amazonaws.outposts#ConnectionId", + "traits": { + "smithy.api#documentation": "

\n The ID of the connection.\n

" + } + }, + "UnderlayIpAddress": { + "target": "com.amazonaws.outposts#UnderlayIpAddress", + "traits": { + "smithy.api#documentation": "

\n The underlay IP address. \n

" + } + } + } + }, "com.amazonaws.outposts#StateOrRegion": { "type": "string", "traits": { @@ -3042,6 +3319,16 @@ "smithy.api#pattern": "^(\\d+)##(\\S+)$" } }, + "com.amazonaws.outposts#UnderlayIpAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 15 + }, + "smithy.api#pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}$" + } + }, "com.amazonaws.outposts#UntagResource": { "type": "operation", "input": { @@ -3499,6 +3786,16 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.outposts#WireGuardPublicKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 44, + "max": 44 + }, + "smithy.api#pattern": "^[a-zA-Z0-9/+]{43}=$" + } + }, "com.amazonaws.outposts#outpostListDefinition": { "type": "list", "member": { diff --git a/aws/sdk/aws-models/proton.json b/aws/sdk/aws-models/proton.json index 969364b98..5acc84027 100644 --- a/aws/sdk/aws-models/proton.json +++ b/aws/sdk/aws-models/proton.json @@ -144,6 +144,9 @@ }, "version": "2020-07-20", "operations": [ + { + "target": "com.amazonaws.proton#CancelComponentDeployment" + }, { "target": "com.amazonaws.proton#CancelEnvironmentDeployment" }, @@ -179,6 +182,15 @@ { "target": "com.amazonaws.proton#AccountSettingsResource" }, + { + "target": "com.amazonaws.proton#ComponentOutputResource" + }, + { + "target": "com.amazonaws.proton#ComponentProvisionedResourceResource" + }, + { + "target": "com.amazonaws.proton#ComponentResource" + }, { "target": "com.amazonaws.proton#EnvironmentAccountConnectionResource" }, @@ -232,6 +244,72 @@ } ] }, + "com.amazonaws.proton#CancelComponentDeployment": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#CancelComponentDeploymentInput" + }, + "output": { + "target": "com.amazonaws.proton#CancelComponentDeploymentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

" + } + }, + "com.amazonaws.proton#CancelComponentDeploymentInput": { + "type": "structure", + "members": { + "componentName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component with the deployment to cancel.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.proton#ComponentResource", + "ids": { + "name": "componentName" + } + } + ] + } + }, + "com.amazonaws.proton#CancelComponentDeploymentOutput": { + "type": "structure", + "members": { + "component": { + "target": "com.amazonaws.proton#Component", + "traits": { + "smithy.api#documentation": "

The detailed data of the component with the deployment that is being canceled.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.proton#CancelEnvironmentDeployment": { "type": "operation", "input": { @@ -436,93 +514,464 @@ "smithy.api#required": {} } } - } - }, - "com.amazonaws.proton#ClientToken": { - "type": "string", + } + }, + "com.amazonaws.proton#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 64 + }, + "smithy.api#pattern": "^[!-~]*$" + } + }, + "com.amazonaws.proton#CompatibleEnvironmentTemplate": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The compatible environment template name.

", + "smithy.api#required": {} + } + }, + "majorVersion": { + "target": "com.amazonaws.proton#TemplateVersionPart", + "traits": { + "smithy.api#documentation": "

The major version of the compatible environment template.

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

Compatible environment template data.

" + } + }, + "com.amazonaws.proton#CompatibleEnvironmentTemplateInput": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The compatible environment template name.

", + "smithy.api#required": {} + } + }, + "majorVersion": { + "target": "com.amazonaws.proton#TemplateVersionPart", + "traits": { + "smithy.api#documentation": "

The major version of the compatible environment template.

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

Compatible environment template data.

" + } + }, + "com.amazonaws.proton#CompatibleEnvironmentTemplateInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#CompatibleEnvironmentTemplateInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.proton#CompatibleEnvironmentTemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#CompatibleEnvironmentTemplate" + } + }, + "com.amazonaws.proton#Component": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.proton#Description", + "traits": { + "smithy.api#documentation": "

A description of the component.

" + } + }, + "arn": { + "target": "com.amazonaws.proton#ComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", + "smithy.api#required": {} + } + }, + "environmentName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Proton environment that this component is associated with.

", + "smithy.api#required": {} + } + }, + "serviceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

" + } + }, + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

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

The time when the component was created.

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

The time when the component was last modified.

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

The time when a deployment of the component was last attempted.

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

The time when the component was last deployed successfully.

" + } + }, + "deploymentStatus": { + "target": "com.amazonaws.proton#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The component deployment status.

", + "smithy.api#required": {} + } + }, + "deploymentStatusMessage": { + "target": "com.amazonaws.proton#StatusMessage", + "traits": { + "smithy.api#documentation": "

The message associated with the component deployment status.

" + } + }, + "serviceSpec": { + "target": "com.amazonaws.proton#SpecContents", + "traits": { + "smithy.api#documentation": "

The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

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

Detailed data of an Proton component resource.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

" + } + }, + "com.amazonaws.proton#ComponentArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "resource": "com.amazonaws.proton#ComponentResource" + } + } + }, + "com.amazonaws.proton#ComponentDeploymentUpdateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "CURRENT_VERSION", + "name": "CURRENT_VERSION" + } + ] + } + }, + "com.amazonaws.proton#ComponentOutputResource": { + "type": "resource", + "identifiers": { + "componentName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "key": { + "target": "com.amazonaws.proton#OutputKey" + } + }, + "list": { + "target": "com.amazonaws.proton#ListComponentOutputs" + } + }, + "com.amazonaws.proton#ComponentProvisionedResourceResource": { + "type": "resource", + "identifiers": { + "componentName": { + "target": "com.amazonaws.proton#ResourceName" + }, + "name": { + "target": "com.amazonaws.proton#ProvisionedResourceName" + } + }, + "list": { + "target": "com.amazonaws.proton#ListComponentProvisionedResources" + } + }, + "com.amazonaws.proton#ComponentResource": { + "type": "resource", + "identifiers": { + "name": { + "target": "com.amazonaws.proton#ResourceName" + } + }, + "put": { + "target": "com.amazonaws.proton#CreateComponent" + }, + "read": { + "target": "com.amazonaws.proton#GetComponent" + }, + "update": { + "target": "com.amazonaws.proton#UpdateComponent" + }, + "delete": { + "target": "com.amazonaws.proton#DeleteComponent" + }, + "list": { + "target": "com.amazonaws.proton#ListComponents" + }, + "traits": { + "aws.api#arn": { + "template": "component/{name}", + "absolute": false, + "noAccount": false, + "noRegion": false + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.proton#ComponentSummary": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.proton#ComponentArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the component.

", + "smithy.api#required": {} + } + }, + "environmentName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Proton environment that this component is associated with.

", + "smithy.api#required": {} + } + }, + "serviceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

" + } + }, + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

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

The time when the component was created.

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

The time when the component was last modified.

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

The time when a deployment of the component was last attempted.

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

The time when the component was last deployed successfully.

" + } + }, + "deploymentStatus": { + "target": "com.amazonaws.proton#DeploymentStatus", + "traits": { + "smithy.api#documentation": "

The component deployment status.

", + "smithy.api#required": {} + } + }, + "deploymentStatusMessage": { + "target": "com.amazonaws.proton#StatusMessage", + "traits": { + "smithy.api#documentation": "

The message associated with the component deployment status.

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

Summary data of an Proton component resource.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

" + } + }, + "com.amazonaws.proton#ComponentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#ComponentSummary" + } + }, + "com.amazonaws.proton#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.proton#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request couldn't be made due to a conflicting operation or resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.proton#CreateComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#CreateComponentInput" + }, + "output": { + "target": "com.amazonaws.proton#CreateComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "max": 64 - }, - "smithy.api#pattern": "^[!-~]*$" + "smithy.api#documentation": "

Create an Proton component. A component is an infrastructure extension for a service instance.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

", + "smithy.api#idempotent": {} } }, - "com.amazonaws.proton#CompatibleEnvironmentTemplate": { + "com.amazonaws.proton#CreateComponentInput": { "type": "structure", "members": { - "templateName": { + "name": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The compatible environment template name.

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

The customer-provided name of the component.

", "smithy.api#required": {} } }, - "majorVersion": { - "target": "com.amazonaws.proton#TemplateVersionPart", + "description": { + "target": "com.amazonaws.proton#Description", "traits": { - "smithy.api#documentation": "

The major version of the compatible environment template.

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

An optional customer-provided description of the component.

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

Compatible environment template data.

" - } - }, - "com.amazonaws.proton#CompatibleEnvironmentTemplateInput": { - "type": "structure", - "members": { - "templateName": { + }, + "serviceName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The compatible environment template name.

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

The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any\n service instance. Specify both serviceInstanceName and serviceName or neither of them.

" + } + }, + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service\n instance. Specify both serviceInstanceName and serviceName or neither of them.

" + } + }, + "environmentName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify\n serviceInstanceName and serviceName.

" + } + }, + "templateFile": { + "target": "com.amazonaws.proton#TemplateFileContents", + "traits": { + "smithy.api#documentation": "

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

\n \n

Components support a single IaC file, even if you use Terraform as your template language.

\n ", "smithy.api#required": {} } }, - "majorVersion": { - "target": "com.amazonaws.proton#TemplateVersionPart", + "manifest": { + "target": "com.amazonaws.proton#TemplateManifestContents", "traits": { - "smithy.api#documentation": "

The major version of the compatible environment template.

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

A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom\n component provisions.

", "smithy.api#required": {} } + }, + "serviceSpec": { + "target": "com.amazonaws.proton#SpecContents", + "traits": { + "smithy.api#documentation": "

The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service\n instance.

" + } + }, + "tags": { + "target": "com.amazonaws.proton#TagList", + "traits": { + "smithy.api#documentation": "

An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

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

Compatible environment template data.

" - } - }, - "com.amazonaws.proton#CompatibleEnvironmentTemplateInputList": { - "type": "list", - "member": { - "target": "com.amazonaws.proton#CompatibleEnvironmentTemplateInput" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.proton#CompatibleEnvironmentTemplateList": { - "type": "list", - "member": { - "target": "com.amazonaws.proton#CompatibleEnvironmentTemplate" } }, - "com.amazonaws.proton#ConflictException": { + "com.amazonaws.proton#CreateComponentOutput": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.proton#ErrorMessage", + "component": { + "target": "com.amazonaws.proton#Component", "traits": { + "smithy.api#documentation": "

The detailed data of the created component.

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

The request couldn't be made due to a conflicting operation or resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 } }, "com.amazonaws.proton#CreateEnvironment": { @@ -630,6 +1079,12 @@ "traits": { "smithy.api#documentation": "

An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the\n Proton Administrator Guide.

" } + }, + "componentRoleArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.

\n

You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this\n account.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

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

The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.

\n

To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and\n protonServiceRoleArn parameters.

" } + }, + "componentRoleArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.

\n

You must specify componentRoleArn to allow directly defined components to be associated with this environment.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

" + } } } }, @@ -1267,7 +1728,7 @@ "compatibleEnvironmentTemplates": { "target": "com.amazonaws.proton#CompatibleEnvironmentTemplateInputList", "traits": { - "smithy.api#documentation": "

An array of compatible environment template objects for the new version of a service template.

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

An array of environment template objects that are compatible with the new service template version. A service instance based on this service template\n version can run in environments based on compatible templates.

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

An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.

\n

For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.

" } + }, + "supportedComponentSources": { + "target": "com.amazonaws.proton#ServiceTemplateSupportedComponentSourceInputList", + "traits": { + "smithy.api#documentation": "

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

" + } } } }, @@ -1381,6 +1848,69 @@ } } }, + "com.amazonaws.proton#DeleteComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#DeleteComponentInput" + }, + "output": { + "target": "com.amazonaws.proton#DeleteComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete an Proton component resource.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.proton#DeleteComponentInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.proton#ComponentResource" + } + ] + } + }, + "com.amazonaws.proton#DeleteComponentOutput": { + "type": "structure", + "members": { + "component": { + "target": "com.amazonaws.proton#Component", + "traits": { + "smithy.api#documentation": "

The detailed data of the component being deleted.

" + } + } + } + }, "com.amazonaws.proton#DeleteEnvironment": { "type": "operation", "input": { @@ -1472,7 +2002,7 @@ "environmentAccountConnection": { "target": "com.amazonaws.proton#EnvironmentAccountConnection", "traits": { - "smithy.api#documentation": "

The environment account connection detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the environment account connection being deleted.

" } } } @@ -1502,7 +2032,7 @@ "environment": { "target": "com.amazonaws.proton#Environment", "traits": { - "smithy.api#documentation": "

The environment detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the environment being deleted.

" } } } @@ -1565,7 +2095,7 @@ "environmentTemplate": { "target": "com.amazonaws.proton#EnvironmentTemplate", "traits": { - "smithy.api#documentation": "

The environment template detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the environment template being deleted.

" } } } @@ -1642,7 +2172,7 @@ "environmentTemplateVersion": { "target": "com.amazonaws.proton#EnvironmentTemplateVersion", "traits": { - "smithy.api#documentation": "

The environment template version detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the environment template version being deleted.

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

Delete a service.

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

Delete a service, with its instances and pipeline.

\n \n

You can't delete a service if it has any service instances that have components attached to them.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

\n ", "smithy.api#idempotent": {} } }, @@ -1775,7 +2305,7 @@ "service": { "target": "com.amazonaws.proton#Service", "traits": { - "smithy.api#documentation": "

The service detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the service being deleted.

" } } } @@ -1838,7 +2368,7 @@ "serviceTemplate": { "target": "com.amazonaws.proton#ServiceTemplate", "traits": { - "smithy.api#documentation": "

The service template detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the service template being deleted.

" } } } @@ -1915,7 +2445,7 @@ "serviceTemplateVersion": { "target": "com.amazonaws.proton#ServiceTemplateVersion", "traits": { - "smithy.api#documentation": "

The service template version detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the service template version being deleted.

" } } } @@ -2193,10 +2723,16 @@ "traits": { "smithy.api#documentation": "

The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.

" } + }, + "componentRoleArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.

\n

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

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

The environment detail data. An Proton environment is a set resources shared across an Proton service.

" + "smithy.api#documentation": "

Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

" } }, "com.amazonaws.proton#EnvironmentAccountConnection": { @@ -2264,10 +2800,16 @@ "smithy.api#documentation": "

The status of the environment account connection.

", "smithy.api#required": {} } + }, + "componentRoleArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.

\n

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

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

The environment account connection detail data.

" + "smithy.api#documentation": "

Detailed data of an Proton environment account connection resource.

" } }, "com.amazonaws.proton#EnvironmentAccountConnectionArn": { @@ -2428,10 +2970,16 @@ "smithy.api#documentation": "

The status of the environment account connection.

", "smithy.api#required": {} } + }, + "componentRoleArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.

\n

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

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

A summary of the environment account connection detail data.

" + "smithy.api#documentation": "

Summary data of an Proton environment account connection resource.

" } }, "com.amazonaws.proton#EnvironmentAccountConnectionSummaryList": { @@ -2609,10 +3157,16 @@ "traits": { "smithy.api#documentation": "

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

" } + }, + "componentRoleArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.

\n

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

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

A summary of the environment detail data.

" + "smithy.api#documentation": "

Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

" } }, "com.amazonaws.proton#EnvironmentSummaryList": { @@ -3068,23 +3622,135 @@ { "target": "com.amazonaws.proton#ValidationException" } - ], - "traits": { - "smithy.api#documentation": "

Get detail data for the Proton pipeline service role.

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

Get detail data for the Proton pipeline service role.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#GetAccountSettingsInput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.proton#GetAccountSettingsOutput": { + "type": "structure", + "members": { + "accountSettings": { + "target": "com.amazonaws.proton#AccountSettings", + "traits": { + "smithy.api#documentation": "

The Proton pipeline service role detail data that's returned by Proton.

" + } + } + } + }, + "com.amazonaws.proton#GetComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#GetComponentInput" + }, + "output": { + "target": "com.amazonaws.proton#GetComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get detailed data for a component.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

", + "smithy.api#readonly": {}, + "smithy.waiters#waitable": { + "ComponentDeployed": { + "documentation": "Wait until a Component is deployed. Use this after invoking CreateComponent or UpdateComponent", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "component.deploymentStatus", + "expected": "SUCCEEDED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "component.deploymentStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 4999 + }, + "ComponentDeleted": { + "documentation": "Wait until a Component is deleted. Use this after invoking DeleteComponent", + "acceptors": [ + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "component.deploymentStatus", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 5, + "maxDelay": 4999 + } + } } }, - "com.amazonaws.proton#GetAccountSettingsInput": { + "com.amazonaws.proton#GetComponentInput": { "type": "structure", - "members": {} + "members": { + "name": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component that you want to get the detailed data for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.proton#ComponentResource" + } + ] + } }, - "com.amazonaws.proton#GetAccountSettingsOutput": { + "com.amazonaws.proton#GetComponentOutput": { "type": "structure", "members": { - "accountSettings": { - "target": "com.amazonaws.proton#AccountSettings", + "component": { + "target": "com.amazonaws.proton#Component", "traits": { - "smithy.api#documentation": "

The Proton pipeline service role detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the requested component.

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

Get detail data for an environment.

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

Get detailed data for an environment.

", "smithy.api#readonly": {}, "smithy.waiters#waitable": { "EnvironmentDeployed": { @@ -3174,7 +3840,7 @@ } ], "traits": { - "smithy.api#documentation": "

In an environment account, view the detail data for an environment account connection.

\n

For more information, see Environment account\n connections in the Proton Administrator guide.

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

In an environment account, get the detailed data for an environment account connection.

\n

For more information, see Environment account\n connections in the Proton Administrator guide.

", "smithy.api#readonly": {} } }, @@ -3184,7 +3850,7 @@ "id": { "target": "com.amazonaws.proton#EnvironmentAccountConnectionId", "traits": { - "smithy.api#documentation": "

The ID of the environment account connection.

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

The ID of the environment account connection that you want to get the detailed data for.

", "smithy.api#required": {} } } @@ -3203,7 +3869,7 @@ "environmentAccountConnection": { "target": "com.amazonaws.proton#EnvironmentAccountConnection", "traits": { - "smithy.api#documentation": "

The environment account connection detail data that's returned by Proton.

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

The detailed data of the requested environment account connection.

", "smithy.api#required": {} } } @@ -3215,7 +3881,7 @@ "name": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the environment that you want to get the detail data for.

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

The name of the environment that you want to get the detailed data for.

", "smithy.api#required": {} } } @@ -3234,7 +3900,7 @@ "environment": { "target": "com.amazonaws.proton#Environment", "traits": { - "smithy.api#documentation": "

The environment detail data that's returned by Proton.

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

The detailed data of the requested environment.

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

Get detail data for an environment template.

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

Get detailed data for an environment template.

", "smithy.api#readonly": {} } }, @@ -3276,7 +3942,7 @@ "name": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the environment template that you want to get the detail data for.

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

The name of the environment template that you want to get the detailed data for.

", "smithy.api#required": {} } } @@ -3288,7 +3954,7 @@ "environmentTemplate": { "target": "com.amazonaws.proton#EnvironmentTemplate", "traits": { - "smithy.api#documentation": "

The environment template detail data that's returned by Proton.

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

The detailed data of the requested environment template.

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

View detail data for a major or minor version of an environment template.

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

Get detailed data for a major or minor version of an environment template.

", "smithy.api#readonly": {}, "smithy.waiters#waitable": { "EnvironmentTemplateVersionRegistered": { @@ -3368,21 +4034,21 @@ "templateName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the environment template.

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

The name of the environment template a version of which you want to get detailed data for..

", "smithy.api#required": {} } }, "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "

To view environment template major version detail data, include major Version.

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

To get environment template major version detail data, include major Version.

", "smithy.api#required": {} } }, "minorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "

To view environment template minor version detail data, include minorVersion.

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

To get environment template minor version detail data, include minorVersion.

", "smithy.api#required": {} } } @@ -3401,7 +4067,7 @@ "environmentTemplateVersion": { "target": "com.amazonaws.proton#EnvironmentTemplateVersion", "traits": { - "smithy.api#documentation": "

The environment template version detail data that's returned by Proton.

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

The detailed data of the requested environment template version.

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

Get detail data for a service.

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

Get detailed data for a service.

", "smithy.api#readonly": {}, "smithy.waiters#waitable": { "ServiceCreated": { @@ -3740,7 +4406,7 @@ "name": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the service that you want to get the detail data for.

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

The name of the service that you want to get the detailed data for.

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

Get detail data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

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

Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

", "smithy.api#readonly": {}, "smithy.waiters#waitable": { "ServiceInstanceDeployed": { @@ -3818,7 +4484,7 @@ "name": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The name of a service instance that you want to get the detail data for.

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

The name of a service instance that you want to get the detailed data for.

", "smithy.api#required": {} } }, @@ -3844,7 +4510,7 @@ "serviceInstance": { "target": "com.amazonaws.proton#ServiceInstance", "traits": { - "smithy.api#documentation": "

The service instance detail data that's returned by Proton.

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

The detailed data of the requested service instance.

", "smithy.api#required": {} } } @@ -3856,7 +4522,7 @@ "service": { "target": "com.amazonaws.proton#Service", "traits": { - "smithy.api#documentation": "

The service detail data that's returned by Proton.

" + "smithy.api#documentation": "

The detailed data of the requested service.

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

Get detail data for a service template.

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

Get detailed data for a service template.

", "smithy.api#readonly": {} } }, @@ -3897,7 +4563,7 @@ "name": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the service template that you want to get detail data for.

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

The name of the service template that you want to get detailed data for.

", "smithy.api#required": {} } } @@ -3916,7 +4582,7 @@ "serviceTemplate": { "target": "com.amazonaws.proton#ServiceTemplate", "traits": { - "smithy.api#documentation": "

The service template detail data that's returned by Proton.

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

The detailed data of the requested service template.

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

View detail data for a major or minor version of a service template.

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

Get detailed data for a major or minor version of a service template.

", "smithy.api#readonly": {}, "smithy.waiters#waitable": { "ServiceTemplateVersionRegistered": { @@ -3996,21 +4662,21 @@ "templateName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the service template.

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

The name of the service template a version of which you want to get detailed data for.

", "smithy.api#required": {} } }, "majorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "

To view service template major version detail data, include major Version.

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

To get service template major version detail data, include major Version.

", "smithy.api#required": {} } }, "minorVersion": { "target": "com.amazonaws.proton#TemplateVersionPart", "traits": { - "smithy.api#documentation": "

To view service template minor version detail data, include minorVersion.

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

To get service template minor version detail data, include minorVersion.

", "smithy.api#required": {} } } @@ -4029,19 +4695,254 @@ "serviceTemplateVersion": { "target": "com.amazonaws.proton#ServiceTemplateVersion", "traits": { - "smithy.api#documentation": "

The service template version detail data that's returned by Proton.

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

The detailed data of the requested service template version.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#GetTemplateSyncConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#GetTemplateSyncConfigInput" + }, + "output": { + "target": "com.amazonaws.proton#GetTemplateSyncConfigOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get detail data for a template sync configuration.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#GetTemplateSyncConfigInput": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The template name.

", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.proton#TemplateType", + "traits": { + "smithy.api#documentation": "

The template type.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#GetTemplateSyncConfigOutput": { + "type": "structure", + "members": { + "templateSyncConfig": { + "target": "com.amazonaws.proton#TemplateSyncConfig", + "traits": { + "smithy.api#documentation": "

The template sync configuration detail data that's returned by Proton.

" + } + } + } + }, + "com.amazonaws.proton#GetTemplateSyncStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#GetTemplateSyncStatusInput" + }, + "output": { + "target": "com.amazonaws.proton#GetTemplateSyncStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the status of a template sync.

" + } + }, + "com.amazonaws.proton#GetTemplateSyncStatusInput": { + "type": "structure", + "members": { + "templateName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The template name.

", + "smithy.api#required": {} + } + }, + "templateType": { + "target": "com.amazonaws.proton#TemplateType", + "traits": { + "smithy.api#documentation": "

The template type.

", + "smithy.api#required": {} + } + }, + "templateVersion": { + "target": "com.amazonaws.proton#TemplateVersionPart", + "traits": { + "smithy.api#documentation": "

The template major version.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.proton#GetTemplateSyncStatusOutput": { + "type": "structure", + "members": { + "latestSync": { + "target": "com.amazonaws.proton#ResourceSyncAttempt", + "traits": { + "smithy.api#documentation": "

The details of the last sync that's returned by Proton.

" + } + }, + "latestSuccessfulSync": { + "target": "com.amazonaws.proton#ResourceSyncAttempt", + "traits": { + "smithy.api#documentation": "

The details of the last successful sync that's returned by Proton.

" + } + }, + "desiredState": { + "target": "com.amazonaws.proton#Revision", + "traits": { + "smithy.api#documentation": "

The template sync desired state that's returned by Proton.

" + } + } + } + }, + "com.amazonaws.proton#GitBranchName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.proton#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.proton#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request failed to register with the service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.proton#ListComponentOutputs": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#ListComponentOutputsInput" + }, + "output": { + "target": "com.amazonaws.proton#ListComponentOutputsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a list of component Infrastructure as Code (IaC) outputs.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "outputs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.proton#ListComponentOutputsInput": { + "type": "structure", + "members": { + "componentName": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component whose outputs you want.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

" + } + } + } + }, + "com.amazonaws.proton#ListComponentOutputsOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

" + } + }, + "outputs": { + "target": "com.amazonaws.proton#OutputsList", + "traits": { + "smithy.api#documentation": "

An array of component Infrastructure as Code (IaC) outputs.

", "smithy.api#required": {} } } } }, - "com.amazonaws.proton#GetTemplateSyncConfig": { + "com.amazonaws.proton#ListComponentProvisionedResources": { "type": "operation", "input": { - "target": "com.amazonaws.proton#GetTemplateSyncConfigInput" + "target": "com.amazonaws.proton#ListComponentProvisionedResourcesInput" }, "output": { - "target": "com.amazonaws.proton#GetTemplateSyncConfigOutput" + "target": "com.amazonaws.proton#ListComponentProvisionedResourcesOutput" }, "errors": [ { @@ -4061,47 +4962,58 @@ } ], "traits": { - "smithy.api#documentation": "

Get detail data for a template sync configuration.

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

List provisioned resources for a component with details.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "provisionedResources" + }, "smithy.api#readonly": {} } }, - "com.amazonaws.proton#GetTemplateSyncConfigInput": { + "com.amazonaws.proton#ListComponentProvisionedResourcesInput": { "type": "structure", "members": { - "templateName": { + "componentName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The template name.

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

The name of the component whose provisioned resources you want.

", "smithy.api#required": {} } }, - "templateType": { - "target": "com.amazonaws.proton#TemplateType", + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", "traits": { - "smithy.api#documentation": "

The template type.

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

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources\n that was previously requested.

" } } } }, - "com.amazonaws.proton#GetTemplateSyncConfigOutput": { + "com.amazonaws.proton#ListComponentProvisionedResourcesOutput": { "type": "structure", "members": { - "templateSyncConfig": { - "target": "com.amazonaws.proton#TemplateSyncConfig", + "nextToken": { + "target": "com.amazonaws.proton#EmptyNextToken", "traits": { - "smithy.api#documentation": "

The template sync configuration detail data that's returned by Proton.

" + "smithy.api#documentation": "

A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of\n provisioned resources.

" + } + }, + "provisionedResources": { + "target": "com.amazonaws.proton#ProvisionedResourceList", + "traits": { + "smithy.api#documentation": "

An array of provisioned resources for a component.

", + "smithy.api#required": {} } } } }, - "com.amazonaws.proton#GetTemplateSyncStatus": { + "com.amazonaws.proton#ListComponents": { "type": "operation", "input": { - "target": "com.amazonaws.proton#GetTemplateSyncStatusInput" + "target": "com.amazonaws.proton#ListComponentsInput" }, "output": { - "target": "com.amazonaws.proton#GetTemplateSyncStatusOutput" + "target": "com.amazonaws.proton#ListComponentsOutput" }, "errors": [ { @@ -4110,9 +5022,6 @@ { "target": "com.amazonaws.proton#InternalServerException" }, - { - "target": "com.amazonaws.proton#ResourceNotFoundException" - }, { "target": "com.amazonaws.proton#ThrottlingException" }, @@ -4121,82 +5030,67 @@ } ], "traits": { - "smithy.api#documentation": "

Get the status of a template sync.

" + "smithy.api#documentation": "

List components with summary data. You can filter the result list by environment, service, or a single service instance.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "components", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.proton#GetTemplateSyncStatusInput": { + "com.amazonaws.proton#ListComponentsInput": { "type": "structure", "members": { - "templateName": { - "target": "com.amazonaws.proton#ResourceName", + "nextToken": { + "target": "com.amazonaws.proton#NextToken", "traits": { - "smithy.api#documentation": "

The template name.

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

A token that indicates the location of the next component in the array of components, after the list of components that was previously\n requested.

" } }, - "templateType": { - "target": "com.amazonaws.proton#TemplateType", + "environmentName": { + "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The template type.

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

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances\n running in it.

" } }, - "templateVersion": { - "target": "com.amazonaws.proton#TemplateVersionPart", - "traits": { - "smithy.api#documentation": "

The template major version.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.proton#GetTemplateSyncStatusOutput": { - "type": "structure", - "members": { - "latestSync": { - "target": "com.amazonaws.proton#ResourceSyncAttempt", + "serviceName": { + "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The details of the last sync that's returned by Proton.

" + "smithy.api#documentation": "

The name of a service for result list filtering. Proton returns components attached to service instances of the service.

" } }, - "latestSuccessfulSync": { - "target": "com.amazonaws.proton#ResourceSyncAttempt", + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The details of the last successful sync that's returned by Proton.

" + "smithy.api#documentation": "

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

" } }, - "desiredState": { - "target": "com.amazonaws.proton#Revision", + "maxResults": { + "target": "com.amazonaws.proton#MaxPageResults", "traits": { - "smithy.api#documentation": "

The template sync desired state that's returned by Proton.

" + "smithy.api#documentation": "

The maximum number of components to list.

" } } } }, - "com.amazonaws.proton#GitBranchName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.proton#InternalServerException": { + "com.amazonaws.proton#ListComponentsOutput": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.proton#ErrorMessage", + "nextToken": { + "target": "com.amazonaws.proton#NextToken", + "traits": { + "smithy.api#documentation": "

A token that indicates the location of the next component in the array of components, after the current requested list of components.

" + } + }, + "components": { + "target": "com.amazonaws.proton#ComponentSummaryList", "traits": { + "smithy.api#documentation": "

An array of components with summary data.

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

The request failed to register with the service.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500, - "smithy.api#retryable": {} } }, "com.amazonaws.proton#ListEnvironmentAccountConnections": { @@ -4836,7 +5730,7 @@ } ], "traits": { - "smithy.api#documentation": "

View a list service instance infrastructure as code outputs with detail data.

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

Get a list service of instance Infrastructure as Code (IaC) outputs.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -4851,14 +5745,14 @@ "serviceInstanceName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The service instance name.

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

The name of the service instance whose outputs you want.

", "smithy.api#required": {} } }, "serviceName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The service name.

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

The name of the service that serviceInstanceName is associated to.

", "smithy.api#required": {} } }, @@ -4882,7 +5776,7 @@ "outputs": { "target": "com.amazonaws.proton#OutputsList", "traits": { - "smithy.api#documentation": "

An array of service instance infrastructure as code outputs.

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

An array of service instance Infrastructure as Code (IaC) outputs.

", "smithy.api#required": {} } } @@ -4929,14 +5823,14 @@ "serviceName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The service name.

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

The name of the service that serviceInstanceName is associated to.

", "smithy.api#required": {} } }, "serviceInstanceName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The service instance name.

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

The name of the service instance whose provisioned resources you want.

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

List service instances with summaries of detail data.

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

List service instances with summary data.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5037,7 +5931,7 @@ "serviceInstances": { "target": "com.amazonaws.proton#ServiceInstanceSummaryList", "traits": { - "smithy.api#documentation": "

An array of service instances with summaries of detail data.

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

An array of service instances with summary data.

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

View a list service pipeline infrastructure as code outputs with detail.

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

Get a list of service pipeline Infrastructure as Code (IaC) outputs.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5084,7 +5978,7 @@ "serviceName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The service name.

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

The name of the service whose pipeline's outputs you want.

", "smithy.api#required": {} } }, @@ -5108,7 +6002,7 @@ "outputs": { "target": "com.amazonaws.proton#OutputsList", "traits": { - "smithy.api#documentation": "

An array of outputs.

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

An array of service pipeline Infrastructure as Code (IaC) outputs.

", "smithy.api#required": {} } } @@ -5155,7 +6049,7 @@ "serviceName": { "target": "com.amazonaws.proton#ResourceName", "traits": { - "smithy.api#documentation": "

The service name.

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

The name of the service whose pipeline's provisioned resources you want.

", "smithy.api#required": {} } }, @@ -5571,14 +6465,13 @@ } }, "statusMessage": { - "target": "smithy.api#String", + "target": "com.amazonaws.proton#StatusMessage", "traits": { "smithy.api#documentation": "

The deployment status message for your provisioned resource.

", "smithy.api#length": { "min": 0, "max": 5000 - }, - "smithy.api#sensitive": {} + } } } } @@ -5822,7 +6715,7 @@ } }, "traits": { - "smithy.api#documentation": "

Detail date for a repository that has been registered with Proton.

" + "smithy.api#documentation": "

Detailed data of a repository that has been registered with Proton.

" } }, "com.amazonaws.proton#RepositoryArn": { @@ -5994,7 +6887,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of detail data for a registered repository.

" + "smithy.api#documentation": "

Summary data of a repository that has been registered with Proton.

" } }, "com.amazonaws.proton#RepositorySummaryList": { @@ -6177,6 +7070,16 @@ "smithy.api#pattern": "^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$" } }, + "com.amazonaws.proton#ResourceNameOrEmpty": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "(^$)|^[0-9A-Za-z]+[0-9A-Za-z_\\-]*$" + } + }, "com.amazonaws.proton#ResourceNotFoundException": { "type": "structure", "members": { @@ -6417,7 +7320,7 @@ "description": { "target": "com.amazonaws.proton#Description", "traits": { - "smithy.api#documentation": "

A description of a service.

" + "smithy.api#documentation": "

A description of the service.

" } }, "arn": { @@ -6494,7 +7397,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service detail data.

" + "smithy.api#documentation": "

Detailed data of an Proton service resource.

" } }, "com.amazonaws.proton#ServiceArn": { @@ -6588,7 +7491,7 @@ "deploymentStatusMessage": { "target": "com.amazonaws.proton#StatusMessage", "traits": { - "smithy.api#documentation": "

A service instance deployment status message.

" + "smithy.api#documentation": "

The message associated with the service instance deployment status.

" } }, "spec": { @@ -6599,7 +7502,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service instance detail data.

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

Detailed data of an Proton service instance resource.

", "smithy.api#references": [ { "resource": "com.amazonaws.proton#ServiceResource" @@ -6765,7 +7668,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of the service instance detail data.

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

Summary data of an Proton service instance resource.

", "smithy.api#references": [ { "resource": "com.amazonaws.proton#ServiceResource" @@ -6852,7 +7755,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service pipeline detail data.

" + "smithy.api#documentation": "

Detailed data of an Proton service instance pipeline resource.

" } }, "com.amazonaws.proton#ServicePipelineOutputResource": { @@ -7064,7 +7967,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of the service detail data.

" + "smithy.api#documentation": "

Summary data of an Proton service resource.

" } }, "com.amazonaws.proton#ServiceSummaryList": { @@ -7136,7 +8039,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service template detail data.

" + "smithy.api#documentation": "

Detailed data of an Proton service template resource.

" } }, "com.amazonaws.proton#ServiceTemplateArn": { @@ -7236,7 +8139,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service template summary data.

" + "smithy.api#documentation": "

Summary data of an Proton service template resource.

" } }, "com.amazonaws.proton#ServiceTemplateSummaryList": { @@ -7245,6 +8148,23 @@ "target": "com.amazonaws.proton#ServiceTemplateSummary" } }, + "com.amazonaws.proton#ServiceTemplateSupportedComponentSourceInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.proton#ServiceTemplateSupportedComponentSourceType" + } + }, + "com.amazonaws.proton#ServiceTemplateSupportedComponentSourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DIRECTLY_DEFINED", + "name": "DIRECTLY_DEFINED" + } + ] + } + }, "com.amazonaws.proton#ServiceTemplateVersion": { "type": "structure", "members": { @@ -7327,10 +8247,16 @@ "traits": { "smithy.api#documentation": "

The schema of the version of a service template.

" } + }, + "supportedComponentSources": { + "target": "com.amazonaws.proton#ServiceTemplateSupportedComponentSourceInputList", + "traits": { + "smithy.api#documentation": "

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

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

The version of a service template detail data.

" + "smithy.api#documentation": "

Detailed data of an Proton service template version resource.

" } }, "com.amazonaws.proton#ServiceTemplateVersionArn": { @@ -7450,7 +8376,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of the service template version detail data.

" + "smithy.api#documentation": "

Summary data of an Proton service template version resource.

" } }, "com.amazonaws.proton#ServiceTemplateVersionSummaryList": { @@ -7617,6 +8543,28 @@ } } }, + "com.amazonaws.proton#TemplateFileContents": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51200 + }, + "smithy.api#mediaType": "application/yaml", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.proton#TemplateManifestContents": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#mediaType": "application/yaml", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.proton#TemplateSchema": { "type": "string", "traits": { @@ -7888,6 +8836,109 @@ } } }, + "com.amazonaws.proton#UpdateComponent": { + "type": "operation", + "input": { + "target": "com.amazonaws.proton#UpdateComponentInput" + }, + "output": { + "target": "com.amazonaws.proton#UpdateComponentOutput" + }, + "errors": [ + { + "target": "com.amazonaws.proton#AccessDeniedException" + }, + { + "target": "com.amazonaws.proton#ConflictException" + }, + { + "target": "com.amazonaws.proton#InternalServerException" + }, + { + "target": "com.amazonaws.proton#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.proton#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.proton#ThrottlingException" + }, + { + "target": "com.amazonaws.proton#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a component.

\n

There are a few modes for updating a component. The deploymentType field defines the mode.

\n \n

You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is\n IN_PROGRESS.

\n \n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

" + } + }, + "com.amazonaws.proton#UpdateComponentInput": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.proton#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the component to update.

", + "smithy.api#required": {} + } + }, + "deploymentType": { + "target": "com.amazonaws.proton#ComponentDeploymentUpdateType", + "traits": { + "smithy.api#documentation": "

The deployment type. It defines the mode for updating a component, as follows:

\n
\n
\n
\n

\n NONE\n

\n

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify\n description in this mode.

\n
\n
\n
\n

\n CURRENT_VERSION\n

\n

In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type\n that you provide. Only requested parameters are updated.

\n
\n
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.proton#Description", + "traits": { + "smithy.api#documentation": "

An optional customer-provided description of the component.

" + } + }, + "serviceName": { + "target": "com.amazonaws.proton#ResourceNameOrEmpty", + "traits": { + "smithy.api#documentation": "

The name of the service that serviceInstanceName is associated with. Don't specify to keep the component's current service instance\n attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both\n serviceInstanceName and serviceName or for neither of them.

" + } + }, + "serviceInstanceName": { + "target": "com.amazonaws.proton#ResourceNameOrEmpty", + "traits": { + "smithy.api#documentation": "

The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment.\n Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both\n serviceInstanceName and serviceName or for neither of them.

" + } + }, + "serviceSpec": { + "target": "com.amazonaws.proton#SpecContents", + "traits": { + "smithy.api#documentation": "

The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service\n instance.

" + } + }, + "templateFile": { + "target": "com.amazonaws.proton#TemplateFileContents", + "traits": { + "smithy.api#documentation": "

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

\n \n

Components support a single IaC file, even if you use Terraform as your template language.

\n " + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.proton#ComponentResource" + } + ] + } + }, + "com.amazonaws.proton#UpdateComponentOutput": { + "type": "structure", + "members": { + "component": { + "target": "com.amazonaws.proton#Component", + "traits": { + "smithy.api#documentation": "

The detailed data of the updated component.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.proton#UpdateEnvironment": { "type": "operation", "input": { @@ -7966,8 +9017,13 @@ "roleArn": { "target": "com.amazonaws.proton#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.

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

The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.

" + } + }, + "componentRoleArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated\n environment account. It determines the scope of infrastructure that a component can provision in the account.

\n

The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any\n environments running in the account.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

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

The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.

" } + }, + "componentRoleArn": { + "target": "com.amazonaws.proton#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It\n determines the scope of infrastructure that a component can provision.

\n

The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

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

Edit a service description or use a spec to add and delete service instances.

\n \n

Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

\n \n

Use the description parameter to modify the description.

\n

Edit the spec parameter to add or delete instances.

" + "smithy.api#documentation": "

Edit a service description or use a spec to add and delete service instances.

\n \n

Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

\n \n

Use the description parameter to modify the description.

\n

Edit the spec parameter to add or delete instances.

\n \n

You can't delete a service instance (remove it from the spec) if it has an attached component.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

\n " } }, "com.amazonaws.proton#UpdateServiceInput": { @@ -8330,7 +9392,7 @@ } ], "traits": { - "smithy.api#documentation": "

Update a service instance.

\n

There are four modes for updating a service instance. The deploymentType field defines the mode.

\n
\n
\n
\n

\n NONE\n

\n

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

\n
\n
\n
\n

\n CURRENT_VERSION\n

\n

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include minor or major version parameters when you use this deployment-type.

\n
\n
\n
\n

\n MINOR_VERSION\n

\n

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version\n in use, by default. You can also specify a different minor version of the current major version in use.

\n
\n
\n
\n

\n MAJOR_VERSION\n

\n

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current\n template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.

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

Update a service instance.

\n

There are a few modes for updating a service instance. The deploymentType field defines the mode.

\n \n

You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is\n IN_PROGRESS.

\n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

\n " } }, "com.amazonaws.proton#UpdateServiceInstanceInput": { @@ -8353,7 +9415,7 @@ "deploymentType": { "target": "com.amazonaws.proton#DeploymentUpdateType", "traits": { - "smithy.api#documentation": "

The deployment type.

\n

There are four modes for updating a service instance. The deploymentType field defines the mode.

\n
\n
\n
\n

\n NONE\n

\n

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

\n
\n
\n
\n

\n CURRENT_VERSION\n

\n

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include major or minor version parameters when you use this deployment-type.

\n
\n
\n
\n

\n MINOR_VERSION\n

\n

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version\n in use, by default. You can also specify a different minor version of the current major version in use.

\n
\n
\n
\n

\n MAJOR_VERSION\n

\n

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current\n template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

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

The deployment type. It defines the mode for updating a service instance, as follows:

\n
\n
\n
\n

\n NONE\n

\n

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

\n
\n
\n
\n

\n CURRENT_VERSION\n

\n

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated.\n Don’t include major or minor version parameters when you use this deployment type.

\n
\n
\n
\n

\n MINOR_VERSION\n

\n

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version\n in use, by default. You can also specify a different minor version of the current major version in use.

\n
\n
\n
\n

\n MAJOR_VERSION\n

\n

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current\n template, by default. You can specify a different major version that's higher than the major version in use and a minor version.

\n
\n
", "smithy.api#required": {} } }, @@ -8646,7 +9708,13 @@ "compatibleEnvironmentTemplates": { "target": "com.amazonaws.proton#CompatibleEnvironmentTemplateInputList", "traits": { - "smithy.api#documentation": "

An array of compatible environment names for a service template major or minor version to update.

" + "smithy.api#documentation": "

An array of environment template objects that are compatible with this service template version. A service instance based on this service template\n version can run in environments based on compatible templates.

" + } + }, + "supportedComponentSources": { + "target": "com.amazonaws.proton#ServiceTemplateSupportedComponentSourceInputList", + "traits": { + "smithy.api#documentation": "

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template\n version.

\n \n

A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A\n change only affects later associations.

\n \n

For more information about components, see\n Proton components in the\n Proton Administrator Guide.

" } } }, diff --git a/aws/sdk/aws-models/redshift-data.json b/aws/sdk/aws-models/redshift-data.json index e3023018e..e5a7c4a0a 100644 --- a/aws/sdk/aws-models/redshift-data.json +++ b/aws/sdk/aws-models/redshift-data.json @@ -34,7 +34,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.

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

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition\n language (DDL). \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
" } }, "com.amazonaws.redshiftdata#BatchExecuteStatementException": { @@ -106,6 +106,12 @@ "traits": { "smithy.api#documentation": "

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" + } } } }, @@ -127,7 +133,7 @@ "ClusterIdentifier": { "target": "com.amazonaws.redshiftdata#Location", "traits": { - "smithy.api#documentation": "

The cluster identifier. This parameter is not returned when connecting to a serverless endpoint.

" + "smithy.api#documentation": "

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

" } }, "DbUser": { @@ -147,6 +153,12 @@ "traits": { "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.

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

The SQL statements from a multiple statement run.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name.

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

Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.

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

Describes the detailed information about a table from metadata in the cluster. The\n information includes its columns. \n A token is returned to page through the column list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -577,6 +595,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of tables to return in the response. \n If more tables exist than fit in one response, then NextToken is returned to page through the results.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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

Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.

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

Runs an SQL statement, which can be data manipulation language (DML) or data definition\n language (DDL). This statement must be a single SQL statement. \n Depending on the authorization\n method, use one of the following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
" } }, "com.amazonaws.redshiftdata#ExecuteStatementException": { @@ -702,6 +726,12 @@ "traits": { "smithy.api#documentation": "

The parameters for the SQL statement.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" + } } } }, @@ -723,7 +753,7 @@ "ClusterIdentifier": { "target": "com.amazonaws.redshiftdata#Location", "traits": { - "smithy.api#documentation": "

The cluster identifier. This parameter is not returned when connecting to a serverless endpoint.

" + "smithy.api#documentation": "

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

" } }, "DbUser": { @@ -743,6 +773,12 @@ "traits": { "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.

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

List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.

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

List the databases in a cluster. \n A token is returned to page through the database list.\n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -962,6 +998,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of databases to return in the response. \n If more databases exist than fit in one response, then NextToken is returned to page through the results.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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

Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.

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

Lists the schemas in a database. \n A token is returned to page through the schema list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1063,6 +1105,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of schemas to return in the response. \n If more schemas exist than fit in one response, then NextToken is returned to page through the results.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless endpoint, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless endpoint, specify the database name.

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

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then \n all tables in the database are returned.\n A token is returned to page through the table list. \n Depending on the authorization method, use one of the\n following combinations of request parameters:

\n
    \n
  • \n

    Secrets Manager - when connecting to a cluster, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.\nWhen connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.

    \n
    • \n
  • \n

    Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. \nAlso, permission to call the redshift:GetClusterCredentials operation is required.\nWhen connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials operation is required.

    \n
    • \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1259,6 +1307,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of tables to return in the response. \n If more tables exist than fit in one response, then NextToken is returned to page through the results.

" } + }, + "WorkgroupName": { + "target": "com.amazonaws.redshiftdata#WorkgroupNameString", + "traits": { + "smithy.api#documentation": "

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

" + } } } }, @@ -1323,7 +1377,7 @@ }, "aws.protocols#awsJson1_1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run SQL statements, which are committed if the statement succeeds.

\n

For more information about the Amazon Redshift Data API, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Cluster Management Guide.

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

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run SQL statements, which are committed if the statement succeeds.

\n

For more information about the Amazon Redshift Data API and CLI usage examples, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Cluster Management Guide.

", "smithy.api#title": "Redshift Data API Service" }, "version": "2019-12-20", @@ -1740,6 +1794,16 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.redshiftdata#WorkgroupNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9-]+$" + } + }, "com.amazonaws.redshiftdata#bool": { "type": "boolean" } diff --git a/aws/sdk/aws-models/redshift.json b/aws/sdk/aws-models/redshift.json index d703091e6..5c6b4710a 100644 --- a/aws/sdk/aws-models/redshift.json +++ b/aws/sdk/aws-models/redshift.json @@ -1461,6 +1461,35 @@ } } }, + "com.amazonaws.redshift#ClusterExtendedCredentials": { + "type": "structure", + "members": { + "DbUser": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity.

" + } + }, + "DbPassword": { + "target": "com.amazonaws.redshift#SensitiveString", + "traits": { + "smithy.api#documentation": "

A temporary password that you provide when you connect to a database.

" + } + }, + "Expiration": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "

The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.

" + } + }, + "NextRefreshTime": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

" + } + } + } + }, "com.amazonaws.redshift#ClusterIamRole": { "type": "structure", "members": { @@ -2513,7 +2542,7 @@ "MasterUserPassword": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The password associated with the admin user account for the cluster that is being\n created.

\n

Constraints:

\n
    \n
  • \n

    Must be between 8 and 64 characters in length.

    \n
    • \n
  • \n

    Must contain at least one uppercase letter.

    \n
    • \n
  • \n

    Must contain at least one lowercase letter.

    \n
    • \n
  • \n

    Must contain one number.

    \n
    • \n
  • \n

    Can be any printable ASCII character (ASCII code 33-126) except '\n (single quote), \" (double quote), \\, /, or @.

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

The password associated with the admin user account for the cluster that is being\n created.

\n

Constraints:

\n
    \n
  • \n

    Must be between 8 and 64 characters in length.

    \n
    • \n
  • \n

    Must contain at least one uppercase letter.

    \n
    • \n
  • \n

    Must contain at least one lowercase letter.

    \n
    • \n
  • \n

    Must contain one number.

    \n
    • \n
  • \n

    Can be any printable ASCII character (ASCII code 33-126) except '\n (single quote), \" (double quote), \\, /, or @.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -8008,7 +8037,7 @@ "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The unique identifier of the cluster that contains the database for which your are\n requesting credentials. This parameter is case sensitive.

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

The unique identifier of the cluster that contains the database for which you are\n requesting credentials. This parameter is case sensitive.

", "smithy.api#required": {} } }, @@ -8035,6 +8064,50 @@ "smithy.api#documentation": "

The request parameters to get cluster credentials.

" } }, + "com.amazonaws.redshift#GetClusterCredentialsWithIAM": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#GetClusterCredentialsWithIAMMessage" + }, + "output": { + "target": "com.amazonaws.redshift#ClusterExtendedCredentials" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a database user name and temporary password with temporary authorization to\n log in to an Amazon Redshift database.\n The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity.\n For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the\n Amazon Web Services Identity and Access Management User Guide.

\n

The Identity and Access Management (IAM) identity that runs\n this operation must have an IAM policy attached that allows access to all\n necessary actions and resources. \n For more information about permissions, see Using identity-based policies (IAM policies) in the\n Amazon Redshift Cluster Management Guide.

" + } + }, + "com.amazonaws.redshift#GetClusterCredentialsWithIAMMessage": { + "type": "structure", + "members": { + "DbName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The name of the database for which you are requesting credentials.\n If the database name is specified, the IAM policy must allow access to the resource dbname for the specified database name.\n If the database name is not specified, access to all databases is allowed.

" + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the cluster that contains the database for which you are\n requesting credentials.

", + "smithy.api#required": {} + } + }, + "DurationSeconds": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of seconds until the returned temporary password expires.

\n

Range: 900-3600. Default: 900.

" + } + } + } + }, "com.amazonaws.redshift#GetReservedNodeExchangeConfigurationOptions": { "type": "operation", "input": { @@ -9663,7 +9736,7 @@ "MasterUserPassword": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The new password for the cluster admin user. This change is asynchronously applied\n as soon as possible. Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Operations never return the password, so this operation provides a way to\n regain access to the admin user account for a cluster if the password is\n lost.

\n \n

Default: Uses existing setting.

\n

Constraints:

\n
    \n
  • \n

    Must be between 8 and 64 characters in length.

    \n
    • \n
  • \n

    Must contain at least one uppercase letter.

    \n
    • \n
  • \n

    Must contain at least one lowercase letter.

    \n
    • \n
  • \n

    Must contain one number.

    \n
    • \n
  • \n

    Can be any printable ASCII character (ASCII code 33-126) except '\n (single quote), \" (double quote), \\, /, or @.

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

The new password for the cluster admin user. This change is asynchronously applied\n as soon as possible. Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.

\n \n

Operations never return the password, so this operation provides a way to\n regain access to the admin user account for a cluster if the password is\n lost.

\n \n

Default: Uses existing setting.

\n

Constraints:

\n
    \n
  • \n

    Must be between 8 and 64 characters in length.

    \n
    • \n
  • \n

    Must contain at least one uppercase letter.

    \n
    • \n
  • \n

    Must contain at least one lowercase letter.

    \n
    • \n
  • \n

    Must contain one number.

    \n
    • \n
  • \n

    Can be any printable ASCII character (ASCII code 33-126) except '\n (single quote), \" (double quote), \\, /, or @.

    \n
    • \n
" } }, "ClusterParameterGroupName": { @@ -11492,6 +11565,9 @@ { "target": "com.amazonaws.redshift#GetClusterCredentials" }, + { + "target": "com.amazonaws.redshift#GetClusterCredentialsWithIAM" + }, { "target": "com.amazonaws.redshift#GetReservedNodeExchangeConfigurationOptions" }, diff --git a/aws/sdk/aws-models/redshiftserverless.json b/aws/sdk/aws-models/redshiftserverless.json new file mode 100644 index 000000000..b6fa79f4b --- /dev/null +++ b/aws/sdk/aws-models/redshiftserverless.json @@ -0,0 +1,4023 @@ +{ + "smithy": "1.0", + "shapes": { + "com.amazonaws.redshiftserverless#AccessDeniedException": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#String" + }, + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.redshiftserverless#AccountIdList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.redshiftserverless#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.redshiftserverless#ConfigParameter": { + "type": "structure", + "members": { + "parameterKey": { + "target": "com.amazonaws.redshiftserverless#ParameterKey", + "traits": { + "smithy.api#documentation": "

The key of the parameter. The\n options are datestyle, enable_user_activity_logging,\n query_group, search_path, and max_query_execution_time.

" + } + }, + "parameterValue": { + "target": "com.amazonaws.redshiftserverless#ParameterValue", + "traits": { + "smithy.api#documentation": "

The value of the parameter to set.

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

An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

" + } + }, + "com.amazonaws.redshiftserverless#ConfigParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#ConfigParameter" + } + }, + "com.amazonaws.redshiftserverless#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The submitted action has conflicts.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, \n see Working with snapshots and recovery points.

" + } + }, + "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotRequest": { + "type": "structure", + "members": { + "recoveryPointId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the recovery point.

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

The name of the snapshot.

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

How long to retain the snapshot.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshotResponse": { + "type": "structure", + "members": { + "snapshot": { + "target": "com.amazonaws.redshiftserverless#Snapshot", + "traits": { + "smithy.api#documentation": "

The snapshot converted from the recovery point.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#CreateEndpointAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#CreateEndpointAccessRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#CreateEndpointAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#AccessDeniedException" + }, + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Redshift Serverless managed VPC endpoint.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#CreateEndpointAccessRequest": { + "type": "structure", + "members": { + "endpointName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the VPC endpoint. An endpoint name must contain 1-30 characters. \n Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. \n The name can't contain two consecutive hyphens or end with a hyphen.

", + "smithy.api#required": {} + } + }, + "subnetIds": { + "target": "com.amazonaws.redshiftserverless#SubnetIdList", + "traits": { + "smithy.api#documentation": "

The unique identifers of subnets from which \n Amazon Redshift Serverless chooses one to deploy a VPC endpoint.

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

The name of the workgroup to associate with the VPC endpoint.

", + "smithy.api#required": {} + } + }, + "vpcSecurityGroupIds": { + "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The unique identifiers of the security group that defines the ports, \n protocols, and sources for inbound traffic that you are authorizing into your endpoint.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#CreateEndpointAccessResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.redshiftserverless#EndpointAccess", + "traits": { + "smithy.api#documentation": "

The created VPC endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#CreateNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#CreateNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#CreateNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#TooManyTagsException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a namespace in Amazon Redshift Serverless.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#CreateNamespaceRequest": { + "type": "structure", + "members": { + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

", + "smithy.api#required": {} + } + }, + "adminUsername": { + "target": "com.amazonaws.redshiftserverless#DbUser", + "traits": { + "smithy.api#documentation": "

The username of the administrator for the first database created in the namespace.

" + } + }, + "adminUserPassword": { + "target": "com.amazonaws.redshiftserverless#DbPassword", + "traits": { + "smithy.api#documentation": "

The password of the administrator for the first database created in the namespace.

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

The name of the first database created in the namespace.

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

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

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

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

" + } + }, + "iamRoles": { + "target": "com.amazonaws.redshiftserverless#IamRoleArnList", + "traits": { + "smithy.api#documentation": "

A list of IAM roles to associate with the namespace.

" + } + }, + "logExports": { + "target": "com.amazonaws.redshiftserverless#LogExportList", + "traits": { + "smithy.api#documentation": "

The types of logs the namespace can export. \n Available export types are userlog, connectionlog, and useractivitylog.

" + } + }, + "tags": { + "target": "com.amazonaws.redshiftserverless#TagList", + "traits": { + "smithy.api#documentation": "

A list of tag instances.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#CreateNamespaceResponse": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.redshiftserverless#Namespace", + "traits": { + "smithy.api#documentation": "

The created namespace object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#CreateSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#CreateSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a snapshot of all databases in a namespace.\n For more information about snapshots, see \n \n Working with snapshots and recovery points.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#CreateSnapshotRequest": { + "type": "structure", + "members": { + "namespaceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The namespace to create a snapshot for.

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

The name of the snapshot.

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

How long to retain the created snapshot.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#CreateSnapshotResponse": { + "type": "structure", + "members": { + "snapshot": { + "target": "com.amazonaws.redshiftserverless#Snapshot", + "traits": { + "smithy.api#documentation": "

The created snapshot object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#CreateUsageLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#CreateUsageLimitRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#CreateUsageLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.\n

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#CreateUsageLimitRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

", + "smithy.api#required": {} + } + }, + "usageType": { + "target": "com.amazonaws.redshiftserverless#UsageLimitUsageType", + "traits": { + "smithy.api#documentation": "

The type of Amazon Redshift Serverless usage to create a usage limit for.

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

The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data\n transferred between Regions in cross-account sharing. The value must be a positive number.

", + "smithy.api#required": {} + } + }, + "period": { + "target": "com.amazonaws.redshiftserverless#UsageLimitPeriod", + "traits": { + "smithy.api#documentation": "

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

" + } + }, + "breachAction": { + "target": "com.amazonaws.redshiftserverless#UsageLimitBreachAction", + "traits": { + "smithy.api#documentation": "

The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#CreateUsageLimitResponse": { + "type": "structure", + "members": { + "usageLimit": { + "target": "com.amazonaws.redshiftserverless#UsageLimit", + "traits": { + "smithy.api#documentation": "

The returned usage limit object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#CreateWorkgroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#CreateWorkgroupRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#CreateWorkgroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InsufficientCapacityException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#TooManyTagsException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an workgroup in Amazon Redshift Serverless.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#CreateWorkgroupRequest": { + "type": "structure", + "members": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the created workgroup.

", + "smithy.api#required": {} + } + }, + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace to associate with the workgroup.

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

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

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

The value that specifies whether to turn on enhanced virtual \n private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

" + } + }, + "configParameters": { + "target": "com.amazonaws.redshiftserverless#ConfigParameterList", + "traits": { + "smithy.api#documentation": "

An array of parameters to set for more control over a serverless database. The\n options are datestyle, enable_user_activity_logging,\n query_group, search_path, and max_query_execution_time.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.redshiftserverless#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

An array of security group IDs to associate with the workgroup.

" + } + }, + "subnetIds": { + "target": "com.amazonaws.redshiftserverless#SubnetIdList", + "traits": { + "smithy.api#documentation": "

An array of VPC subnet IDs to associate with the workgroup.

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

A value that specifies whether the workgroup can be accessed from a public network.

" + } + }, + "tags": { + "target": "com.amazonaws.redshiftserverless#TagList", + "traits": { + "smithy.api#documentation": "

A array of tag instances.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#CreateWorkgroupResponse": { + "type": "structure", + "members": { + "workgroup": { + "target": "com.amazonaws.redshiftserverless#Workgroup", + "traits": { + "smithy.api#documentation": "

The created workgroup object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#CrossVpcEndpointResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.redshiftserverless#CreateEndpointAccess" + }, + { + "target": "com.amazonaws.redshiftserverless#DeleteEndpointAccess" + }, + { + "target": "com.amazonaws.redshiftserverless#GetEndpointAccess" + }, + { + "target": "com.amazonaws.redshiftserverless#ListEndpointAccess" + }, + { + "target": "com.amazonaws.redshiftserverless#UpdateEndpointAccess" + } + ] + }, + "com.amazonaws.redshiftserverless#DbName": { + "type": "string" + }, + "com.amazonaws.redshiftserverless#DbPassword": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.redshiftserverless#DbUser": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteEndpointAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#DeleteEndpointAccessRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#DeleteEndpointAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Redshift Serverless managed VPC endpoint.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteEndpointAccessRequest": { + "type": "structure", + "members": { + "endpointName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the VPC endpoint to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteEndpointAccessResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.redshiftserverless#EndpointAccess", + "traits": { + "smithy.api#documentation": "

The deleted VPC endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#DeleteNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#DeleteNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a namespace from Amazon Redshift Serverless. \n Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteNamespaceRequest": { + "type": "structure", + "members": { + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace to delete.

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

The name of the snapshot to be created before the namespace is deleted.

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

How long to retain the final snapshot.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteNamespaceResponse": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.redshiftserverless#Namespace", + "traits": { + "smithy.api#documentation": "

The deleted namespace object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified resource policy.

" + } + }, + "com.amazonaws.redshiftserverless#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#DeleteSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#DeleteSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a snapshot from Amazon Redshift Serverless.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteSnapshotRequest": { + "type": "structure", + "members": { + "snapshotName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteSnapshotResponse": { + "type": "structure", + "members": { + "snapshot": { + "target": "com.amazonaws.redshiftserverless#Snapshot", + "traits": { + "smithy.api#documentation": "

The deleted snapshot object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteUsageLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#DeleteUsageLimitRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#DeleteUsageLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a usage limit from Amazon Redshift Serverless.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteUsageLimitRequest": { + "type": "structure", + "members": { + "usageLimitId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the usage limit to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteUsageLimitResponse": { + "type": "structure", + "members": { + "usageLimit": { + "target": "com.amazonaws.redshiftserverless#UsageLimit", + "traits": { + "smithy.api#documentation": "

The deleted usage limit object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteWorkgroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#DeleteWorkgroupRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#DeleteWorkgroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a workgroup.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteWorkgroupRequest": { + "type": "structure", + "members": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#DeleteWorkgroupResponse": { + "type": "structure", + "members": { + "workgroup": { + "target": "com.amazonaws.redshiftserverless#Workgroup", + "traits": { + "smithy.api#documentation": "

The deleted workgroup object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#Endpoint": { + "type": "structure", + "members": { + "address": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The DNS address of the VPC endpoint.

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

The port that Amazon Redshift Serverless listens on.

" + } + }, + "vpcEndpoints": { + "target": "com.amazonaws.redshiftserverless#VpcEndpointList", + "traits": { + "smithy.api#documentation": "

An array of VpcEndpoint objects.

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

The VPC endpoint object.

" + } + }, + "com.amazonaws.redshiftserverless#EndpointAccess": { + "type": "structure", + "members": { + "endpointName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the VPC endpoint.

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

The status of the VPC endpoint.

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

The name of the workgroup associated with the endpoint.

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

The time that the endpoint was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "port": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The port number on which Amazon Redshift Serverless accepts incoming connections.

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

The DNS address of the endpoint.

" + } + }, + "subnetIds": { + "target": "com.amazonaws.redshiftserverless#SubnetIdList", + "traits": { + "smithy.api#documentation": "

The unique identifier of subnets \n where Amazon Redshift Serverless choose to deploy the VPC endpoint.

" + } + }, + "vpcSecurityGroups": { + "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

The security groups associated with the endpoint.

" + } + }, + "vpcEndpoint": { + "target": "com.amazonaws.redshiftserverless#VpcEndpoint", + "traits": { + "smithy.api#documentation": "

The connection endpoint for connecting to Amazon Redshift Serverless.

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

The Amazon Resource Name (ARN) of the VPC endpoint.

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

Information about an Amazon Redshift Serverless VPC endpoint.

" + } + }, + "com.amazonaws.redshiftserverless#EndpointAccessList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#EndpointAccess" + } + }, + "com.amazonaws.redshiftserverless#GetCredentials": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetCredentialsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetCredentialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a database user name and temporary password with\n temporary authorization to log in to Amazon Redshift Serverless.

\n

By default, the temporary credentials expire in 900 seconds. \n You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).

\n \n

\n The Identity and Access Management (IAM) user or role that runs \n GetCredentials must have an IAM policy attached that allows access to all \n necessary actions and resources.\n

\n \n

\n If the DbName parameter is specified, the IAM policy must \n allow access to the resource dbname for the specified database name.

" + } + }, + "com.amazonaws.redshiftserverless#GetCredentialsRequest": { + "type": "structure", + "members": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup associated with the database.

", + "smithy.api#required": {} + } + }, + "dbName": { + "target": "com.amazonaws.redshiftserverless#DbName", + "traits": { + "smithy.api#documentation": "

The name of the database to get temporary authorization to log on to.

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 64 alphanumeric characters or hyphens.

    \n
    • \n
  • \n

    Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    \n
    • \n
  • \n

    The first character must be a letter.

    \n
    • \n
  • \n

    Must not contain a colon ( : ) or slash ( / ).

    \n
    • \n
  • \n

    Cannot be a reserved word. A list of reserved words can be found \n in Reserved Words \n in the Amazon Redshift Database Developer Guide

    \n
    • \n
" + } + }, + "durationSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of seconds until the returned temporary password expires.\n The minimum is 900 seconds, and the maximum is 3600 seconds.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetCredentialsResponse": { + "type": "structure", + "members": { + "dbUser": { + "target": "com.amazonaws.redshiftserverless#DbUser", + "traits": { + "smithy.api#documentation": "

A database user name that is authorized to log on to the database DbName\n using the password DbPassword. If the specified DbUser exists in the database, \n the new user name has the same database privileges as the the user named in \n DbUser. By default, the user is added to PUBLIC.

" + } + }, + "dbPassword": { + "target": "com.amazonaws.redshiftserverless#DbPassword", + "traits": { + "smithy.api#documentation": "

A temporary password that authorizes the user name returned by \n DbUser to log on to the database DbName.

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

The date and time the password in DbPassword expires.

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

The date and time of when the DbUser and DbPassword \n authorization refreshes.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#GetEndpointAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetEndpointAccessRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetEndpointAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information, such as the name, about a VPC endpoint.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetEndpointAccessRequest": { + "type": "structure", + "members": { + "endpointName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the VPC endpoint to return information for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetEndpointAccessResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.redshiftserverless#EndpointAccess", + "traits": { + "smithy.api#documentation": "

The returned VPC endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#GetNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a namespace in Amazon Redshift Serverless.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetNamespaceRequest": { + "type": "structure", + "members": { + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace to retrieve information for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetNamespaceResponse": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.redshiftserverless#Namespace", + "traits": { + "smithy.api#documentation": "

The returned namespace object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#GetRecoveryPoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetRecoveryPointRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetRecoveryPointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a recovery point.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetRecoveryPointRequest": { + "type": "structure", + "members": { + "recoveryPointId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the recovery point to return information for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetRecoveryPointResponse": { + "type": "structure", + "members": { + "recoveryPoint": { + "target": "com.amazonaws.redshiftserverless#RecoveryPoint", + "traits": { + "smithy.api#documentation": "

The returned recovery point object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a resource policy.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to return.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetResourcePolicyResponse": { + "type": "structure", + "members": { + "resourcePolicy": { + "target": "com.amazonaws.redshiftserverless#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The returned resource policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#GetSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific snapshot.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetSnapshotRequest": { + "type": "structure", + "members": { + "snapshotName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot to return.

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

The owner Amazon Web Services account of a snapshot shared with another user.

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

The Amazon Resource Name (ARN) of the snapshot to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetSnapshotResponse": { + "type": "structure", + "members": { + "snapshot": { + "target": "com.amazonaws.redshiftserverless#Snapshot", + "traits": { + "smithy.api#documentation": "

The returned snapshot object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#GetUsageLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetUsageLimitRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetUsageLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a usage limit.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetUsageLimitRequest": { + "type": "structure", + "members": { + "usageLimitId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the usage limit to return information for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetUsageLimitResponse": { + "type": "structure", + "members": { + "usageLimit": { + "target": "com.amazonaws.redshiftserverless#UsageLimit", + "traits": { + "smithy.api#documentation": "

The returned usage limit object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#GetWorkgroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#GetWorkgroupRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#GetWorkgroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specific workgroup.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#GetWorkgroupRequest": { + "type": "structure", + "members": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup to return information for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#GetWorkgroupResponse": { + "type": "structure", + "members": { + "workgroup": { + "target": "com.amazonaws.redshiftserverless#Workgroup", + "traits": { + "smithy.api#documentation": "

The returned workgroup object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#IamRoleArn": { + "type": "string" + }, + "com.amazonaws.redshiftserverless#IamRoleArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#IamRoleArn" + } + }, + "com.amazonaws.redshiftserverless#InsufficientCapacityException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

There is an insufficient capacity to perform the action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.redshiftserverless#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or failure.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.redshiftserverless#InvalidPaginationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The provided pagination token is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshiftserverless#KmsKeyId": { + "type": "string" + }, + "com.amazonaws.redshiftserverless#ListEndpointAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListEndpointAccessRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListEndpointAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an array of EndpointAccess objects and relevant information.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "endpoints" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListEndpointAccessRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If your initial ListEndpointAccess operation returns a nextToken,\n you can include the returned nextToken in subsequent ListEndpointAccess operations,\n which returns results in the next page.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return.\n You can use nextToken to get the next page of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "workgroupName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the workgroup associated with the VPC endpoint to return.

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

The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListEndpointAccessResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

When nextToken is returned, there are more results available. \n 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.

" + } + }, + "endpoints": { + "target": "com.amazonaws.redshiftserverless#EndpointAccessList", + "traits": { + "smithy.api#documentation": "

The returned VPC endpoints.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#ListNamespaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListNamespacesRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListNamespacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a list of specified namespaces.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "namespaces" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListNamespacesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If your initial ListNamespaces operation returns a nextToken,\n you can include the returned nextToken in subsequent ListNamespaces operations,\n which returns results in the next page.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return.\n You can use nextToken to get the next page of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListNamespacesResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

When nextToken is returned, there are more results available. \n 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.

" + } + }, + "namespaces": { + "target": "com.amazonaws.redshiftserverless#NamespaceList", + "traits": { + "smithy.api#documentation": "

The list of returned namespaces.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#ListRecoveryPoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListRecoveryPointsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListRecoveryPointsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an array of recovery points.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "recoveryPoints" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListRecoveryPointsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If your initial ListRecoveryPoints operation returns a nextToken,\n you can include the returned nextToken in subsequent ListRecoveryPoints operations,\n which returns results in the next page.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return.\n You can use nextToken to get the next page of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the recovery point's creation was initiated.

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

The time when creation of the recovery point finished.

" + } + }, + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace to list recovery points for.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListRecoveryPointsResponse": { + "type": "structure", + "members": { + "recoveryPoints": { + "target": "com.amazonaws.redshiftserverless#RecoveryPointList", + "traits": { + "smithy.api#documentation": "

The returned recovery point objects.

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

If nextToken is returned, there are more results available. \n 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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#ListSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListSnapshotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of snapshots.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "snapshots" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListSnapshotsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. \n 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.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return.\n You can use nextToken to get the next page of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "namespaceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The namespace from which to list all snapshots.

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

The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

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

The owner Amazon Web Services account of the snapshot.

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

The time when the creation of the snapshot was initiated.

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

The timestamp showing when the snapshot creation finished.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListSnapshotsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. \n 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.

" + } + }, + "snapshots": { + "target": "com.amazonaws.redshiftserverless#SnapshotList", + "traits": { + "smithy.api#documentation": "

All of the returned snapshot objects.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags assigned to a resource.

", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.redshiftserverless#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to list tags for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.redshiftserverless#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs assigned to the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#ListUsageLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListUsageLimitsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListUsageLimitsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#InvalidPaginationException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all usage limits within Amazon Redshift Serverless.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "usageLimits" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListUsageLimitsRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

" + } + }, + "usageType": { + "target": "com.amazonaws.redshiftserverless#UsageLimitUsageType", + "traits": { + "smithy.api#documentation": "

The Amazon Redshift Serverless feature whose limits you want to see.

" + } + }, + "nextToken": { + "target": "com.amazonaws.redshiftserverless#PaginationToken", + "traits": { + "smithy.api#documentation": "

If your initial ListUsageLimits operation returns a nextToken,\n you can include the returned nextToken in subsequent ListUsageLimits operations,\n which returns results in the next page.\n

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return.\n You can use nextToken to get the next page of results. The default is 100.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListUsageLimitsResponse": { + "type": "structure", + "members": { + "usageLimits": { + "target": "com.amazonaws.redshiftserverless#UsageLimits", + "traits": { + "smithy.api#documentation": "

An array of returned usage limit objects.

" + } + }, + "nextToken": { + "target": "com.amazonaws.redshiftserverless#PaginationToken", + "traits": { + "smithy.api#documentation": "

When nextToken is returned, there are more results available. \n 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.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#ListWorkgroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#ListWorkgroupsRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#ListWorkgroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a list of specified workgroups.

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "workgroups" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.redshiftserverless#ListWorkgroupsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If your initial ListWorkgroups operation returns a nextToken,\n you can include the returned nextToken in subsequent ListNamespaces operations,\n which returns results in the next page.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return.\n You can use nextToken to get the next page of results.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#ListWorkgroupsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

\n If nextToken is returned, there are more results available. \n The value of nextToken is a unique pagination token for each page. \n To retrieve the next page, make the call again using the returned token.

" + } + }, + "workgroups": { + "target": "com.amazonaws.redshiftserverless#WorkgroupList", + "traits": { + "smithy.api#documentation": "

The returned array of workgroups.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#LogExport": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "USER_ACTIVITY_LOG", + "value": "useractivitylog" + }, + { + "name": "USER_LOG", + "value": "userlog" + }, + { + "name": "CONNECTION_LOG", + "value": "connectionlog" + } + ] + } + }, + "com.amazonaws.redshiftserverless#LogExportList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#LogExport" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.redshiftserverless#Namespace": { + "type": "structure", + "members": { + "namespaceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with a namespace.

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

The unique identifier of a namespace.

" + } + }, + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace. \n Must be between 3-64 alphanumeric characters in lowercase, \n and it cannot be a reserved word. A list of reserved words can be found \n in Reserved Words in the Amazon Redshift Database Developer Guide.

" + } + }, + "adminUsername": { + "target": "com.amazonaws.redshiftserverless#DbUser", + "traits": { + "smithy.api#documentation": "

The username of the administrator for the first database created in the namespace.

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

The name of the first database created in the namespace.

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

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

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

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

" + } + }, + "iamRoles": { + "target": "com.amazonaws.redshiftserverless#IamRoleArnList", + "traits": { + "smithy.api#documentation": "

A list of IAM roles to associate with the namespace.

" + } + }, + "logExports": { + "target": "com.amazonaws.redshiftserverless#LogExportList", + "traits": { + "smithy.api#documentation": "

The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

" + } + }, + "status": { + "target": "com.amazonaws.redshiftserverless#NamespaceStatus", + "traits": { + "smithy.api#documentation": "

The status of the namespace.

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

The date of when the namespace was created.

", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of database objects and users.

" + } + }, + "com.amazonaws.redshiftserverless#NamespaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#Namespace" + } + }, + "com.amazonaws.redshiftserverless#NamespaceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9-]+$" + } + }, + "com.amazonaws.redshiftserverless#NamespaceResource": { + "type": "resource", + "identifiers": { + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName" + } + }, + "put": { + "target": "com.amazonaws.redshiftserverless#CreateNamespace" + }, + "read": { + "target": "com.amazonaws.redshiftserverless#GetNamespace" + }, + "update": { + "target": "com.amazonaws.redshiftserverless#UpdateNamespace" + }, + "delete": { + "target": "com.amazonaws.redshiftserverless#DeleteNamespace" + }, + "list": { + "target": "com.amazonaws.redshiftserverless#ListNamespaces" + }, + "traits": { + "aws.api#arn": { + "template": "namespace/{namespaceName}" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.redshiftserverless#NamespaceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "AVAILABLE", + "value": "AVAILABLE" + }, + { + "name": "MODIFYING", + "value": "MODIFYING" + }, + { + "name": "DELETING", + "value": "DELETING" + } + ] + } + }, + "com.amazonaws.redshiftserverless#NetworkInterface": { + "type": "structure", + "members": { + "networkInterfaceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the network interface.

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

The unique identifier of the subnet.

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

The IPv4 address of the network interface within the subnet.

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

The availability Zone.

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

Contains information about a network interface \n in an Amazon Redshift Serverless managed VPC endpoint.\n

" + } + }, + "com.amazonaws.redshiftserverless#NetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#NetworkInterface" + } + }, + "com.amazonaws.redshiftserverless#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 1024 + } + } + }, + "com.amazonaws.redshiftserverless#ParameterKey": { + "type": "string" + }, + "com.amazonaws.redshiftserverless#ParameterValue": { + "type": "string" + }, + "com.amazonaws.redshiftserverless#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

" + } + }, + "com.amazonaws.redshiftserverless#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account to create or update a resource policy for.

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

The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot.

\n

\n \"{\\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\" : \n [{ \\\"Sid\\\": \\\"AllowUserRestoreFromSnapshot\\\", \\\"Principal\\\":{\\\"AWS\\\": \n [\\\"739247239426\\\"]}, \\\"Action\\\": [\\\"redshift-serverless:RestoreFromSnapshot\\\"]\n , \\\"Effect\\\": \\\"Allow\\\" }]}\"\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "resourcePolicy": { + "target": "com.amazonaws.redshiftserverless#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The policy that was created or updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#RecoveryPoint": { + "type": "structure", + "members": { + "recoveryPointId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the recovery point.

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

The time the recovery point is created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "totalSizeInMegaBytes": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The total size of the data in the recovery point in megabytes.

" + } + }, + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace the recovery point is associated with.

" + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup the recovery point is associated with.

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

The automatically created recovery point of a namespace. \n Recovery points are created every 30 minutes and kept for 24 hours.

" + } + }, + "com.amazonaws.redshiftserverless#RecoveryPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#RecoveryPoint" + } + }, + "com.amazonaws.redshiftserverless#RecoveryPointResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.redshiftserverless#ConvertRecoveryPointToSnapshot" + }, + { + "target": "com.amazonaws.redshiftserverless#GetRecoveryPoint" + }, + { + "target": "com.amazonaws.redshiftserverless#ListRecoveryPoints" + }, + { + "target": "com.amazonaws.redshiftserverless#RestoreFromRecoveryPoint" + } + ] + }, + "com.amazonaws.redshiftserverless#RedshiftServerless": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "RedshiftServerless", + "arnNamespace": "redshift-serverless" + }, + "aws.auth#sigv4": { + "name": "redshift-serverless" + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#awsJson1_1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

\n This is prerelease documentation for Amazon Redshift Serverless, which is in preview release. \n The documentation and the feature are both subject to change. We recommend that you use this feature only in test environments, \n and not in production environments. For preview terms and conditions, see Beta Service Participation in \n Amazon Web Services Service Terms.\n

\n

This is an interface reference for Amazon Redshift Serverless. \n It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.\n

\n

Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the \n underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high \n performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you\n focus on using your data to acquire new insights for your business and customers.\n

\n

\n To learn more about Amazon Redshift Serverless, \n see What is Amazon Redshift Serverless.\n

", + "smithy.api#title": "Redshift Serverless" + }, + "version": "2021-04-21", + "operations": [ + { + "target": "com.amazonaws.redshiftserverless#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.redshiftserverless#GetCredentials" + }, + { + "target": "com.amazonaws.redshiftserverless#GetResourcePolicy" + }, + { + "target": "com.amazonaws.redshiftserverless#ListTagsForResource" + }, + { + "target": "com.amazonaws.redshiftserverless#PutResourcePolicy" + }, + { + "target": "com.amazonaws.redshiftserverless#TagResource" + }, + { + "target": "com.amazonaws.redshiftserverless#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.redshiftserverless#CrossVpcEndpointResource" + }, + { + "target": "com.amazonaws.redshiftserverless#NamespaceResource" + }, + { + "target": "com.amazonaws.redshiftserverless#RecoveryPointResource" + }, + { + "target": "com.amazonaws.redshiftserverless#SnapshotResource" + }, + { + "target": "com.amazonaws.redshiftserverless#UsageLimitResource" + }, + { + "target": "com.amazonaws.redshiftserverless#WorkgroupResource" + } + ] + }, + "com.amazonaws.redshiftserverless#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceName": { + "target": "com.amazonaws.redshiftserverless#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource that could not be found.

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

The resource could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.redshiftserverless#ResourcePolicy": { + "type": "structure", + "members": { + "resourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

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

The resource policy.

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

The resource policy object. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

" + } + }, + "com.amazonaws.redshiftserverless#RestoreFromRecoveryPoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#RestoreFromRecoveryPointRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#RestoreFromRecoveryPointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Restore the data from a recovery point.

" + } + }, + "com.amazonaws.redshiftserverless#RestoreFromRecoveryPointRequest": { + "type": "structure", + "members": { + "recoveryPointId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the recovery point to restore from.

", + "smithy.api#required": {} + } + }, + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace to restore data into.

", + "smithy.api#required": {} + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup used to restore data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#RestoreFromRecoveryPointResponse": { + "type": "structure", + "members": { + "recoveryPointId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the recovery point used for the restore.

" + } + }, + "namespace": { + "target": "com.amazonaws.redshiftserverless#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that data was restored into.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#RestoreFromSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#RestoreFromSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#RestoreFromSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Restores a namespace from a snapshot.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.redshiftserverless#RestoreFromSnapshotRequest": { + "type": "structure", + "members": { + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace to restore the snapshot to.

", + "smithy.api#required": {} + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup used to restore the snapshot.

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

The name of the snapshot to restore from.

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

The Amazon Resource Name (ARN) of the snapshot to restore from.

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

The Amazon Web Services account that owns the snapshot.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#RestoreFromSnapshotResponse": { + "type": "structure", + "members": { + "snapshotName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot used to restore the namespace.

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

The owner Amazon Web Services; account of the snapshot that was restored.

" + } + }, + "namespace": { + "target": "com.amazonaws.redshiftserverless#Namespace" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#SecurityGroupId": { + "type": "string" + }, + "com.amazonaws.redshiftserverless#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#SecurityGroupId" + } + }, + "com.amazonaws.redshiftserverless#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The service limit was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.redshiftserverless#Snapshot": { + "type": "structure", + "members": { + "namespaceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the namepsace.

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

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

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

The name of the snapshot.

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

The timestamp of when the snapshot was created.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "adminUsername": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The username of the database within a snapshot.

" + } + }, + "status": { + "target": "com.amazonaws.redshiftserverless#SnapshotStatus", + "traits": { + "smithy.api#documentation": "

The status of the snapshot.

" + } + }, + "kmsKeyId": { + "target": "com.amazonaws.redshiftserverless#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the KMS key used to encrypt the snapshot.

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

The owner Amazon Web Services; account of the snapshot.

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

The total size, in megabytes, of how big the snapshot is.

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

The size of the incremental backup in megabytes.

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

The size in megabytes of the data that has been backed up to a snapshot.

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

The rate at which data is backed up into a snapshot in megabytes per second.

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

The estimated amount of seconds until the snapshot completes backup.

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

The amount of time it took to back up data into a snapshot.

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

The period of time, in days, of how long the snapshot is retained.

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

The amount of days until the snapshot is deleted.

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

The timestamp of when data within the snapshot started getting retained.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "snapshotArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot.

" + } + }, + "accountsWithRestoreAccess": { + "target": "com.amazonaws.redshiftserverless#AccountIdList", + "traits": { + "smithy.api#documentation": "

All of the Amazon Web Services accounts that have access to \n restore a snapshot to a namespace.

" + } + }, + "accountsWithProvisionedRestoreAccess": { + "target": "com.amazonaws.redshiftserverless#AccountIdList", + "traits": { + "smithy.api#documentation": "

All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

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

A snapshot object that contains databases.

" + } + }, + "com.amazonaws.redshiftserverless#SnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#Snapshot" + } + }, + "com.amazonaws.redshiftserverless#SnapshotResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.redshiftserverless#CreateSnapshot" + }, + { + "target": "com.amazonaws.redshiftserverless#DeleteSnapshot" + }, + { + "target": "com.amazonaws.redshiftserverless#GetSnapshot" + }, + { + "target": "com.amazonaws.redshiftserverless#ListSnapshots" + }, + { + "target": "com.amazonaws.redshiftserverless#RestoreFromSnapshot" + }, + { + "target": "com.amazonaws.redshiftserverless#UpdateSnapshot" + } + ] + }, + "com.amazonaws.redshiftserverless#SnapshotStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "AVAILABLE", + "value": "AVAILABLE" + }, + { + "name": "CREATING", + "value": "CREATING" + }, + { + "name": "DELETED", + "value": "DELETED" + }, + { + "name": "CANCELLED", + "value": "CANCELLED" + }, + { + "name": "FAILED", + "value": "FAILED" + }, + { + "name": "COPYING", + "value": "COPYING" + } + ] + } + }, + "com.amazonaws.redshiftserverless#SubnetId": { + "type": "string" + }, + "com.amazonaws.redshiftserverless#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#SubnetId" + } + }, + "com.amazonaws.redshiftserverless#Tag": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.redshiftserverless#TagKey", + "traits": { + "smithy.api#documentation": "

The key to use in the tag.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.redshiftserverless#TagValue", + "traits": { + "smithy.api#documentation": "

The value of the tag.

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

A map of key-value pairs.

" + } + }, + "com.amazonaws.redshiftserverless#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.redshiftserverless#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.redshiftserverless#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.redshiftserverless#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#TooManyTagsException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns one or more tags to a resource.

" + } + }, + "com.amazonaws.redshiftserverless#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.redshiftserverless#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to tag.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.redshiftserverless#TagList", + "traits": { + "smithy.api#documentation": "

The map of the key-value pairs used to tag the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.redshiftserverless#ThrottlingException": { + "type": "structure", + "members": { + "code": { + "target": "smithy.api#String" + }, + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.redshiftserverless#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceName": { + "target": "com.amazonaws.redshiftserverless#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The name of the resource that exceeded the number of tags allowed for a resource.

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

The request exceeded the number of tags allowed for a resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshiftserverless#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ThrottlingException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag or set of tags from a resource.

" + } + }, + "com.amazonaws.redshiftserverless#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.redshiftserverless#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove tags from.

", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.redshiftserverless#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag or set of tags to remove from the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateEndpointAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#UpdateEndpointAccessRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#UpdateEndpointAccessResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#AccessDeniedException" + }, + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon Redshift Serverless managed endpoint.

" + } + }, + "com.amazonaws.redshiftserverless#UpdateEndpointAccessRequest": { + "type": "structure", + "members": { + "endpointName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the VPC endpoint to update.

", + "smithy.api#required": {} + } + }, + "vpcSecurityGroupIds": { + "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The list of VPC security groups associated with the endpoint after the endpoint is modified.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateEndpointAccessResponse": { + "type": "structure", + "members": { + "endpoint": { + "target": "com.amazonaws.redshiftserverless#EndpointAccess", + "traits": { + "smithy.api#documentation": "

The updated VPC endpoint.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#UpdateNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#UpdateNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a namespace with the specified settings.

" + } + }, + "com.amazonaws.redshiftserverless#UpdateNamespaceRequest": { + "type": "structure", + "members": { + "namespaceName": { + "target": "com.amazonaws.redshiftserverless#NamespaceName", + "traits": { + "smithy.api#documentation": "

The name of the namespace.

", + "smithy.api#required": {} + } + }, + "adminUserPassword": { + "target": "com.amazonaws.redshiftserverless#DbPassword", + "traits": { + "smithy.api#documentation": "

The password of the administrator for the first database created in the namespace.

" + } + }, + "adminUsername": { + "target": "com.amazonaws.redshiftserverless#DbUser", + "traits": { + "smithy.api#documentation": "

The username of the administrator for the first database created in the namespace.

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

The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

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

The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

" + } + }, + "iamRoles": { + "target": "com.amazonaws.redshiftserverless#IamRoleArnList", + "traits": { + "smithy.api#documentation": "

A list of IAM roles to associate with the namespace.

" + } + }, + "logExports": { + "target": "com.amazonaws.redshiftserverless#LogExportList", + "traits": { + "smithy.api#documentation": "

The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateNamespaceResponse": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.redshiftserverless#Namespace", + "traits": { + "smithy.api#documentation": "

A list of tag instances.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#UpdateSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#UpdateSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a snapshot.

" + } + }, + "com.amazonaws.redshiftserverless#UpdateSnapshotRequest": { + "type": "structure", + "members": { + "snapshotName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot.

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

The new retention period of the snapshot.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateSnapshotResponse": { + "type": "structure", + "members": { + "snapshot": { + "target": "com.amazonaws.redshiftserverless#Snapshot", + "traits": { + "smithy.api#documentation": "

The updated snapshot object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateUsageLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#UpdateUsageLimitRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#UpdateUsageLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

" + } + }, + "com.amazonaws.redshiftserverless#UpdateUsageLimitRequest": { + "type": "structure", + "members": { + "usageLimitId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the usage limit to update.

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

The new limit amount. For more information about this parameter.

" + } + }, + "breachAction": { + "target": "com.amazonaws.redshiftserverless#UsageLimitBreachAction", + "traits": { + "smithy.api#documentation": "

The new action that Amazon Redshift Serverless takes when the limit is reached.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateUsageLimitResponse": { + "type": "structure", + "members": { + "usageLimit": { + "target": "com.amazonaws.redshiftserverless#UsageLimit", + "traits": { + "smithy.api#documentation": "

The updated usage limit object.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateWorkgroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshiftserverless#UpdateWorkgroupRequest" + }, + "output": { + "target": "com.amazonaws.redshiftserverless#UpdateWorkgroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.redshiftserverless#ConflictException" + }, + { + "target": "com.amazonaws.redshiftserverless#InsufficientCapacityException" + }, + { + "target": "com.amazonaws.redshiftserverless#InternalServerException" + }, + { + "target": "com.amazonaws.redshiftserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.redshiftserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a workgroup with the specified configuration settings.

" + } + }, + "com.amazonaws.redshiftserverless#UpdateWorkgroupRequest": { + "type": "structure", + "members": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup to update.

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

The new base data warehouse capacity in Redshift Processing Units (RPUs).

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

The value that specifies whether to turn on enhanced virtual \n private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

" + } + }, + "configParameters": { + "target": "com.amazonaws.redshiftserverless#ConfigParameterList", + "traits": { + "smithy.api#documentation": "

An array of parameters to set for advanced control over a database. The\n options are datestyle, enable_user_activity_logging,\n query_group, search_path, and max_query_execution_time.

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

A value that specifies whether the workgroup can be accessible from a public network.

" + } + }, + "subnetIds": { + "target": "com.amazonaws.redshiftserverless#SubnetIdList", + "traits": { + "smithy.api#documentation": "

An array of VPC subnet IDs to associate with the workgroup.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.redshiftserverless#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

An array of security group IDs to associate with the workgroup.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.redshiftserverless#UpdateWorkgroupResponse": { + "type": "structure", + "members": { + "workgroup": { + "target": "com.amazonaws.redshiftserverless#Workgroup", + "traits": { + "smithy.api#documentation": "

The updated workgroup object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.redshiftserverless#UsageLimit": { + "type": "structure", + "members": { + "usageLimitId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the usage limit.

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

The Amazon Resource Name (ARN) of the resource associated with the usage limit.

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

The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

" + } + }, + "usageType": { + "target": "com.amazonaws.redshiftserverless#UsageLimitUsageType", + "traits": { + "smithy.api#documentation": "

The Amazon Redshift Serverless feature to limit.

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

The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

" + } + }, + "period": { + "target": "com.amazonaws.redshiftserverless#UsageLimitPeriod", + "traits": { + "smithy.api#documentation": "

The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

" + } + }, + "breachAction": { + "target": "com.amazonaws.redshiftserverless#UsageLimitBreachAction", + "traits": { + "smithy.api#documentation": "

The action that Amazon Redshift Serverless takes when the limit is reached.

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

The usage limit object.

" + } + }, + "com.amazonaws.redshiftserverless#UsageLimitBreachAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "LOG", + "value": "log" + }, + { + "name": "EMIT_METRIC", + "value": "emit-metric" + }, + { + "name": "DEACTIVATE", + "value": "deactivate" + } + ] + } + }, + "com.amazonaws.redshiftserverless#UsageLimitPeriod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DAILY", + "value": "daily" + }, + { + "name": "WEEKLY", + "value": "weekly" + }, + { + "name": "MONTHLY", + "value": "monthly" + } + ] + } + }, + "com.amazonaws.redshiftserverless#UsageLimitResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.redshiftserverless#CreateUsageLimit" + }, + { + "target": "com.amazonaws.redshiftserverless#DeleteUsageLimit" + }, + { + "target": "com.amazonaws.redshiftserverless#GetUsageLimit" + }, + { + "target": "com.amazonaws.redshiftserverless#ListUsageLimits" + }, + { + "target": "com.amazonaws.redshiftserverless#UpdateUsageLimit" + } + ] + }, + "com.amazonaws.redshiftserverless#UsageLimitUsageType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SERVERLESS_COMPUTE", + "value": "serverless-compute" + }, + { + "name": "CROSS_REGION_DATASHARING", + "value": "cross-region-datasharing" + } + ] + } + }, + "com.amazonaws.redshiftserverless#UsageLimits": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#UsageLimit" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.redshiftserverless#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input failed to satisfy the constraints specified by an AWS service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshiftserverless#VpcEndpoint": { + "type": "structure", + "members": { + "vpcEndpointId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The connection endpoint ID for connecting to Amazon Redshift Serverless.

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

The VPC identifier that the endpoint is associated with.

" + } + }, + "networkInterfaces": { + "target": "com.amazonaws.redshiftserverless#NetworkInterfaceList", + "traits": { + "smithy.api#documentation": "

One or more network interfaces of the endpoint. Also known as an interface endpoint.

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

The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

" + } + }, + "com.amazonaws.redshiftserverless#VpcEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#VpcEndpoint" + } + }, + "com.amazonaws.redshiftserverless#VpcSecurityGroupId": { + "type": "string" + }, + "com.amazonaws.redshiftserverless#VpcSecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupId" + } + }, + "com.amazonaws.redshiftserverless#VpcSecurityGroupMembership": { + "type": "structure", + "members": { + "vpcSecurityGroupId": { + "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the VPC security group.

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

The status of the VPC security group.

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

Describes the members of a VPC security group.

" + } + }, + "com.amazonaws.redshiftserverless#VpcSecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#VpcSecurityGroupMembership" + } + }, + "com.amazonaws.redshiftserverless#Workgroup": { + "type": "structure", + "members": { + "workgroupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the workgroup.

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

The Amazon Resource Name (ARN) that links to the workgroup.

" + } + }, + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName", + "traits": { + "smithy.api#documentation": "

The name of the workgroup.

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

The namespace the workgroup is associated with.

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

The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

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

The value that specifies whether to enable enhanced virtual \n private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

" + } + }, + "configParameters": { + "target": "com.amazonaws.redshiftserverless#ConfigParameterList", + "traits": { + "smithy.api#documentation": "

An array of parameters to set for finer control over a database. The\n options are datestyle, enable_user_activity_logging,\n query_group, search_path, and max_query_execution_time.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.redshiftserverless#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

An array of security group IDs to associate with the workgroup.

" + } + }, + "subnetIds": { + "target": "com.amazonaws.redshiftserverless#SubnetIdList", + "traits": { + "smithy.api#documentation": "

An array of subnet IDs the workgroup is associated with.

" + } + }, + "status": { + "target": "com.amazonaws.redshiftserverless#WorkgroupStatus", + "traits": { + "smithy.api#documentation": "

The status of the workgroup.

" + } + }, + "endpoint": { + "target": "com.amazonaws.redshiftserverless#Endpoint", + "traits": { + "smithy.api#documentation": "

The endpoint that is created from the workgroup.

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

A value that specifies whether the workgroup \n can be accessible from a public network

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

The creation date of the workgroup.

", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "

The collection of computing resources from which an endpoint is created.

" + } + }, + "com.amazonaws.redshiftserverless#WorkgroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshiftserverless#Workgroup" + } + }, + "com.amazonaws.redshiftserverless#WorkgroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + }, + "smithy.api#pattern": "^[a-z0-9-]+$" + } + }, + "com.amazonaws.redshiftserverless#WorkgroupResource": { + "type": "resource", + "identifiers": { + "workgroupName": { + "target": "com.amazonaws.redshiftserverless#WorkgroupName" + } + }, + "put": { + "target": "com.amazonaws.redshiftserverless#CreateWorkgroup" + }, + "read": { + "target": "com.amazonaws.redshiftserverless#GetWorkgroup" + }, + "update": { + "target": "com.amazonaws.redshiftserverless#UpdateWorkgroup" + }, + "delete": { + "target": "com.amazonaws.redshiftserverless#DeleteWorkgroup" + }, + "list": { + "target": "com.amazonaws.redshiftserverless#ListWorkgroups" + }, + "traits": { + "aws.api#arn": { + "template": "workgroup/{workgroupName}" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.redshiftserverless#WorkgroupStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "CREATING", + "value": "CREATING" + }, + { + "name": "AVAILABLE", + "value": "AVAILABLE" + }, + { + "name": "MODIFYING", + "value": "MODIFYING" + }, + { + "name": "DELETING", + "value": "DELETING" + } + ] + } + } + } +} diff --git a/aws/sdk/aws-models/route53.json b/aws/sdk/aws-models/route53.json index 946527cca..e0f2cf39a 100644 --- a/aws/sdk/aws-models/route53.json +++ b/aws/sdk/aws-models/route53.json @@ -29,6 +29,16 @@ ] }, "shapes": { + "com.amazonaws.route53#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } + }, "com.amazonaws.route53#AWSAccountID": { "type": "string" }, @@ -46,7 +56,7 @@ "name": "route53" }, "aws.protocols#restXml": {}, - "smithy.api#documentation": "

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.

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

Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.

", "smithy.api#title": "Amazon Route 53", "smithy.api#xmlNamespace": { "uri": "https://route53.amazonaws.com/doc/2013-04-01/" @@ -60,12 +70,18 @@ { "target": "com.amazonaws.route53#AssociateVPCWithHostedZone" }, + { + "target": "com.amazonaws.route53#ChangeCidrCollection" + }, { "target": "com.amazonaws.route53#ChangeResourceRecordSets" }, { "target": "com.amazonaws.route53#ChangeTagsForResource" }, + { + "target": "com.amazonaws.route53#CreateCidrCollection" + }, { "target": "com.amazonaws.route53#CreateHealthCheck" }, @@ -96,6 +112,9 @@ { "target": "com.amazonaws.route53#DeactivateKeySigningKey" }, + { + "target": "com.amazonaws.route53#DeleteCidrCollection" + }, { "target": "com.amazonaws.route53#DeleteHealthCheck" }, @@ -183,6 +202,15 @@ { "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCount" }, + { + "target": "com.amazonaws.route53#ListCidrBlocks" + }, + { + "target": "com.amazonaws.route53#ListCidrCollections" + }, + { + "target": "com.amazonaws.route53#ListCidrLocations" + }, { "target": "com.amazonaws.route53#ListGeoLocations" }, @@ -254,20 +282,20 @@ "Type": { "target": "com.amazonaws.route53#AccountLimitType", "traits": { - "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n\t\t
    \n
  • \n

    \n MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create \n\t\t\t\tusing the current account.

    \n
    • \n
  • \n

    \n MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create \n\t\t\t\tusing the current account.

    \n
    • \n
  • \n

    \n MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets \n\t\t\t\tthat you can create using the current account.

    \n
    • \n
  • \n

    \n MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies \n\t\t\t\tthat you can create using the current account.

    \n
    • \n
  • \n

    \n MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances \n\t\t\t\tthat you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the \n\t\t\t\tAmazon Route 53 console.)

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

The limit that you requested. Valid values include the following:

\n\t\t
    \n
  • \n\t\t\t\t

    \n MAX_HEALTH_CHECKS_BY_OWNER: The maximum\n\t\t\t\t\tnumber of health checks that you can create using the current account.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_HOSTED_ZONES_BY_OWNER: The maximum number\n\t\t\t\t\tof hosted zones that you can create using the current account.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The\n\t\t\t\t\tmaximum number of reusable delegation sets that you can create using the current\n\t\t\t\t\taccount.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum\n\t\t\t\t\tnumber of traffic policies that you can create using the current account.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The\n\t\t\t\t\tmaximum number of traffic policy instances that you can create using the current\n\t\t\t\t\taccount. (Traffic policy instances are referred to as traffic flow policy\n\t\t\t\t\trecords in the Amazon Route 53 console.)

    \n\t\t\t
    • \n
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.route53#LimitValue", "traits": { - "smithy.api#documentation": "

The current value for the limit that is specified by \n\t\t\tType.

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

The current value for the limit that is specified by Type.

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

A complex type that contains the type of limit that you specified in the request and the current value for that limit.

" + "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" } }, "com.amazonaws.route53#AccountLimitType": { @@ -326,7 +354,7 @@ } ], "traits": { - "smithy.api#documentation": "

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the \n\t\t\tKSK status to ACTIVE.

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

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This\n\t\t\toperation changes the KSK status to ACTIVE.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate", @@ -348,7 +376,7 @@ "Name": { "target": "com.amazonaws.route53#SigningKeyName", "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same \n\t\t\thosted zone.

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

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -372,20 +400,20 @@ "Region": { "target": "com.amazonaws.route53#CloudWatchRegion", "traits": { - "smithy.api#documentation": "

For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, \n\t\t\tthe region that the alarm was created in.

\n\t

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas in \n\t\t\tthe Amazon Web Services General Reference.

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

For the CloudWatch alarm that you want Route 53 health checkers to use to determine\n\t\t\twhether this health check is healthy, the region that the alarm was created in.

\n\t\t

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and\n\t\t\t\tquotas in the Amazon Web Services General\n\t\t\tReference.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.route53#AlarmName", "traits": { - "smithy.api#documentation": "

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

\n\t\t \n

Route 53 supports CloudWatch alarms with the following features:

\n\t\t\t
    \n
  • \n

    Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see \n\t\t\t\t\tHigh-Resolution Metrics \n\t\t\t\t\tin the Amazon CloudWatch User Guide.

    \n
    • \n
  • \n

    Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.

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

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use\n\t\t\tto determine whether this health check is healthy.

\n\t\t \n\t\t\t

Route 53 supports CloudWatch alarms with the following features:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    Standard-resolution metrics. High-resolution metrics aren't supported. For\n\t\t\t\t\t\tmore information, see High-Resolution Metrics in the Amazon CloudWatch User\n\t\t\t\t\t\t\tGuide.

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended\n\t\t\t\t\t\tstatistics aren't supported.

    \n\t\t\t\t
    • \n
\n\t\t ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether \n\t\t\tthe specified health check is healthy.

" + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" } }, "com.amazonaws.route53#AlarmName": { @@ -406,27 +434,27 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

\n Alias resource records sets only: The value used depends on where you want to route traffic:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the hosted zone ID for your API. You can get the applicable value using the CLI command \n\t\t\t\t\tget-domain-names:

\n\t\t\t\t\t
    \n
  • \n

    For regional APIs, specify the value of regionalHostedZoneId.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of distributionHostedZoneId.

    \n
    • \n
\n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId \n\t\t\t\t\tusing the CLI command \n\t\t\t\t\tdescribe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n\t\t\t\t\t

Specify Z2FDTNDATAQYW2.

\n\t\t\t\t\t \n\t\t\t\t\t\t

Alias resource record sets for CloudFront can't be created in a private zone.

\n\t\t\t\t\t \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the environment in. The environment \n\t\t\t\t\t\tmust have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see \n\t\t\t\t\t Elastic Beanstalk endpoints and quotas in the \n\t\t\t\t\t\t the Amazon Web Services General Reference.

\n\t\t\t\t
\n
ELB load balancer
\n
\n\t\t\t\t\t

Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the \n\t\t\t\t\t\thosted zone ID:

\n\t\t\t\t\t
    \n
  • \n

    \n Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: \n\t\t\t\t\t\t\tUse the value that corresponds with the region that you created your load balancer in. Note that there are \n\t\t\t\t\t\t\tseparate columns for Application and Classic Load Balancers and for Network Load Balancers.

    \n
    • \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: Go to the Amazon EC2 page, choose \n\t\t\t\t\t\t\t\tLoad Balancers in the navigation pane, select the load balancer, and get the value of the \n\t\t\t\t\t\t\t\tHosted zone field on the Description tab.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use DescribeLoadBalancers to get the \n\t\t\t\t\t\t\t\tapplicable value. For more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      Classic Load Balancers: Use \n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers \n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use \n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneId.

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use describe-load-balancers to get the applicable value. \n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      Classic Load Balancers: Use \n\t\t\t\t\t\t\t\t\tdescribe-load-balancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneNameId.

      \n
      • \n
    • \n

      Application and Network Load Balancers: Use \n\t\t\t\t\t\t\t\t\tdescribe-load-balancers\n\t\t\t\t\t\t\t\t\tto get the value of CanonicalHostedZoneId.

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n

Specify Z2BJ6XQ5FK7U4H.

\n
\n
An Amazon S3 bucket configured as a static website
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the bucket in. For more information about \n\t\t\t\t\t\tvalid values, see the table \n\t\t\t\t\t\tAmazon S3 Website Endpoints \n\t\t\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t\t\t
\n
Another Route 53 resource record set in your hosted zone
\n
\n\t\t\t\t\t

Specify the hosted zone ID of your hosted zone. (An alias resource record set\n\t\t\t\t\t\tcan't reference a resource record set in a different hosted zone.)

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

\n Alias resource records sets only: The value used depends on where\n\t\t\tyou want to route traffic:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n\t\t\t\t\t

Specify the hosted zone ID for your API. You can get the applicable value\n\t\t\t\t\t\tusing the CLI command get-domain-names:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalHostedZoneId.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionHostedZoneId.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n\t\t\t\t\t

Specify the hosted zone ID for your interface endpoint. You can get the\n\t\t\t\t\t\tvalue of HostedZoneId using the CLI command\n\t\t\t\t\t\t\tdescribe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n\t\t\t\t\t

Specify Z2FDTNDATAQYW2.

\n\t\t\t\t\t \n\t\t\t\t\t\t

Alias resource record sets for CloudFront can't be created in a\n\t\t\t\t\t\t\tprivate zone.

\n\t\t\t\t\t \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the environment\n\t\t\t\t\t\tin. The environment must have a regionalized subdomain. For a list of\n\t\t\t\t\t\tregions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the\n\t\t\t\t\t\t\tAmazon Web Services General Reference.

\n\t\t\t\t
\n
ELB load balancer
\n
\n\t\t\t\t\t

Specify the value of the hosted zone ID for the load balancer. Use the\n\t\t\t\t\t\tfollowing methods to get the hosted zone ID:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing endpoints and quotas topic in\n\t\t\t\t\t\t\t\tthe Amazon Web Services General Reference: Use\n\t\t\t\t\t\t\t\tthe value that corresponds with the region that you created your\n\t\t\t\t\t\t\t\tload balancer in. Note that there are separate columns for\n\t\t\t\t\t\t\t\tApplication and Classic Load Balancers and for Network Load\n\t\t\t\t\t\t\t\tBalancers.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tAmazon EC2 page, choose Load\n\t\t\t\t\t\t\t\t\tBalancers in the navigation pane, select the load\n\t\t\t\t\t\t\t\tbalancer, and get the value of the Hosted\n\t\t\t\t\t\t\t\t\tzone field on the Description tab.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the applicable value.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      Classic Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the applicable\n\t\t\t\t\t\t\t\tvalue. For more information, see the applicable guide:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      Classic Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      Application and Network Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n\t\t\t\t\t

Specify Z2BJ6XQ5FK7U4H.

\n\t\t\t\t
\n
An Amazon S3 bucket configured as a static website
\n
\n\t\t\t\t\t

Specify the hosted zone ID for the region that you created the bucket in.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference.

\n\t\t\t\t
\n
Another Route 53 resource record set in your hosted zone
\n
\n\t\t\t\t\t

Specify the hosted zone ID of your hosted zone. (An alias resource record\n\t\t\t\t\t\tset can't reference a resource record set in a different hosted\n\t\t\t\t\t\tzone.)

\n\t\t\t\t
\n
", "smithy.api#required": {} } }, "DNSName": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

\n Alias resource record sets only: The value that you specify depends on where you want to route queries:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n

Specify the applicable domain name for your API. You can get the applicable value using the CLI command \n\t\t\t\t\tget-domain-names:

\n\t\t\t\t\t
    \n
  • \n

    For regional APIs, specify the value of regionalDomainName.

    \n
    • \n
  • \n

    For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the \n\t\t\t\t\t\t\tassociated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

    \n
    • \n
\n\t\t\t\t\t \n\t\t\t\t\t\t

The name of the record that you're creating must match a custom domain name for your API, such as \n\t\t\t\t\t\t\tapi.example.com.

\n\t\t\t\t\t \n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n

Enter the API endpoint for the interface endpoint, such as \n\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, \n\t\t\t\t\tthis is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command \n\t\t\t\t\tdescribe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n

Specify the domain name that CloudFront assigned when you created your distribution.

\n\t\t\t\t\t

Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. \n\t\t\t\t\t\tFor example, if the name of the resource record set is acme.example.com, your CloudFront distribution must \n\t\t\t\t\t\tinclude acme.example.com as one of the alternate domain names. For more information, see \n\t\t\t\t\t\tUsing Alternate Domain Names (CNAMEs) in the \n\t\t\t\t\t\tAmazon CloudFront Developer Guide.

\n\t\t\t\t\t

You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

\n\t\t\t\t\t \n

For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. \n\t\t\t\t\t\tA distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records \n\t\t\t\t\t\thave the same name, and you can't include the same alternate domain name in more than one distribution.

\n \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, \n\t\t\t\t\t\tyou can create an alias record that routes traffic to the environment. For example, the domain name \n\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

\n\t\t\t\t\t \n\t\t\t\t\t\t

For environments that were created before early 2016, the domain name doesn't include the region. To route traffic \n\t\t\t\t\t\t\tto these environments, you must create a CNAME record instead of an alias record. Note that you can't create a \n\t\t\t\t\t\t\tCNAME record for the root domain name. For example, if your domain name is example.com, you can create a record \n\t\t\t\t\t\t\tthat routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record \n\t\t\t\t\t\t\tthat routes traffic for example.com to your Elastic Beanstalk environment.

\n\t\t\t\t\t \n\t\t\t\t\t

For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. \n\t\t\t\t\t\tYou can use the following methods to get the value of the CNAME attribute:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: For information about how to get the value by using the console, \n\t\t\t\t\t\t\t\tsee Using Custom Domains with Elastic Beanstalk in the \n\t\t\t\t\t\t\t\tElastic Beanstalk Developer Guide.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Beanstalk API: Use the DescribeEnvironments action to get \n\t\t\t\t\t\t\t\tthe value of the CNAME attribute. For more information, see \n\t\t\t\t\t\t\t\tDescribeEnvironments \n\t\t\t\t\t\t\t\tin the Elastic Beanstalk API Reference.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use the describe-environments command to get the value of the \n\t\t\t\t\t\t\t\tCNAME attribute. For more information, see \n\t\t\t\t\t\t\t\tdescribe-environments in the \n\t\t\t\t\t\t\t\tCLI Command Reference.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
ELB load balancer
\n
\n

Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, \n\t\t\t\t\tthe ELB API, or the CLI.

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: Go to the EC2 page, choose Load Balancers \n\t\t\t\t\t\t\t\tin the navigation pane, choose the load balancer, choose the Description tab, and get the value \n\t\t\t\t\t\t\t\tof the DNS name field.

    \n\t\t\t\t\t\t\t

    If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. \n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use DescribeLoadBalancers to get the value \n\t\t\t\t\t\t\t\tof DNSName. For more information, see the applicable guide:

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use describe-load-balancers to get the value of DNSName.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n

Specify the DNS name for your accelerator:

\n\t\t\t\t\t \n\t\t\t\t
\n
Amazon S3 bucket that is configured as a static website
\n
\n

Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, \n\t\t\t\t\ts3-website.us-east-2.amazonaws.com. For more information about valid values, see the table \n\t\t\t\t\tAmazon S3 Website Endpoints \n\t\t\t\t\tin the Amazon Web Services General Reference. For more information about using S3 buckets for websites, \n\t\t\t\t\tsee Getting Started with Amazon Route 53 \n\t\t\t\t\tin the Amazon Route 53 Developer Guide.\n

\n
\n
Another Route 53 resource record set
\n
\n

Specify the value of the Name element for a resource record set in the current hosted zone.

\n\t\t\t\t\t \n

If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), \n\t\t\t\t\t\tyou can't specify the domain name for a record for which the value of Type is CNAME. This is because \n\t\t\t\t\t\tthe alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the \n\t\t\t\t\t\tzone apex isn't supported even for an alias record.

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

\n Alias resource record sets only: The value that you specify\n\t\t\tdepends on where you want to route queries:

\n\t\t
\n
Amazon API Gateway custom regional APIs and edge-optimized APIs
\n
\n\t\t\t\t\t

Specify the applicable domain name for your API. You can get the\n\t\t\t\t\t\tapplicable value using the CLI command get-domain-names:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    For regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalDomainName.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionDomainName. This is the name of the\n\t\t\t\t\t\t\t\tassociated CloudFront distribution, such as\n\t\t\t\t\t\t\t\t\tda1b2c3d4e5.cloudfront.net.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t \n\t\t\t\t\t\t

The name of the record that you're creating must match a custom domain\n\t\t\t\t\t\t\tname for your API, such as api.example.com.

\n\t\t\t\t\t \n\t\t\t\t
\n
Amazon Virtual Private Cloud interface VPC endpoint
\n
\n\t\t\t\t\t

Enter the API endpoint for the interface endpoint, such as\n\t\t\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com.\n\t\t\t\t\t\tFor edge-optimized APIs, this is the domain name for the corresponding\n\t\t\t\t\t\tCloudFront distribution. You can get the value of DnsName using\n\t\t\t\t\t\tthe CLI command describe-vpc-endpoints.

\n\t\t\t\t
\n
CloudFront distribution
\n
\n\t\t\t\t\t

Specify the domain name that CloudFront assigned when you created your\n\t\t\t\t\t\tdistribution.

\n\t\t\t\t\t

Your CloudFront distribution must include an alternate domain name that\n\t\t\t\t\t\tmatches the name of the resource record set. For example, if the name of the\n\t\t\t\t\t\tresource record set is acme.example.com, your\n\t\t\t\t\t\tCloudFront distribution must include acme.example.com\n\t\t\t\t\t\tas one of the alternate domain names. For more information, see Using Alternate\n\t\t\t\t\t\t\tDomain Names (CNAMEs) in the Amazon CloudFront\n\t\t\t\t\t\t\tDeveloper Guide.

\n\t\t\t\t\t

You can't create a resource record set in a private hosted zone to route\n\t\t\t\t\t\ttraffic to a CloudFront distribution.

\n\t\t\t\t\t \n\t\t\t\t\t\t

For failover alias records, you can't specify a CloudFront\n\t\t\t\t\t\t\tdistribution for both the primary and secondary records. A distribution\n\t\t\t\t\t\t\tmust include an alternate domain name that matches the name of the\n\t\t\t\t\t\t\trecord. However, the primary and secondary records have the same name,\n\t\t\t\t\t\t\tand you can't include the same alternate domain name in more than one\n\t\t\t\t\t\t\tdistribution.

\n\t\t\t\t\t \n\t\t\t\t
\n
Elastic Beanstalk environment
\n
\n\t\t\t\t\t

If the domain name for your Elastic Beanstalk environment includes the\n\t\t\t\t\t\tregion that you deployed the environment in, you can create an alias record\n\t\t\t\t\t\tthat routes traffic to the environment. For example, the domain name\n\t\t\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com\n\t\t\t\t\t\tis a regionalized domain name.

\n\t\t\t\t\t \n\t\t\t\t\t\t

For environments that were created before early 2016, the domain name\n\t\t\t\t\t\t\tdoesn't include the region. To route traffic to these environments, you\n\t\t\t\t\t\t\tmust create a CNAME record instead of an alias record. Note that you\n\t\t\t\t\t\t\tcan't create a CNAME record for the root domain name. For example, if\n\t\t\t\t\t\t\tyour domain name is example.com, you can create a record that routes\n\t\t\t\t\t\t\ttraffic for acme.example.com to your Elastic Beanstalk environment, but\n\t\t\t\t\t\t\tyou can't create a record that routes traffic for example.com to your\n\t\t\t\t\t\t\tElastic Beanstalk environment.

\n\t\t\t\t\t \n\t\t\t\t\t

For Elastic Beanstalk environments that have regionalized subdomains,\n\t\t\t\t\t\tspecify the CNAME attribute for the environment. You can use\n\t\t\t\t\t\tthe following methods to get the value of the CNAME attribute:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: For information about\n\t\t\t\t\t\t\t\thow to get the value by using the console, see Using Custom\n\t\t\t\t\t\t\t\t\tDomains with Elastic Beanstalk in the\n\t\t\t\t\t\t\t\t\t\tElastic Beanstalk Developer\n\t\t\t\t\t\t\t\tGuide.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Beanstalk API: Use the\n\t\t\t\t\t\t\t\t\tDescribeEnvironments action to get the value of the\n\t\t\t\t\t\t\t\t\tCNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use the\n\t\t\t\t\t\t\t\t\tdescribe-environments command to get the value of\n\t\t\t\t\t\t\t\tthe CNAME attribute. For more information, see describe-environments in the CLI Command Reference.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
ELB load balancer
\n
\n\t\t\t\t\t

Specify the DNS name that is associated with the load balancer. Get the\n\t\t\t\t\t\tDNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tEC2 page, choose Load Balancers in\n\t\t\t\t\t\t\t\tthe navigation pane, choose the load balancer, choose the Description tab, and get the value of the\n\t\t\t\t\t\t\t\t\tDNS name field.

    \n\t\t\t\t\t\t\t

    If you're routing traffic to a Classic Load Balancer, get the\n\t\t\t\t\t\t\t\tvalue that begins with dualstack.\n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the\n\t\t\t\t\t\t\t\tvalue that applies to the record type, A or AAAA.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      Classic Load Balancers: DescribeLoadBalancers\n\t\t\t\t\t\t\t\t\t

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      Application and Network Load Balancers: DescribeLoadBalancers\n

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Global Accelerator accelerator
\n
\n\t\t\t\t\t

Specify the DNS name for your accelerator:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Global Accelerator API: To get\n\t\t\t\t\t\t\t\tthe DNS name, use DescribeAccelerator.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n CLI: To get the\n\t\t\t\t\t\t\t\tDNS name, use describe-accelerator.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
Amazon S3 bucket that is configured as a static website
\n
\n\t\t\t\t\t

Specify the domain name of the Amazon S3 website endpoint that you created\n\t\t\t\t\t\tthe bucket in, for example, s3-website.us-east-2.amazonaws.com.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference. For more information about using S3 buckets for\n\t\t\t\t\t\twebsites, see Getting Started\n\t\t\t\t\t\t\twith Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.\n

\n\t\t\t\t
\n
Another Route 53 resource record set
\n
\n\t\t\t\t\t

Specify the value of the Name element for a resource record\n\t\t\t\t\t\tset in the current hosted zone.

\n\t\t\t\t\t \n\t\t\t\t\t\t

If you're creating an alias record that has the same name as the\n\t\t\t\t\t\t\thosted zone (known as the zone apex), you can't specify the domain name\n\t\t\t\t\t\t\tfor a record for which the value of Type is\n\t\t\t\t\t\t\t\tCNAME. This is because the alias record must have the\n\t\t\t\t\t\t\tsame type as the record that you're routing traffic to, and creating a\n\t\t\t\t\t\t\tCNAME record for the zone apex isn't supported even for an alias\n\t\t\t\t\t\t\trecord.

\n\t\t\t\t\t \n\t\t\t\t
\n
", "smithy.api#required": {} } }, "EvaluateTargetHealth": { "target": "com.amazonaws.route53#AliasHealthEnabled", "traits": { - "smithy.api#documentation": "

\n Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: \n\t\t\tWhen EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced Amazon Web Services resource, \n\t\t\tsuch as an ELB load balancer or another resource record set in the hosted zone.

\n\t\t

Note the following:

\n\n\t\t
\n
CloudFront distributions
\n
\n

You can't set EvaluateTargetHealth to true when the alias target is a \n\t\t\t\t\tCloudFront distribution.

\n
\n
Elastic Beanstalk environments that have regionalized subdomains
\n
\n

If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, \n\t\t\t\t\tElastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically \n\t\t\t\t\tcontains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to \n\t\t\t\t\ttrue and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, \n\t\t\t\t\tRoute 53 routes queries to other available resources that are healthy, if any.

\n\t\t\t\t\t

If the environment contains a single Amazon EC2 instance, there are no special requirements.

\n
\n
ELB load balancers
\n
\n

Health checking behavior depends on the type of load balancer:

\n\t\t\t\t\t
    \n
  • \n

    \n Classic Load Balancers: If you specify an ELB Classic Load Balancer in \n\t\t\t\t\t\t\tDNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. \n\t\t\t\t\t\t\tIf you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the \n\t\t\t\t\t\t\tload balancer itself is unhealthy, Route 53 routes queries to other resources.

    \n
    • \n
  • \n

    \n Application and Network Load Balancers: If you specify an ELB \n\t\t\t\t\t\t\tApplication or Network Load Balancer and you set EvaluateTargetHealth to true, \n\t\t\t\t\t\t\tRoute 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      For an Application or Network Load Balancer to be considered healthy, every target group that contains targets \n\t\t\t\t\t\t\t\t\tmust contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered \n\t\t\t\t\t\t\t\t\tunhealthy, and Route 53 routes queries to other resources.

      \n
      • \n
    • \n

      A target group that has no registered targets is considered unhealthy.

      \n
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t \n

When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but \n\t\t\t\t\t\tthey perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

\n \n\t\t\t\t
\n
S3 buckets
\n
\n

There are no special requirements for setting EvaluateTargetHealth to true \n\t\t\t\t\twhen the alias target is an S3 bucket.

\n
\n
Other records in the same hosted zone
\n
\n

If the Amazon Web Services resource that you specify in DNSName is a record or a group of records \n\t\t\t\t\t(for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check \n\t\t\t\t\twith all of the records in the alias target. For more information, see \n\t\t\t\t\tWhat Happens When You Omit Health Checks? \n\t\t\t\t\tin the Amazon Route 53 Developer Guide.

\n
\n
\n\t\t\n\t\t

For more information and examples, see \n\t\t\tAmazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

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

\n Applies only to alias, failover alias, geolocation alias, latency alias, and\n\t\t\t\tweighted alias resource record sets: When\n\t\t\t\tEvaluateTargetHealth is true, an alias resource record set\n\t\t\tinherits the health of the referenced Amazon Web Services resource, such as an ELB load\n\t\t\tbalancer or another resource record set in the hosted zone.

\n\t\t

Note the following:

\n\t\t
\n
CloudFront distributions
\n
\n\t\t\t\t\t

You can't set EvaluateTargetHealth to true when\n\t\t\t\t\t\tthe alias target is a CloudFront distribution.

\n\t\t\t\t
\n
Elastic Beanstalk environments that have regionalized subdomains
\n
\n\t\t\t\t\t

If you specify an Elastic Beanstalk environment in DNSName\n\t\t\t\t\t\tand the environment contains an ELB load balancer, Elastic Load Balancing\n\t\t\t\t\t\troutes queries only to the healthy Amazon EC2 instances that are registered\n\t\t\t\t\t\twith the load balancer. (An environment automatically contains an ELB load\n\t\t\t\t\t\tbalancer if it includes more than one Amazon EC2 instance.) If you set\n\t\t\t\t\t\t\tEvaluateTargetHealth to true and either no\n\t\t\t\t\t\tAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\n\t\t\t\t\t\tRoute 53 routes queries to other available resources that are healthy, if\n\t\t\t\t\t\tany.

\n\t\t\t\t\t

If the environment contains a single Amazon EC2 instance, there are no\n\t\t\t\t\t\tspecial requirements.

\n\t\t\t\t
\n
ELB load balancers
\n
\n\t\t\t\t\t

Health checking behavior depends on the type of load balancer:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n Classic Load Balancers: If you\n\t\t\t\t\t\t\t\tspecify an ELB Classic Load Balancer in DNSName,\n\t\t\t\t\t\t\t\tElastic Load Balancing routes queries only to the healthy Amazon EC2\n\t\t\t\t\t\t\t\tinstances that are registered with the load balancer. If you set\n\t\t\t\t\t\t\t\t\tEvaluateTargetHealth to true and\n\t\t\t\t\t\t\t\teither no EC2 instances are healthy or the load balancer itself is\n\t\t\t\t\t\t\t\tunhealthy, Route 53 routes queries to other resources.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    \n Application and Network Load\n\t\t\t\t\t\t\t\t\tBalancers: If you specify an ELB Application or\n\t\t\t\t\t\t\t\tNetwork Load Balancer and you set EvaluateTargetHealth\n\t\t\t\t\t\t\t\tto true, Route 53 routes queries to the load balancer\n\t\t\t\t\t\t\t\tbased on the health of the target groups that are associated with\n\t\t\t\t\t\t\t\tthe load balancer:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      For an Application or Network Load Balancer to be\n\t\t\t\t\t\t\t\t\t\tconsidered healthy, every target group that contains targets\n\t\t\t\t\t\t\t\t\t\tmust contain at least one healthy target. If any target\n\t\t\t\t\t\t\t\t\t\tgroup contains only unhealthy targets, the load balancer is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy, and Route 53 routes queries to other\n\t\t\t\t\t\t\t\t\t\tresources.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      A target group that has no registered targets is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t \n\t\t\t\t\t\t

When you create a load balancer, you configure settings for Elastic\n\t\t\t\t\t\t\tLoad Balancing health checks; they're not Route 53 health checks, but\n\t\t\t\t\t\t\tthey perform a similar function. Do not create Route 53 health checks\n\t\t\t\t\t\t\tfor the EC2 instances that you register with an ELB load balancer.\n\t\t\t\t\t\t

\n\t\t\t\t\t \n\t\t\t\t
\n
S3 buckets
\n
\n\t\t\t\t\t

There are no special requirements for setting\n\t\t\t\t\t\t\tEvaluateTargetHealth to true when the alias\n\t\t\t\t\t\ttarget is an S3 bucket.

\n\t\t\t\t
\n
Other records in the same hosted zone
\n
\n\t\t\t\t\t

If the Amazon Web Services resource that you specify in\n\t\t\t\t\t\t\tDNSName is a record or a group of records (for example, a\n\t\t\t\t\t\tgroup of weighted records) but is not another alias record, we recommend\n\t\t\t\t\t\tthat you associate a health check with all of the records in the alias\n\t\t\t\t\t\ttarget. For more information, see What Happens When You Omit Health Checks? in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t\t\t
\n
\n\t\t

For more information and examples, see Amazon Route 53 Health Checks\n\t\t\t\tand DNS Failover in the Amazon Route 53 Developer\n\t\t\tGuide.

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

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or \n\t\t\tan Amazon S3 bucket, that you want to route traffic to.

\n\t\t

When creating resource record sets for a private hosted zone, note the following:

\n\t\t
    \n
  • \n

    Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone \n\t\t\t\t\tis unsupported.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For information about creating failover resource record sets in a private hosted zone, see \n\t\t\t\t\tConfiguring Failover in a Private Hosted Zone.

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

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n\t\t

When creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:

\n\t\t
    \n
  • \n\t\t\t\t

    Creating geolocation alias resource record sets or latency alias resource\n\t\t\t\t\trecord sets in a private hosted zone is unsupported.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see Configuring Failover in a Private Hosted Zone.

    \n\t\t\t
    • \n
" } }, "com.amazonaws.route53#AssociateVPCComment": { @@ -467,7 +495,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an Amazon VPC with a private hosted zone.

\n\t\t \n

To perform the association, the VPC and the private hosted zone must already exist. \n\t\t\tYou can't convert a public hosted zone into a private hosted zone.

\n \n\t\t \n

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created \n\t\t\tby using a different account, the Amazon Web Services account that created the private hosted zone must first submit a \n\t\t\tCreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an \n\t\t\tAssociateVPCWithHostedZone request.

\n \n\t\t \n

When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A\n\t\t\tpartition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\tpartition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t
    \n
  • \n

    \n aws - Amazon Web Services Regions

    \n
    • \n
  • \n

    \n aws-cn - China Regions

    \n
    • \n
  • \n

    \n aws-us-gov - Amazon Web Services GovCloud (US) Region

    \n
    • \n
\n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

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

Associates an Amazon VPC with a private hosted zone.

\n\t\t \n\t\t\t

To perform the association, the VPC and the private hosted zone must already\n\t\t\t\texist. You can't convert a public hosted zone into a private hosted zone.

\n\t\t \n\t\t \n\t\t\t

If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a\n\t\t\t\tdifferent account, the Amazon Web Services account that created the private hosted\n\t\t\t\tzone must first submit a CreateVPCAssociationAuthorization request.\n\t\t\t\tThen the account that created the VPC must submit an\n\t\t\t\t\tAssociateVPCWithHostedZone request.

\n\t\t \n\t\t \n\t\t\t

When granting access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    \n aws - Amazon Web Services Regions

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n aws-cn - China Regions

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n aws-us-gov - Amazon Web Services GovCloud (US) Region

    \n\t\t\t\t
    • \n
\n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/associatevpc", @@ -481,7 +509,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the private hosted zone that you want to associate an Amazon VPC with.

\n\t\t

Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

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

The ID of the private hosted zone that you want to associate an Amazon VPC\n\t\t\twith.

\n\t\t

Note that you can't associate a VPC with a hosted zone that doesn't have an existing\n\t\t\tVPC association.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -489,7 +517,7 @@ "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPC that you want to associate with a private hosted zone.

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

A complex type that contains information about the VPC that you want to associate with\n\t\t\ta private hosted zone.

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

A complex type that contains information about the request to associate a VPC with a private hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about the request to associate a VPC with a\n\t\t\tprivate hosted zone.

" } }, "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse": { @@ -516,7 +544,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the AssociateVPCWithHostedZone request.

" + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tAssociateVPCWithHostedZone request.

" } }, "com.amazonaws.route53#Change": { @@ -525,7 +553,7 @@ "Action": { "target": "com.amazonaws.route53#ChangeAction", "traits": { - "smithy.api#documentation": "

The action to perform:

\n\t\t
    \n
  • \n\t\t\t\t

    \n CREATE: Creates a resource record set that has the specified values.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DELETE: Deletes a existing resource record set.

    \n\t\t\t\t \n\t\t\t\t\t

    To delete the resource record set that is associated with a traffic policy instance, use \n\t\t\t\t\t\tDeleteTrafficPolicyInstance. \n\t\t\t\t\t\tAmazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using \n\t\t\t\t\t\tChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue \n\t\t\t\t\t\tto be charged for it even though it's no longer in use.

    \n\t\t\t\t     \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UPSERT: If a resource record set doesn't already exist, Route 53 creates it. \n\t\t\t\t\tIf a resource record set does exist, Route 53 updates it with the values in the request.

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

The action to perform:

\n\t\t
    \n
  • \n\t\t\t\t

    \n CREATE: Creates a resource record set that has the specified\n\t\t\t\t\tvalues.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DELETE: Deletes a existing resource record set.

    \n\t\t\t\t \n\t\t\t\t\t

    To delete the resource record set that is associated with a traffic policy\n\t\t\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the\n\t\t\t\t\t\tresource record set automatically. If you delete the resource record set by\n\t\t\t\t\t\tusing ChangeResourceRecordSets, Route 53 doesn't automatically\n\t\t\t\t\t\tdelete the traffic policy instance, and you'll continue to be charged for it\n\t\t\t\t\t\teven though it's no longer in use.

    \n\t\t\t\t     \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UPSERT: If a resource record set doesn't already exist, Route 53\n\t\t\t\t\tcreates it. If a resource record set does exist, Route 53 updates it with the\n\t\t\t\t\tvalues in the request.

    \n\t\t\t
    • \n
", "smithy.api#required": {} } }, @@ -581,13 +609,97 @@ "smithy.api#documentation": "

The information for a change request.

" } }, + "com.amazonaws.route53#ChangeCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ChangeCidrCollectionRequest" + }, + "output": { + "target": "com.amazonaws.route53#ChangeCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrBlockInUseException" + }, + { + "target": "com.amazonaws.route53#CidrCollectionVersionMismatchException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.

\n\t\t

A change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime.

\n\t\t

\n Limits\n

\n\t\t

The max number of CIDR blocks included in the request is\n\t\t\t1000.\n\t\t\tAs a result, big updates require multiple API calls.

\n\t\t

\n PUT and DELETE_IF_EXISTS\n

\n\t\t

Use ChangeCidrCollection to perform the following actions:

\n\t\t
    \n
  • \n\t\t\t\t

    \n PUT: Create a CIDR block within the specified collection.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DELETE_IF_EXISTS: Delete an existing CIDR block from the\n\t\t\t\t\tcollection.

    \n\t\t\t
    • \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/cidrcollection/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ChangeCidrCollectionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the CIDR collection to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CollectionVersion": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\tcollection and increments it by 1 each time you update the collection.

\n\t\t

We recommend that you use ListCidrCollection to get the current value of\n\t\t\t\tCollectionVersion for the collection that you want to update, and then\n\t\t\tinclude that value with the change request. This prevents Route 53 from\n\t\t\toverwriting an intervening update:

\n\t\t
    \n
  • \n\t\t\t\t

    If the value in the request matches the value of\n\t\t\t\t\t\tCollectionVersion in the collection, Route 53 updates\n\t\t\t\t\tthe collection.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If the value of CollectionVersion in the collection is greater\n\t\t\t\t\tthan the value in the request, the collection was changed after you got the\n\t\t\t\t\tversion number. Route 53 does not update the collection, and it\n\t\t\t\t\treturns a CidrCollectionVersionMismatch error.

    \n\t\t\t
    • \n
" + } + }, + "Changes": { + "target": "com.amazonaws.route53#CidrCollectionChanges", + "traits": { + "smithy.api#documentation": "

Information about changes to a CIDR collection.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#ChangeCidrCollectionResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ChangeId", + "traits": { + "smithy.api#documentation": "

The ID that is returned by ChangeCidrCollection. You can use it as input to\n\t\t\t\tGetChange to see if a CIDR collection change has propagated or\n\t\t\tnot.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#ChangeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6500 + } + } + }, "com.amazonaws.route53#ChangeInfo": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

This element contains an ID that you use when performing a \n\t\t\tGetChange \n\t\t\taction to get detailed information about the change.

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

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

", "smithy.api#required": {} } }, @@ -601,7 +713,7 @@ "SubmittedAt": { "target": "com.amazonaws.route53#TimeStamp", "traits": { - "smithy.api#documentation": "

The date and time that the change request was submitted in \n\t\t\tISO 8601 format and Coordinated Universal Time (UTC). \n\t\t\tFor example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

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

The date and time that the change request was submitted in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

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

Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified \n\t\t\tdomain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that \n\t\t\troutes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.

\n\t\t\n\t\t

\n Deleting Resource Record Sets\n

\n\t\t

To delete a resource record set, you must specify all the same values that you specified when you created it.

\n\n\t\t

\n Change Batches and Transactional Changes\n

\n\t\t

The request body must include a document with a ChangeResourceRecordSetsRequest element. \n\t\t\tThe request body contains a list of change items, known as a change batch. Change batches are considered transactional changes.\n\t\t\tRoute 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. \n\t\t\tThis ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone.

\n\t\t

For example, suppose a change batch request contains two changes: it deletes the CNAME resource record set for www.example.com and \n\t\t\tcreates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and \n\t\t\tcreates the second resource record set in a single operation. If validation for either the DELETE or the CREATE action fails, \n\t\t\tthen the request is canceled, and the original CNAME record continues to exist.

\n\t\t \n\t\t\t

If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an InvalidChangeBatch error.

\n\t\t \n\t\t\n\t\t

\n Traffic Flow\n

\n\t\t

To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the \n\t\t\tRoute 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, \n\t\t\tthen associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), \n\t\t\tin the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing \n\t\t\tas expected. For more information, see Using Traffic Flow to Route DNS Traffic \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t\n\t\t

\n Create, Delete, and Upsert\n

\n\t\t

Use ChangeResourceRecordsSetsRequest to perform the following actions:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    \n CREATE: Creates a resource record set that has the specified values.

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n DELETE: Deletes an existing resource record set that has the specified values.

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n UPSERT: If a resource set exists Route 53 updates it with the values in the\n\t\t\t\t\trequest.

    \n\t\t\t\t
    • \n
\n\t\t\n\t\t

\n Syntaxes for Creating, Updating, and Deleting Resource Record Sets\n

\n\t\t

The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as \n\t\t\tweighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.

\n\n\t\t\n\t\t

For an example for each type of resource record set, see \"Examples.\"

\n\t\t\n\t\t\n\t\t

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of \n\t\t\tresource record set that you can create, delete, or update by using ChangeResourceRecordSets.

\n\t\t\n\t\t

\n Change Propagation to Route 53 DNS Servers\n

\n\t\t

When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the \n\t\t\tRoute 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of \n\t\t\tPENDING. When propagation is complete, GetChange returns a status of INSYNC. \n\t\t\tChanges generally propagate to all Route 53 name servers within 60 seconds. For more information, see \n\t\t\tGetChange.

\n\n\t\t

\n Limits on ChangeResourceRecordSets Requests\n

\n\t\t

For information about the limits on a ChangeResourceRecordSets request, see \n\t\t\tLimits in the \n\t\t\tAmazon Route 53 Developer Guide.

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

Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.

\n\t\t

\n Deleting Resource Record Sets\n

\n\t\t

To delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.

\n\t\t

\n Change Batches and Transactional Changes\n

\n\t\t

The request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.

\n\t\t

For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.

\n\t\t \n\t\t\t

If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.

\n\t\t \n\t\t

\n Traffic Flow\n

\n\t\t

To create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.

\n\t\t

\n Create, Delete, and Upsert\n

\n\t\t

Use ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:

\n\t\t
    \n
  • \n\t\t\t\t

    \n CREATE: Creates a resource record set that has the specified\n\t\t\t\t\tvalues.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n DELETE: Deletes an existing resource record set that has the\n\t\t\t\t\tspecified values.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n UPSERT: If a resource set exists Route 53 updates it with the\n\t\t\t\t\tvalues in the request.

    \n\t\t\t
    • \n
\n\t\t

\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n

\n\t\t

The syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.

\n\t\t\n\t\t

For an example for each type of resource record set, see \"Examples.\"

\n\t\t\n\t\t

Don't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.

\n\t\t

\n Change Propagation to Route 53 DNS Servers\n

\n\t\t

When you submit a ChangeResourceRecordSets request, Route 53 propagates\n\t\t\tyour changes to all of the Route 53 authoritative DNS servers. While your changes are\n\t\t\tpropagating, GetChange returns a status of PENDING. When\n\t\t\tpropagation is complete, GetChange returns a status of INSYNC.\n\t\t\tChanges generally propagate to all Route 53 name servers within 60 seconds. For more\n\t\t\tinformation, see GetChange.

\n\t\t

\n Limits on ChangeResourceRecordSets Requests\n

\n\t\t

For information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", @@ -656,7 +768,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to change.

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

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tchange.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -664,7 +776,7 @@ "ChangeBatch": { "target": "com.amazonaws.route53#ChangeBatch", "traits": { - "smithy.api#documentation": "

A complex type that contains an optional comment and the Changes element.

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

A complex type that contains an optional comment and the Changes\n\t\t\telement.

", "smithy.api#required": {} } } @@ -679,7 +791,7 @@ "ChangeInfo": { "target": "com.amazonaws.route53#ChangeInfo", "traits": { - "smithy.api#documentation": "

A complex type that contains information about changes made to your hosted zone.

\n\t\t

This element contains an ID that you use when performing a \n\t\t\tGetChange \n\t\t\taction to get detailed information about the change.

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

A complex type that contains information about changes made to your hosted\n\t\t\tzone.

\n\t\t

This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.

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

Adds, edits, or deletes tags for a health check or a hosted zone.

\n\t\t

For information about using tags for cost allocation, see \n\t\t\tUsing Cost Allocation Tags \n\t\t\tin the Billing and Cost Management User Guide.

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

Adds, edits, or deletes tags for a health check or a hosted zone.

\n\t\t

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", @@ -743,7 +855,7 @@ "ResourceType": { "target": "com.amazonaws.route53#TagResourceType", "traits": { - "smithy.api#documentation": "

The type of the resource.

\n\t\t
    \n
  • \n

    The resource type for health checks is healthcheck.

    \n
    • \n
  • \n

    The resource type for hosted zones is hostedzone.

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

The type of the resource.

\n\t\t
    \n
  • \n\t\t\t\t

    The resource type for health checks is healthcheck.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The resource type for hosted zones is hostedzone.

    \n\t\t\t
    • \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -759,18 +871,18 @@ "AddTags": { "target": "com.amazonaws.route53#TagList", "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags \n\t\t\tthat you want to edit Value for.

\n\t\t

You can add a maximum of 10 tags to a health check or a hosted zone.

" + "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to add to the specified\n\t\t\thealth check or hosted zone and/or the tags that you want to edit Value\n\t\t\tfor.

\n\t\t

You can add a maximum of 10 tags to a health check or a hosted zone.

" } }, "RemoveTagKeys": { "target": "com.amazonaws.route53#TagKeyList", "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. \n\t\t\tYou can specify up to 10 keys.

" + "smithy.api#documentation": "

A complex type that contains a list of the tags that you want to delete from the\n\t\t\tspecified health check or hosted zone. You can specify up to 10 keys.

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

A complex type that contains information about the tags that you want to add, edit, or delete.

" + "smithy.api#documentation": "

A complex type that contains information about the tags that you want to add, edit, or\n\t\t\tdelete.

" } }, "com.amazonaws.route53#ChangeTagsForResourceResponse": { @@ -815,34 +927,276 @@ } } }, + "com.amazonaws.route53#Cidr": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.route53#CidrBlockInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This CIDR block is already in use.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#CidrBlockSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CidrBlockSummary" + } + }, + "com.amazonaws.route53#CidrBlockSummary": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.route53#Cidr", + "traits": { + "smithy.api#documentation": "

Value for the CIDR block.

" + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

The location name of the CIDR block.

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

A complex type that lists the CIDR blocks.

" + } + }, + "com.amazonaws.route53#CidrCollection": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the collection. Can be used to reference the collection in IAM policy or in\n\t\t\tanother Amazon Web Services account.

" + } + }, + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The unique ID of the CIDR collection.

" + } + }, + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

The name of a CIDR collection.

" + } + }, + "Version": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

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

A complex\n\t\t\ttype that\n\t\t\tidentifies a CIDR collection.

" + } + }, + "com.amazonaws.route53#CidrCollectionAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A CIDR collection with this name and a different caller reference already exists in this account.

", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#CidrCollectionChange": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

Name of the location that is associated with the CIDR\n\t\t\tcollection.

", + "smithy.api#required": {} + } + }, + "Action": { + "target": "com.amazonaws.route53#CidrCollectionChangeAction", + "traits": { + "smithy.api#documentation": "

CIDR collection change action.

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

List of CIDR blocks.

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

A complex type that contains information about the CIDR collection change.

" + } + }, + "com.amazonaws.route53#CidrCollectionChangeAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PUT", + "name": "PUT" + }, + { + "value": "DELETE_IF_EXISTS", + "name": "DELETE_IF_EXISTS" + } + ] + } + }, + "com.amazonaws.route53#CidrCollectionChanges": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CidrCollectionChange" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.route53#CidrCollectionInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This CIDR collection is in use, and isn't empty.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#CidrCollectionVersionMismatchException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection version you provided, doesn't match the one in the\n\t\t\t\tListCidrCollections operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#CidrList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Cidr", + "traits": { + "smithy.api#xmlName": "Cidr" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.route53#CidrLocationNameDefaultAllowed": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-\\*]+$" + } + }, + "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" + } + }, + "com.amazonaws.route53#CidrNonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^\\p{ASCII}+$" + } + }, + "com.amazonaws.route53#CidrRoutingConfig": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The CIDR collection ID.

", + "smithy.api#required": {} + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", + "traits": { + "smithy.api#documentation": "

The CIDR collection location name.

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

The object that is specified in resource record set object when you are linking a\n\t\t\tresource record set to a CIDR location.

\n\t\t

A LocationName with an asterisk “*” can be used to create a default CIDR\n\t\t\trecord. CollectionId is still required for default record.

" + } + }, "com.amazonaws.route53#CloudWatchAlarmConfiguration": { "type": "structure", "members": { "EvaluationPeriods": { "target": "com.amazonaws.route53#EvaluationPeriods", "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

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

For the metric that the CloudWatch alarm is associated with, the number of periods\n\t\t\tthat the metric is compared to the threshold.

", "smithy.api#required": {} } }, "Threshold": { "target": "com.amazonaws.route53#Threshold", "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

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

For the metric that the CloudWatch alarm is associated with, the value the metric is\n\t\t\tcompared with.

", "smithy.api#required": {} } }, "ComparisonOperator": { "target": "com.amazonaws.route53#ComparisonOperator", "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

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

For the metric that the CloudWatch alarm is associated with, the arithmetic operation\n\t\t\tthat is used for the comparison.

", "smithy.api#required": {} } }, "Period": { "target": "com.amazonaws.route53#Period", "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

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

For the metric that the CloudWatch alarm is associated with, the duration of one\n\t\t\tevaluation period in seconds.

", "smithy.api#required": {} } }, @@ -856,26 +1210,26 @@ "Namespace": { "target": "com.amazonaws.route53#Namespace", "traits": { - "smithy.api#documentation": "

The namespace of the metric that the alarm is associated with. For more information, see \n\t\t\tAmazon CloudWatch Namespaces, Dimensions, and Metrics Reference \n\t\t\tin the Amazon CloudWatch User Guide.

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

The namespace of the metric that the alarm is associated with. For more information,\n\t\t\tsee Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

", "smithy.api#required": {} } }, "Statistic": { "target": "com.amazonaws.route53#Statistic", "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

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

For the metric that the CloudWatch alarm is associated with, the statistic that is\n\t\t\tapplied to the metric.

", "smithy.api#required": {} } }, "Dimensions": { "target": "com.amazonaws.route53#DimensionList", "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. \n\t\t\tFor information, see \n\t\t\tAmazon CloudWatch Namespaces, Dimensions, and Metrics Reference \n\t\t\tin the Amazon CloudWatch User Guide.

" + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about the dimensions for the metric. For information, see Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.

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

A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

" + "smithy.api#documentation": "

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

" } }, "com.amazonaws.route53#CloudWatchLogsLogGroupArn": { @@ -1008,6 +1362,63 @@ } } }, + "com.amazonaws.route53#CollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" + } + }, + "com.amazonaws.route53#CollectionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CollectionSummary" + } + }, + "com.amazonaws.route53#CollectionSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53#ARN", + "traits": { + "smithy.api#documentation": "

The ARN of the collection summary. Can be used to reference the collection in IAM\n\t\t\tpolicy or cross-account.

" + } + }, + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

Unique ID for the CIDR collection.

" + } + }, + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

The name of a CIDR collection.

" + } + }, + "Version": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "

A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.

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

A complex type that is an entry in an CidrCollection\n\t\t\tarray.

" + } + }, + "com.amazonaws.route53#CollectionVersion": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.route53#ComparisonOperator": { "type": "string", "traits": { @@ -1042,7 +1453,7 @@ } }, "traits": { - "smithy.api#documentation": "

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

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

Another user submitted a request to create, update, or delete the object at the same\n\t\t\ttime that you did. Retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1055,7 +1466,7 @@ } }, "traits": { - "smithy.api#documentation": "

The cause of this error depends on the operation that you're performing:

\n\t\t
    \n
  • \n

    \n Create a public hosted zone: Two hosted zones that have the same name or that have a \n\t\t\t\tparent/child relationship (example.com and test.example.com) can't have any common name servers. You tried to create a hosted zone \n\t\t\t\tthat has the same name as an existing hosted zone or that's the parent or child of an existing hosted zone, and you specified a \n\t\t\t\tdelegation set that shares one or more name servers with the existing hosted zone. For more information, see \n\t\t\t\tCreateReusableDelegationSet.

    \n\t\t\t
    • \n
  • \n

    \n Create a private hosted zone: A hosted zone with the specified name \n\t\t\t\talready exists and is already associated with the Amazon VPC that you specified.

    \n
    • \n
  • \n

    \n Associate VPCs with a private hosted zone: The VPC that you specified is \n\t\t\t\talready associated with another hosted zone that has the same name.

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

The cause of this error depends on the operation that you're performing:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Create a public hosted zone: Two hosted zones\n\t\t\t\t\tthat have the same name or that have a parent/child relationship (example.com\n\t\t\t\t\tand test.example.com) can't have any common name servers. You tried to create a\n\t\t\t\t\thosted zone that has the same name as an existing hosted zone or that's the\n\t\t\t\t\tparent or child of an existing hosted zone, and you specified a delegation set\n\t\t\t\t\tthat shares one or more name servers with the existing hosted zone. For more\n\t\t\t\t\tinformation, see CreateReusableDelegationSet.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Create a private hosted zone: A hosted zone\n\t\t\t\t\twith the specified name already exists and is already associated with the Amazon\n\t\t\t\t\tVPC that you specified.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Associate VPCs with a private hosted zone:\n\t\t\t\t\tThe VPC that you specified is already associated with another hosted zone that\n\t\t\t\t\thas the same name.

    \n\t\t\t
    • \n
", "smithy.api#error": "client" } }, @@ -1065,14 +1476,82 @@ "message": { "target": "com.amazonaws.route53#ErrorMessage", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

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

You tried to update a traffic policy instance by using a traffic policy version that\n\t\t\thas a different DNS type than the current type for the instance. You specified the type\n\t\t\tin the JSON document in the CreateTrafficPolicy or\n\t\t\t\tCreateTrafficPolicyVersionrequest.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#CreateCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateCidrCollectionRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrCollectionAlreadyExistsException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a CIDR collection in the\n\t\t\tcurrent\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/cidrcollection", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateCidrCollectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "

A unique identifier for the account that can be used to reference the collection from\n\t\t\tother API calls.

", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#CidrNonce", + "traits": { + "smithy.api#documentation": "

A client-specific token that allows requests to be securely retried so that the\n\t\t\tintended outcome will only occur once, retries receive a similar response, and there are\n\t\t\tno additional edge cases to handle.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#CreateCidrCollectionResponse": { + "type": "structure", + "members": { + "Collection": { + "target": "com.amazonaws.route53#CidrCollection", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR collection.

" + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "

A unique URL that represents the location for the CIDR collection.

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

You tried to update a traffic policy instance by using a traffic policy version that has a different DNS type \n\t\t\tthan the current type for the instance. You specified the type in the JSON document in the CreateTrafficPolicy or \n\t\t\tCreateTrafficPolicyVersionrequest.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 } }, "com.amazonaws.route53#CreateHealthCheck": { @@ -1095,7 +1574,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new health check.

\n\t\t

For information about adding health checks to resource record sets, see \n\t\t\tHealthCheckId \n\t\t\tin \n\t\t\tChangeResourceRecordSets.

\n\t\t\n\t\t

\n ELB Load Balancers\n

\n\t\t

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the \n\t\t\tEC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a \n\t\t\tsimilar function to a Route 53 health check.

\n\t\t\n\t\t

\n Private Hosted Zones\n

\n\t\t

You can associate health checks with failover resource record sets in a private hosted zone. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must \n\t\t\t\t\tassign a public IP address to the instance in the VPC.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can configure a health checker to check the health of an external resource that the instance relies on, such as a \n\t\t\t\t\tdatabase server.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the \n\t\t\t\t\tstate of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, \n\t\t\t\t\tadd an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating \n\t\t\t\t\tCloudWatch metrics and alarms by using the CloudWatch console, see the \n\t\t\t\t\tAmazon CloudWatch User Guide.

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

Creates a new health check.

\n\t\t

For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

\n\t\t

\n ELB Load Balancers\n

\n\t\t

If you're registering EC2 instances with an Elastic Load Balancing (ELB) load\n\t\t\tbalancer, do not create Amazon Route 53 health checks for the EC2 instances. When you\n\t\t\tregister an EC2 instance with a load balancer, you configure settings for an ELB health\n\t\t\tcheck, which performs a similar function to a Route 53 health check.

\n\t\t

\n Private Hosted Zones\n

\n\t\t

You can associate health checks with failover resource record sets in a private hosted\n\t\t\tzone. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    Route 53 health checkers are outside the VPC. To check the health of an\n\t\t\t\t\tendpoint within a VPC by IP address, you must assign a public IP address to the\n\t\t\t\t\tinstance in the VPC.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can configure a health checker to check the health of an external resource\n\t\t\t\t\tthat the instance relies on, such as a database server.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can create a CloudWatch metric, associate an alarm with the metric, and\n\t\t\t\t\tthen create a health check that is based on the state of the alarm. For example,\n\t\t\t\t\tyou might create a CloudWatch metric that checks the status of the Amazon EC2\n\t\t\t\t\t\tStatusCheckFailed metric, add an alarm to the metric, and then\n\t\t\t\t\tcreate a health check that is based on the state of the alarm. For information\n\t\t\t\t\tabout creating CloudWatch metrics and alarms by using the CloudWatch console,\n\t\t\t\t\tsee the Amazon\n\t\t\t\t\t\tCloudWatch User Guide.

    \n\t\t\t
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/healthcheck", @@ -1109,7 +1588,7 @@ "CallerReference": { "target": "com.amazonaws.route53#HealthCheckNonce", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request \n\t\t\twithout the risk of creating two identical health checks:

\n\t\t
    \n
  • \n

    If you send a CreateHealthCheck request with the same CallerReference and settings \n\t\t\t\tas a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, \n\t\t\t\tRoute 53 returns the settings for the existing health check.

    \n
    • \n
  • \n

    If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, \n\t\t\t\tregardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.

    \n
    • \n
  • \n

    If you send a CreateHealthCheck request with the same CallerReference as an existing health check \n\t\t\t\tbut with different settings, Route 53 returns a HealthCheckAlreadyExists error.

    \n
    • \n
  • \n

    If you send a CreateHealthCheck request with a unique CallerReference but settings identical to \n\t\t\t\tan existing health check, Route 53 creates the health check.

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

A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:

\n\t\t
    \n
  • \n\t\t\t\t

    If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference and settings as a previous request, and if the\n\t\t\t\t\thealth check doesn't exist, Amazon Route 53 creates the health check. If the\n\t\t\t\t\thealth check does exist, Route 53 returns the settings for the existing health\n\t\t\t\t\tcheck.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as a deleted health check, regardless of the\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as an existing health check but with different\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you send a CreateHealthCheck request with a unique\n\t\t\t\t\t\tCallerReference but settings identical to an existing health\n\t\t\t\t\tcheck, Route 53 creates the health check.

    \n\t\t\t
    • \n
", "smithy.api#required": {} } }, @@ -1186,7 +1665,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic \n\t\t\ton the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a \n\t\t\tprivate hosted zone to define how you want to route traffic for a domain and its subdomains within one or more \n\t\t\tAmazon Virtual Private Clouds (Amazon VPCs).

\n\t\t \n\t\t\t

You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone \n\t\t\t\twith the same name and create new resource record sets.

\n\t\t \n\t\t

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

\n\t\t

Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    You can't create a hosted zone for a top-level domain (TLD) such as .com.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. \n\t\t\t\t\tFor more information about SOA and NS records, see \n\t\t\t\t\tNS and SOA Records that Route 53 Creates for a Hosted Zone in the \n\t\t\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t\t\t

    If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set \n\t\t\t\t\twith the hosted zone. See the DelegationSetId element.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make \n\t\t\t\t\tRoute 53 the DNS service for the domain. For more information, see \n\t\t\t\t\tMigrating DNS Service for an Existing Domain to Amazon Route 53 in the \n\t\t\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t\t
    • \n
\n\t\t

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. \n\t\t\tFor public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the \n\t\t\tNS and SOA records are available, the status of the zone changes to INSYNC.

\n\t\t

The CreateHostedZone request requires the caller to have an ec2:DescribeVpcs permission.

\n\t\t \n

When creating private hosted zones, the Amazon VPC must belong to the same partition\n\t\t\t\twhere the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t
    \n
  • \n

    \n aws - Amazon Web Services Regions

    \n
    • \n
  • \n

    \n aws-cn - China Regions

    \n
    • \n
  • \n

    \n aws-us-gov - Amazon Web Services GovCloud (US) Region

    \n
    • \n
\n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

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

Creates a new public or private hosted zone. You create records in a public hosted\n\t\t\tzone to define how you want to route traffic on the internet for a domain, such as\n\t\t\texample.com, and its subdomains (apex.example.com, acme.example.com). You create records\n\t\t\tin a private hosted zone to define how you want to route traffic for a domain and its\n\t\t\tsubdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

\n\t\t \n\t\t\t

You can't convert a public hosted zone to a private hosted zone or vice versa.\n\t\t\t\tInstead, you must create a new hosted zone with the same name and create new\n\t\t\t\tresource record sets.

\n\t\t \n\t\t

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

\n\t\t

Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    You can't create a hosted zone for a top-level domain (TLD) such as\n\t\t\t\t\t.com.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For public hosted zones, Route 53 automatically creates a default SOA record\n\t\t\t\t\tand four NS records for the zone. For more information about SOA and NS records,\n\t\t\t\t\tsee NS and SOA Records\n\t\t\t\t\t\tthat Route 53 Creates for a Hosted Zone in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t\t\t

    If you want to use the same name servers for multiple public hosted zones, you\n\t\t\t\t\tcan optionally associate a reusable delegation set with the hosted zone. See the\n\t\t\t\t\t\tDelegationSetId element.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If your domain is registered with a registrar other than Route 53,\n\t\t\t\t\tyou must update the name servers with your registrar to make Route 53 the DNS\n\t\t\t\t\tservice for the domain. For more information, see Migrating DNS Service\n\t\t\t\t\t\tfor an Existing Domain to Amazon Route 53 in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t\t
    • \n
\n\t\t

When you submit a CreateHostedZone request, the initial status of the\n\t\t\thosted zone is PENDING. For public hosted zones, this means that the NS and\n\t\t\tSOA records are not yet available on all Route 53 DNS servers. When the NS and\n\t\t\tSOA records are available, the status of the zone changes to INSYNC.

\n\t\t

The CreateHostedZone request requires the caller to have an\n\t\t\t\tec2:DescribeVpcs permission.

\n\t\t \n\t\t\t

When creating private hosted zones, the Amazon VPC must belong to the same\n\t\t\t\tpartition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\t\tpartition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    \n aws - Amazon Web Services Regions

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n aws-cn - China Regions

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n aws-us-gov - Amazon Web Services GovCloud (US) Region

    \n\t\t\t\t
    • \n
\n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone", @@ -1200,38 +1679,38 @@ "Name": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

The name of the domain. Specify a fully qualified domain name, for example, www.example.com. \n\t\t\tThe trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats \n\t\t\twww.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

\n\t\t

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name \n\t\t\tis registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that \n\t\t\tCreateHostedZone returns in DelegationSet.

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

The name of the domain. Specify a fully qualified domain name, for example,\n\t\t\t\twww.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that\n\t\t\t\tRoute 53 treats www.example.com (without a trailing\n\t\t\tdot) and www.example.com. (with a trailing dot) as\n\t\t\tidentical.

\n\t\t

If you're creating a public hosted zone, this is the name you have registered with\n\t\t\tyour DNS registrar. If your domain name is registered with a registrar other than\n\t\t\t\tRoute 53, change the name servers for your domain to the set of\n\t\t\t\tNameServers that CreateHostedZone returns in\n\t\t\t\tDelegationSet.

", "smithy.api#required": {} } }, "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { - "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

\n\t\t

You can specify only one Amazon VPC when you create a private hosted zone. If you are associating a VPC with a hosted zone with this request,\n\t\t\tthe paramaters \n\t\t\tVPCId and VPCRegion are also required.

\n\t\t

To associate additional Amazon VPCs with the hosted zone, \n\t\t\tuse AssociateVPCWithHostedZone\n\t\t\tafter you create a hosted zone.

" + "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about the Amazon\n\t\t\tVPC that you're associating with this hosted zone.

\n\t\t

You can specify only one Amazon VPC when you create a private hosted zone. If you are\n\t\t\tassociating a VPC with a hosted zone with this request, the paramaters\n\t\t\t\tVPCId and VPCRegion are also required.

\n\t\t

To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

" } }, "CallerReference": { "target": "com.amazonaws.route53#Nonce", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without \n\t\t\tthe risk of executing the operation twice. You must use a unique CallerReference string every time you submit a \n\t\t\tCreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

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

A unique string that identifies the request and that allows failed\n\t\t\t\tCreateHostedZone requests to be retried without the risk of executing\n\t\t\tthe operation twice. You must use a unique CallerReference string every\n\t\t\ttime you submit a CreateHostedZone request. CallerReference\n\t\t\tcan be any unique string, for example, a date/time stamp.

", "smithy.api#required": {} } }, "HostedZoneConfig": { "target": "com.amazonaws.route53#HostedZoneConfig", "traits": { - "smithy.api#documentation": "

(Optional) A complex type that contains the following optional values:

\n\t\t
    \n
  • \n

    For public and private hosted zones, an optional comment

    \n
    • \n
  • \n

    For private hosted zones, an optional PrivateZone element

    \n
    • \n
\n\t\t

If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and \n\t\t\tthe other elements.

" + "smithy.api#documentation": "

(Optional) A complex type that contains the following optional values:

\n\t\t
    \n
  • \n\t\t\t\t

    For public and private hosted zones, an optional comment

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For private hosted zones, an optional PrivateZone element

    \n\t\t\t
    • \n
\n\t\t

If you don't specify a comment or the PrivateZone element, omit\n\t\t\t\tHostedZoneConfig and the other elements.

" } }, "DelegationSetId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set \n\t\t\twhen you created it. For more information about reusable delegation sets, see \n\t\t\tCreateReusableDelegationSet.

" + "smithy.api#documentation": "

If you want to associate a reusable delegation set with this hosted zone, the ID that\n\t\t\t\tAmazon Route 53 assigned to the reusable delegation set when you created it.\n\t\t\tFor more information about reusable delegation sets, see CreateReusableDelegationSet.

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

A complex type that contains information about the request to create a public or private hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about the request to create a public or\n\t\t\tprivate hosted zone.

" } }, "com.amazonaws.route53#CreateHostedZoneResponse": { @@ -1247,7 +1726,7 @@ "ChangeInfo": { "target": "com.amazonaws.route53#ChangeInfo", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CreateHostedZone request.

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

A complex type that contains information about the CreateHostedZone\n\t\t\trequest.

", "smithy.api#required": {} } }, @@ -1261,7 +1740,7 @@ "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { - "smithy.api#documentation": "

A complex type that contains information about an Amazon VPC that you associated with this hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about an Amazon VPC that you associated with\n\t\t\tthis hosted zone.

" } }, "Location": { @@ -1318,7 +1797,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.

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

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have\n\t\t\ttwo KSKs per hosted zone.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/keysigningkey", @@ -1346,21 +1825,21 @@ "KeyManagementServiceArn": { "target": "com.amazonaws.route53#SigningKeyString", "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) for a customer managed key in Key Management Service (KMS).\n\t\t\tThe KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. \n\t\t\tTo see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, \n\t\t\tscroll down to Example.

\n\t\t

You must configure the customer managed customer managed key as follows:

\n\t\t
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n\t\t\t\t\t
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n\t\t\t\t\t

The key policy must also include the Amazon Route 53 service in the principal for your account. \n\t\t\t\t\t\tSpecify the following:

\n\t\t\t\t\t
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
    • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with a customer managed key in KMS, see \n\t\t\tKey Management Service concepts.

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

The Amazon resource name (ARN) for a customer managed key in Key Management Service\n\t\t\t\t(KMS). The KeyManagementServiceArn must be unique for\n\t\t\teach key-signing key (KSK) in a single hosted zone. To see an example of\n\t\t\t\tKeyManagementServiceArn that grants the correct permissions for DNSSEC,\n\t\t\tscroll down to Example.

\n\t\t

You must configure the customer managed customer managed key as follows:

\n\t\t
\n
Status
\n
\n\t\t\t\t\t

Enabled

\n\t\t\t\t
\n
Key spec
\n
\n\t\t\t\t\t

ECC_NIST_P256

\n\t\t\t\t
\n
Key usage
\n
\n\t\t\t\t\t

Sign and verify

\n\t\t\t\t
\n
Key policy
\n
\n\t\t\t\t\t

The key policy must give permission for the following actions:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    DescribeKey

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    GetPublicKey

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    Sign

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with a customer managed key in KMS, see Key Management Service concepts.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.route53#SigningKeyName", "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same \n\t\t\thosted zone.

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

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.route53#SigningKeyStatus", "traits": { - "smithy.api#documentation": "

A string specifying the initial status of the key-signing key (KSK). You can set the value to ACTIVE or INACTIVE.

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

A string specifying the initial status of the key-signing key (KSK). You can set the\n\t\t\tvalue to ACTIVE or INACTIVE.

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

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish \n\t\t\tlog data to an Amazon CloudWatch Logs log group.

\n\t\t

DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

\n\t\t
    \n
  • \n

    Route 53 edge location that responded to the DNS query

    \n
    • \n
  • \n

    Domain or subdomain that was requested

    \n
    • \n
  • \n

    DNS record type, such as A or AAAA

    \n
    • \n
  • \n

    DNS response code, such as NoError or ServFail\n

    \n
    • \n
\n\t\t\n\t\t
\n
Log Group and Resource Policy
\n
\n

Before you create a query logging configuration, perform the following operations.

\n\t\t\t\t\t \n

If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

\n \n\t\t\t\t\t
    \n
  1. \n

    Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a \n\t\t\t\t\t\t\tquery logging configuration. Note the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      You must create the log group in the us-east-1 region.

      \n
      • \n
    • \n

      You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to \n\t\t\t\t\t\t\t\t\tconfigure query logging for.

      \n
      • \n
    • \n

      When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

      \n\t\t\t\t\t\t\t\t\t

      \n /aws/route53/hosted zone name\n \n

      \n\t\t\t\t\t\t\t\t\t

      In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated \n\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so \n\t\t\t\t\t\t\t\t\t\twe recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create \n\t\t\t\t\t\t\t\t\t\tfor query logging.

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

    Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to \n\t\t\t\t\t\t\tsend query logs to log streams. For the value of Resource, specify the ARN for the log group that you created \n\t\t\t\t\t\t\tin the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, \n\t\t\t\t\t\t\treplace the hosted zone name with *, for example:

    \n\t\t\t\t\t\t\t

    \n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n

    \n\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t

    To avoid the confused deputy problem, a security issue where an entity without a\n\t\t\t\t\t\t\t\tpermission for an action can coerce a more-privileged entity to\n\t\t\t\t\t\t\t\tperform it, you can optionally limit the permissions that a service\n\t\t\t\t\t\t\t\thas to a resource in a resource-based policy by supplying the\n\t\t\t\t\t\t\t\tfollowing values:

    \n\t\t\t\t\t\t\t
      \n
    • \n

      For aws:SourceArn, supply the hosted zone ARN used in creating the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.

      \n
      • \n
    • \n

      For aws:SourceAccount, supply the account ID for the account that creates the\n\t\t\t\t\t\t\t\t\t\tquery logging configuration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.

      \n
      • \n
    \n\t\t\t\t\t\t\t

    For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.

    \n\t\t\t\t\t\t\t \n

    You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, \n\t\t\t\t\t\t\t\tor the CLI.

    \n     \n\t\t\t\t\t\t
    3. \n
\n\t\t\t\t
\n
Log Streams and Edge Locations
\n
\n

When Route 53 finishes creating the configuration for DNS query logging, it does the following:

\n\t\t\t\t\t
    \n
  • \n

    Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the \n\t\t\t\t\t\t\tspecified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.

    \n
    • \n
  • \n

    Begins to send query logs to the applicable log stream.

    \n
    • \n
\n\t\t\t\t\t

The name of each log stream is in the following format:

\n\t\t\t\t\t

\n \n hosted zone ID/edge location code\n \n

\n\t\t\t\t\t

The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code \n\t\t\t\t\t\ttypically corresponds with the International Air Transport Association airport code for an airport near the edge location. \n\t\t\t\t\t\t(These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the \n\t\t\t\t\t\tRoute 53 Product Details page.

\n\t\t\t\t
\n
Queries That Are Logged
\n
\n

Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached \n\t\t\t\t\tthe response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return \n\t\t\t\t\tthe cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. \n\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, \n\t\t\t\t\tquery logs might contain information about only one query out of every several thousand queries that are submitted to DNS. \n\t\t\t\t\tFor more information about how DNS works, see \n\t\t\t\t\tRouting Internet Traffic to Your Website or Web Application\n\t\t\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t\t\t
\n
Log File Format
\n
\n

For a list of the values in each query log and the format of each value, see \n\t\t\t\t\tLogging DNS Queries in the \n\t\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t\t\t
\n
Pricing
\n
\n

For information about charges for query logs, see \n\t\t\t\t\tAmazon CloudWatch Pricing.

\n
\n
How to Stop Logging
\n
\n

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see \n\t\t\t\t\tDeleteQueryLoggingConfig.

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

Creates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.

\n\t\t

DNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:

\n\t\t
    \n
  • \n\t\t\t\t

    Route 53 edge location that responded to the DNS query

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Domain or subdomain that was requested

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    DNS record type, such as A or AAAA

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    DNS response code, such as NoError or\n\t\t\t\t\tServFail\n

    \n\t\t\t
    • \n
\n\t\t
\n
Log Group and Resource Policy
\n
\n\t\t\t\t\t

Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.

\n\t\t\t\t\t \n\t\t\t\t\t\t

If you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.

\n\t\t\t\t\t \n\t\t\t\t\t
    \n
  1. \n\t\t\t\t\t\t\t

    Create a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      You must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      You must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      When you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:

      \n\t\t\t\t\t\t\t\t\t

      \n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n

      \n\t\t\t\t\t\t\t\t\t

      In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.

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

    Create a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:

    \n\t\t\t\t\t\t\t

    \n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n

    \n\t\t\t\t\t\t\t

    To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:

    \n\t\t\t\t\t\t\t
      \n
    • \n\t\t\t\t\t\t\t\t\t

      For aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.

      \n\t\t\t\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t\t\t\t

      For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.

      \n\t\t\t\t\t\t\t\t
      • \n
    \n\t\t\t\t\t\t\t

    For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.

    \n\t\t\t\t\t\t\t \n\t\t\t\t\t\t\t\t

    You can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.

    \n\t\t\t\t\t\t\t     \n\t\t\t\t\t\t
    3. \n
\n\t\t\t\t
\n
Log Streams and Edge Locations
\n
\n\t\t\t\t\t

When Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    Creates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    Begins to send query logs to the applicable log stream.

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t

The name of each log stream is in the following format:

\n\t\t\t\t\t

\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n

\n\t\t\t\t\t

The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.

\n\t\t\t\t
\n
Queries That Are Logged
\n
\n\t\t\t\t\t

Query logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t\t\t
\n
Log File Format
\n
\n\t\t\t\t\t

For a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.

\n\t\t\t\t
\n
Pricing
\n
\n\t\t\t\t\t

For information about charges for query logs, see Amazon CloudWatch Pricing.

\n\t\t\t\t
\n
How to Stop Logging
\n
\n\t\t\t\t\t

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.

\n\t\t\t\t
\n
", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/queryloggingconfig", @@ -1435,14 +1914,14 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.

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

The ID of the hosted zone that you want to log queries for. You can log queries only\n\t\t\tfor public hosted zones.

", "smithy.api#required": {} } }, "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format \n\t\t\tof the ARN:

\n\t\t\n\t\t

arn:aws:logs:region:account-id:log-group:log_group_name\n

\n\t\t\n\t\t

To get the ARN for a log group, you can use the CloudWatch console, the \n\t\t\tDescribeLogGroups API action, \n\t\t\tthe describe-log-groups command, \n\t\t\tor the applicable command in one of the Amazon Web Services SDKs.

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

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to\n\t\t\tsend query logs to. This is the format of the ARN:

\n\t\t

arn:aws:logs:region:account-id:log-group:log_group_name\n

\n\t\t

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups\n\t\t\tcommand, or the applicable command in one of the Amazon Web Services SDKs.

", "smithy.api#required": {} } } @@ -1454,7 +1933,7 @@ "QueryLoggingConfig": { "target": "com.amazonaws.route53#QueryLoggingConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to \n\t\t\tlog queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.

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

A complex type that contains the ID for a query logging configuration, the ID of the\n\t\t\thosted zone that you want to log queries for, and the ARN for the log group that you\n\t\t\twant Amazon Route 53 to send query logs to.

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

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by \n\t\t\tthe same Amazon Web Services account.

\n\t\t

You can also create a reusable delegation set that uses the four name servers that are associated \n\t\t\twith an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.

\n\t\t \n\t\t\t

You can't associate a reusable delegation set with a private hosted zone.

\n\t\t \n\t\t

For information about using a reusable delegation set to configure white label name servers, see \n\t\t\tConfiguring White Label Name Servers.

\n\t\t\n\t\t

The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for \n\t\t\tconfiguring white label name servers. You need to perform the following steps:

\n\t\t
    \n
  1. \n

    Create a reusable delegation set.

    \n
    2. \n
  2. \n

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    \n
    3. \n
  3. \n

    Recreate resource record sets in the new hosted zones.

    \n
    4. \n
  4. \n

    Change the registrar's name servers to use the name servers for the new hosted zones.

    \n
    5. \n
  5. \n

    Monitor traffic for the website or application.

    \n
    6. \n
  6. \n

    Change TTLs back to their original values.

    \n
    7. \n
\n\t\t\n\t\t

If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use \n\t\t\tany of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more \n\t\t\tname servers that are assigned to the reusable delegation set, you can do one of the following:

\n\t\t
    \n
  • \n

    For small numbers of hosted zones—up to a few hundred—it's relatively easy to create \n\t\t\t\treusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers \n\t\t\t\tin your hosted zones.

    \n
    • \n
  • \n

    For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.

    \n
    • \n
  • \n

    For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers \n\t\t\t\tto hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the \n\t\t\t\treusable delegation set.

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

Creates a delegation set (a group of four name servers) that can be reused by multiple\n\t\t\thosted zones that were created by the same Amazon Web Services account.

\n\t\t

You can also create a reusable delegation set that uses the four name servers that are\n\t\t\tassociated with an existing hosted zone. Specify the hosted zone ID in the\n\t\t\t\tCreateReusableDelegationSet request.

\n\t\t \n\t\t\t

You can't associate a reusable delegation set with a private hosted zone.

\n\t\t \n\t\t

For information about using a reusable delegation set to configure white label name\n\t\t\tservers, see Configuring White\n\t\t\t\tLabel Name Servers.

\n\t\t

The process for migrating existing hosted zones to use a reusable delegation set is\n\t\t\tcomparable to the process for configuring white label name servers. You need to perform\n\t\t\tthe following steps:

\n\t\t
    \n
  1. \n\t\t\t\t

    Create a reusable delegation set.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Recreate resource record sets in the new hosted zones.

    \n\t\t\t
    4. \n
  4. \n\t\t\t\t

    Change the registrar's name servers to use the name servers for the new hosted\n\t\t\t\t\tzones.

    \n\t\t\t
    5. \n
  5. \n\t\t\t\t

    Monitor traffic for the website or application.

    \n\t\t\t
    6. \n
  6. \n\t\t\t\t

    Change TTLs back to their original values.

    \n\t\t\t
    7. \n
\n\t\t

If you want to migrate existing hosted zones to use a reusable delegation set, the\n\t\t\texisting hosted zones can't use any of the name servers that are assigned to the\n\t\t\treusable delegation set. If one or more hosted zones do use one or more name servers\n\t\t\tthat are assigned to the reusable delegation set, you can do one of the\n\t\t\tfollowing:

\n\t\t
    \n
  • \n\t\t\t\t

    For small numbers of hosted zones—up to a few hundred—it's\n\t\t\t\t\trelatively easy to create reusable delegation sets until you get one that has\n\t\t\t\t\tfour name servers that don't overlap with any of the name servers in your hosted\n\t\t\t\t\tzones.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For larger numbers of hosted zones, the easiest solution is to use more than\n\t\t\t\t\tone reusable delegation set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For larger numbers of hosted zones, you can also migrate hosted zones that\n\t\t\t\t\thave overlapping name servers to hosted zones that don't have overlapping name\n\t\t\t\t\tservers, then migrate the hosted zones again to use the reusable delegation\n\t\t\t\t\tset.

    \n\t\t\t
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/delegationset", @@ -1514,7 +1993,7 @@ "CallerReference": { "target": "com.amazonaws.route53#Nonce", "traits": { - "smithy.api#documentation": "

A unique string that identifies the request, and that allows you to retry failed\n\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time you\n\t\t\tsubmit a CreateReusableDelegationSet request. CallerReference can be\n\t\t\tany unique string, for example a date/time stamp.

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

A unique string that identifies the request, and that allows you to retry failed\n\t\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time\n\t\t\tyou submit a CreateReusableDelegationSet request.\n\t\t\t\tCallerReference can be any unique string, for example a date/time\n\t\t\tstamp.

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

Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or \n\t\t\tone subdomain name (such as www.example.com).

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

Creates a traffic policy, which you use to create multiple DNS resource record sets\n\t\t\tfor one domain name (such as example.com) or one subdomain name (such as\n\t\t\twww.example.com).

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/trafficpolicy", @@ -1603,7 +2082,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. \n\t\t\tIn addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or \n\t\t\tsubdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets \n\t\t\tthat CreateTrafficPolicyInstance created.

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

Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/trafficpolicyinstance", @@ -1617,41 +2096,41 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy.

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

The ID of the hosted zone that you want Amazon Route 53 to create resource record sets\n\t\t\tin by using the configuration in a traffic policy.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using \n\t\t\tthe resource record sets that Route 53 creates for this traffic policy instance.

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

The domain name (such as example.com) or subdomain name (such as www.example.com) for\n\t\t\twhich Amazon Route 53 responds to DNS queries by using the resource record sets that\n\t\t\tRoute 53 creates for this traffic policy instance.

", "smithy.api#required": {} } }, "TTL": { "target": "com.amazonaws.route53#TTL", "traits": { - "smithy.api#documentation": "

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.

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

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource\n\t\t\trecord sets that it creates in the specified hosted zone.

", "smithy.api#required": {} } }, "TrafficPolicyId": { "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

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

The ID of the traffic policy that you want to use to create resource record sets in\n\t\t\tthe specified hosted zone.

", "smithy.api#required": {} } }, "TrafficPolicyVersion": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

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

The version of the traffic policy that you want to use to create resource record sets\n\t\t\tin the specified hosted zone.

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

A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.

" + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that you want\n\t\t\tto create based on a specified traffic policy.

" } }, "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse": { @@ -1674,7 +2153,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the CreateTrafficPolicyInstance request.

" + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyInstance request.

" } }, "com.amazonaws.route53#CreateTrafficPolicyRequest": { @@ -1690,7 +2169,7 @@ "Document": { "target": "com.amazonaws.route53#TrafficPolicyDocument", "traits": { - "smithy.api#documentation": "

The definition of this traffic policy in JSON format. For more information, see \n\t\t\tTraffic Policy Document Format.

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

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

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

A complex type that contains information about the traffic policy that you want to create.

" + "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate.

" } }, "com.amazonaws.route53#CreateTrafficPolicyResponse": { @@ -1725,7 +2204,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response information for the CreateTrafficPolicy request.

" + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicy request.

" } }, "com.amazonaws.route53#CreateTrafficPolicyVersion": { @@ -1754,7 +2233,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the \n\t\t\ttraffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create \n\t\t\tmultiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can \n\t\t\tcreate a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new \n\t\t\ttraffic policy.

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

Creates a new version of an existing traffic policy. When you create a new version of\n\t\t\ta traffic policy, you specify the ID of the traffic policy that you want to update and a\n\t\t\tJSON-formatted document that describes the new version. You use traffic policies to\n\t\t\tcreate multiple DNS resource record sets for one domain name (such as example.com) or\n\t\t\tone subdomain name (such as www.example.com). You can create a maximum of 1000 versions\n\t\t\tof a traffic policy. If you reach the limit and need to create another version, you'll\n\t\t\tneed to start a new traffic policy.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/trafficpolicy/{Id}", @@ -1776,19 +2255,19 @@ "Document": { "target": "com.amazonaws.route53#TrafficPolicyDocument", "traits": { - "smithy.api#documentation": "

The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion \n\t\t\trequest. For more information about the JSON format, see \n\t\t\tCreateTrafficPolicy.

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

The definition of this version of the traffic policy, in JSON format. You specified\n\t\t\tthe JSON in the CreateTrafficPolicyVersion request. For more information\n\t\t\tabout the JSON format, see CreateTrafficPolicy.

", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.route53#TrafficPolicyComment", "traits": { - "smithy.api#documentation": "

The comment that you specified in the CreateTrafficPolicyVersion request, if any.

" + "smithy.api#documentation": "

The comment that you specified in the CreateTrafficPolicyVersion request,\n\t\t\tif any.

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

A complex type that contains information about the traffic policy that you want to create a new version for.

" + "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate a new version for.

" } }, "com.amazonaws.route53#CreateTrafficPolicyVersionResponse": { @@ -1797,7 +2276,7 @@ "TrafficPolicy": { "target": "com.amazonaws.route53#TrafficPolicy", "traits": { - "smithy.api#documentation": "

A complex type that contains settings for the new version of the traffic policy.

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

A complex type that contains settings for the new version of the traffic\n\t\t\tpolicy.

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

A complex type that contains the response information for the CreateTrafficPolicyVersion request.

" + "smithy.api#documentation": "

A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyVersion request.

" } }, "com.amazonaws.route53#CreateVPCAssociationAuthorization": { @@ -1840,7 +2319,7 @@ } ], "traits": { - "smithy.api#documentation": "

Authorizes the Amazon Web Services account that created a specified VPC to submit an AssociateVPCWithHostedZone \n\t\t\trequest to associate the VPC with a specified hosted zone that was created by a different account. \n\t\t\tTo submit a CreateVPCAssociationAuthorization request, you must use the account that created the \n\t\t\thosted zone. After you authorize the association, use the account that created the VPC to submit an \n\t\t\tAssociateVPCWithHostedZone request.

\n\t\t \n

If you want to associate multiple VPCs that you created by using one account with a hosted zone \n\t\t\tthat you created by using a different account, you must submit one authorization request for each VPC.

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

Authorizes the Amazon Web Services account that created a specified VPC to submit an\n\t\t\t\tAssociateVPCWithHostedZone request to associate the VPC with a\n\t\t\tspecified hosted zone that was created by a different account. To submit a\n\t\t\t\tCreateVPCAssociationAuthorization request, you must use the account\n\t\t\tthat created the hosted zone. After you authorize the association, use the account that\n\t\t\tcreated the VPC to submit an AssociateVPCWithHostedZone request.

\n\t\t \n\t\t\t

If you want to associate multiple VPCs that you created by using one account with\n\t\t\t\ta hosted zone that you created by using a different account, you must submit one\n\t\t\t\tauthorization request for each VPC.

\n\t\t ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", @@ -1854,7 +2333,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the private hosted zone that you want to authorize associating a VPC with.

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

The ID of the private hosted zone that you want to authorize associating a VPC\n\t\t\twith.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1862,13 +2341,13 @@ "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { - "smithy.api#documentation": "

A complex type that contains the VPC ID and region for the VPC that you want to authorize associating \n\t\t\twith your hosted zone.

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

A complex type that contains the VPC ID and region for the VPC that you want to\n\t\t\tauthorize associating with your hosted zone.

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

A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. \n\t\t\tAuthorization is only required when a private hosted zone and a VPC were created by using different accounts.

" + "smithy.api#documentation": "

A complex type that contains information about the request to authorize associating a\n\t\t\tVPC with your private hosted zone. Authorization is only required when a private hosted\n\t\t\tzone and a VPC were created by using different accounts.

" } }, "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse": { @@ -1890,7 +2369,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response information from a CreateVPCAssociationAuthorization request.

" + "smithy.api#documentation": "

A complex type that contains the response information from a\n\t\t\t\tCreateVPCAssociationAuthorization request.

" } }, "com.amazonaws.route53#DNSName": { @@ -1924,13 +2403,13 @@ "ServeSignature": { "target": "com.amazonaws.route53#ServeSignature", "traits": { - "smithy.api#documentation": "

A string that represents the current hosted zone signing status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
SIGNING
\n
\n

DNSSEC signing is enabled for the hosted zone.

\n
\n
NOT_SIGNING
\n
\n

DNSSEC signing is not enabled for the hosted zone.

\n
\n
DELETING
\n
\n

DNSSEC signing is in the process of being removed for the hosted zone.

\n
\n
ACTION_NEEDED
\n
\n

There is a problem with signing in the hosted zone that requires you to take action to resolve.\n\t\t\t\t\tFor example, the customer managed key might have been deleted, or the\n\t\t\t\t\tpermissions for the customer managed key might have been changed.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with DNSSEC\n\t\t\t\t\tsigning, including with key-signing keys (KSKs), you must correct the problem by enabling or \n\t\t\t\t\tdisabling DNSSEC signing for the hosted zone.

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

A string that represents the current hosted zone signing status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
SIGNING
\n
\n\t\t\t\t\t

DNSSEC signing is enabled for the hosted zone.

\n\t\t\t\t
\n
NOT_SIGNING
\n
\n\t\t\t\t\t

DNSSEC signing is not enabled for the hosted zone.

\n\t\t\t\t
\n
DELETING
\n
\n\t\t\t\t\t

DNSSEC signing is in the process of being removed for the hosted\n\t\t\t\t\t\tzone.

\n\t\t\t\t
\n
ACTION_NEEDED
\n
\n\t\t\t\t\t

There is a problem with signing in the hosted zone that requires you to\n\t\t\t\t\t\ttake action to resolve. For example, the customer managed key might have\n\t\t\t\t\t\tbeen deleted, or the permissions for the customer managed key might have\n\t\t\t\t\t\tbeen changed.

\n\t\t\t\t
\n
INTERNAL_FAILURE
\n
\n\t\t\t\t\t

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including with key-signing keys (KSKs), you must correct the\n\t\t\t\t\t\tproblem by enabling or disabling DNSSEC signing for the hosted zone.

\n\t\t\t\t
\n
" } }, "StatusMessage": { "target": "com.amazonaws.route53#SigningKeyStatusMessage", "traits": { - "smithy.api#documentation": "

The status message provided for the following DNSSEC signing status: INTERNAL_FAILURE. The status message \n\t\t\tincludes information about what the problem might be and steps that you can take to correct the issue.

" + "smithy.api#documentation": "

The status message provided for the following DNSSEC signing status:\n\t\t\t\tINTERNAL_FAILURE. The status message includes information about what\n\t\t\tthe problem might be and steps that you can take to correct the issue.

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

Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the \n\t\t\tKSK status to INACTIVE.

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

Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.\n\t\t\tThis operation changes the KSK status to INACTIVE.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/deactivate", @@ -2022,19 +2501,19 @@ "CallerReference": { "target": "com.amazonaws.route53#Nonce", "traits": { - "smithy.api#documentation": "

The value that you specified for CallerReference when you created the reusable delegation set.

" + "smithy.api#documentation": "

The value that you specified for CallerReference when you created the\n\t\t\treusable delegation set.

" } }, "NameServers": { "target": "com.amazonaws.route53#DelegationSetNameServers", "traits": { - "smithy.api#documentation": "

A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

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

A complex type that contains a list of the authoritative name servers for a hosted\n\t\t\tzone or for a reusable delegation set.

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

A complex type that lists the name servers in a delegation set, as well as the CallerReference and the ID \n\t\t\tfor the delegation set.

" + "smithy.api#documentation": "

A complex type that lists the name servers in a delegation set, as well as the\n\t\t\t\tCallerReference and the ID for the delegation set.

" } }, "com.amazonaws.route53#DelegationSetAlreadyCreated": { @@ -2048,7 +2527,7 @@ } }, "traits": { - "smithy.api#documentation": "

A delegation set with the same owner and caller reference combination has already been created.

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

A delegation set with the same owner and caller reference combination has already been\n\t\t\tcreated.

", "smithy.api#error": "client" } }, @@ -2078,7 +2557,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set \n\t\t\tcan be deleted.

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

The specified delegation contains associated hosted zones which must be deleted before\n\t\t\tthe reusable delegation set can be deleted.

", "smithy.api#error": "client" } }, @@ -2107,7 +2586,7 @@ } }, "traits": { - "smithy.api#documentation": "

You can create a hosted zone that has the same name as an existing hosted zone (example.com is common), but there is a \n\t\t\tlimit to the number of hosted zones that have the same name. If you get this error, Amazon Route 53 has reached that limit. If you own \n\t\t\tthe domain name and Route 53 generates this error, contact Customer Support.

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

You can create a hosted zone that has the same name as an existing hosted zone\n\t\t\t(example.com is common), but there is a limit to the number of hosted zones that have\n\t\t\tthe same name. If you get this error, Amazon Route 53 has reached that limit. If you own\n\t\t\tthe domain name and Route 53 generates this error, contact Customer Support.

", "smithy.api#error": "client" } }, @@ -2135,6 +2614,54 @@ } } }, + "com.amazonaws.route53#DeleteCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteCidrCollectionRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrCollectionInUseException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a CIDR collection in the current Amazon Web Services account. The collection\n\t\t\tmust be empty before it can be deleted.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/cidrcollection/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteCidrCollectionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the collection to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53#DeleteCidrCollectionResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.route53#DeleteHealthCheck": { "type": "operation", "input": { @@ -2155,7 +2682,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a health check.

\n\t\t \n\t\t\t

Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more \n\t\t\t\tresource record sets. If you delete a health check and you don't update the associated resource record sets, the future status \n\t\t\t\tof the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover \n\t\t\t\tconfiguration. For more information, see \n\t\t\t\tReplacing and Deleting Health Checks \n\t\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t \n\t\t\n\t\t

If you're using Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance, \n\t\t\tyou can't use the Route 53 DeleteHealthCheck command to delete the health check. The health check is deleted \n\t\t\tautomatically when you deregister the instance; there can be a delay of several hours before the health check is deleted \n\t\t\tfrom Route 53.

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

Deletes a health check.

\n\t\t \n\t\t\t

Amazon Route 53 does not prevent you from deleting a health check even if the\n\t\t\t\thealth check is associated with one or more resource record sets. If you delete a\n\t\t\t\thealth check and you don't update the associated resource record sets, the future\n\t\t\t\tstatus of the health check can't be predicted and may change. This will affect the\n\t\t\t\trouting of DNS queries for your DNS failover configuration. For more information,\n\t\t\t\tsee Replacing and Deleting Health Checks in the Amazon Route 53\n\t\t\t\t\tDeveloper Guide.

\n\t\t \n\t\t

If you're using Cloud Map and you configured Cloud Map to create a Route 53\n\t\t\thealth check when you register an instance, you can't use the Route 53\n\t\t\t\tDeleteHealthCheck command to delete the health check. The health check\n\t\t\tis deleted automatically when you deregister the instance; there can be a delay of\n\t\t\tseveral hours before the health check is deleted from Route 53.

", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/healthcheck/{HealthCheckId}", @@ -2212,7 +2739,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a hosted zone.

\n\t\t\n\t\t

If the hosted zone was created by another service, such as Cloud Map, see \n\t\t\tDeleting \n\t\t\tPublic Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. \n\t\t\t(The process is the same for public and private hosted zones that were created by another service.)

\n\t\t\n\t\t

If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, \n\t\t\twe recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.

\n\t\t\n\t\t \n\t\t\t

If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your \n\t\t\t\tdomain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone \n\t\t\t\tand you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, \n\t\t\t\tsomeone could hijack the domain and route traffic to their own resources using your domain name.

\n\t\t \n\t\t\n\t\t

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. \n\t\t\tWhen you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, \n\t\t\tsee UpdateDomainNameservers\n\t\t\tfor information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with \n\t\t\tanother registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, \n\t\t\tperform an internet search on \"free DNS service.\"

\n\n\t\t

You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. \n\t\t\tIf the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. \n\t\t\tIf you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a \n\t\t\tHostedZoneNotEmpty error. For information about deleting records from your hosted zone, see \n\t\t\tChangeResourceRecordSets.

\n\t\t

To verify that the hosted zone has been deleted, do one of the following:

\n\t\t
    \n
  • \n

    Use the GetHostedZone action to request information about the hosted zone.

    \n
    • \n
  • \n

    Use the ListHostedZones action to get a list of the hosted zones associated with the current \n\t\t\t\tAmazon Web Services account.

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

Deletes a hosted zone.

\n\t\t

If the hosted zone was created by another service, such as Cloud Map, see\n\t\t\t\tDeleting Public Hosted Zones That Were Created by Another Service in the\n\t\t\t\t\tAmazon Route 53 Developer Guide for information\n\t\t\tabout how to delete it. (The process is the same for public and private hosted zones\n\t\t\tthat were created by another service.)

\n\t\t

If you want to keep your domain registration but you want to stop routing internet\n\t\t\ttraffic to your website or web application, we recommend that you delete resource record\n\t\t\tsets in the hosted zone instead of deleting the hosted zone.

\n\t\t \n\t\t\t

If you delete a hosted zone, you can't undelete it. You must create a new hosted\n\t\t\t\tzone and update the name servers for your domain registration, which can require up\n\t\t\t\tto 48 hours to take effect. (If you delegated responsibility for a subdomain to a\n\t\t\t\thosted zone and you delete the child hosted zone, you must update the name servers\n\t\t\t\tin the parent hosted zone.) In addition, if you delete a hosted zone, someone could\n\t\t\t\thijack the domain and route traffic to their own resources using your domain\n\t\t\t\tname.

\n\t\t \n\t\t

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS\n\t\t\tservice for the domain to a free DNS service. When you transfer DNS service, you have to\n\t\t\tupdate the name servers for the domain registration. If the domain is registered with\n\t\t\t\tRoute 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is\n\t\t\tregistered with another registrar, use the method provided by the registrar to update\n\t\t\tname servers for the domain registration. For more information, perform an internet\n\t\t\tsearch on \"free DNS service.\"

\n\t\t

You can delete a hosted zone only if it contains only the default SOA record and NS\n\t\t\tresource record sets. If the hosted zone contains other resource record sets, you must\n\t\t\tdelete them before you can delete the hosted zone. If you try to delete a hosted zone\n\t\t\tthat contains other resource record sets, the request fails, and Route 53\n\t\t\treturns a HostedZoneNotEmpty error. For information about deleting records\n\t\t\tfrom your hosted zone, see ChangeResourceRecordSets.

\n\t\t

To verify that the hosted zone has been deleted, do one of the following:

\n\t\t
    \n
  • \n\t\t\t\t

    Use the GetHostedZone action to request information about the\n\t\t\t\t\thosted zone.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Use the ListHostedZones action to get a list of the hosted zones\n\t\t\t\t\tassociated with the current Amazon Web Services account.

    \n\t\t\t
    • \n
", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/hostedzone/{Id}", @@ -2242,13 +2769,13 @@ "ChangeInfo": { "target": "com.amazonaws.route53#ChangeInfo", "traits": { - "smithy.api#documentation": "

A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone.

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

A complex type that contains the ID, the status, and the date and time of a request to\n\t\t\tdelete a hosted zone.

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

A complex type that contains the response to a DeleteHostedZone request.

" + "smithy.api#documentation": "

A complex type that contains the response to a DeleteHostedZone\n\t\t\trequest.

" } }, "com.amazonaws.route53#DeleteKeySigningKey": { @@ -2280,7 +2807,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be\n\t\tdeactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.

\n\t\t

You can use DeactivateKeySigningKey \n\t\t\tto deactivate the key before you delete it.

\n\t\t

Use GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.

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

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it.\n\t\t\tThe KSK must be deactivated before you can delete it regardless of whether the hosted\n\t\t\tzone is enabled for DNSSEC signing.

\n\t\t

You can use DeactivateKeySigningKey to deactivate the key before you delete it.

\n\t\t

Use GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.

", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/keysigningkey/{HostedZoneId}/{Name}", @@ -2340,7 +2867,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. \n\t\t\tRoute 53 doesn't delete any logs that are already in CloudWatch Logs.

\n\t\t\n\t\t

For more information about DNS query logs, see \n\t\t\tCreateQueryLoggingConfig.

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

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon\n\t\t\tRoute 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs\n\t\t\tthat are already in CloudWatch Logs.

\n\t\t

For more information about DNS query logs, see CreateQueryLoggingConfig.

", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/queryloggingconfig/{Id}", @@ -2388,7 +2915,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a reusable delegation set.

\n\t\t \n\t\t\t

You can delete a reusable delegation set only if it isn't associated with any hosted zones.

\n\t\t \n\t\t

To verify that the reusable delegation set is not associated with any hosted zones, submit a \n\t\t\tGetReusableDelegationSet \n\t\t\trequest and specify the ID of the reusable delegation set that you want to delete.

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

Deletes a reusable delegation set.

\n\t\t \n\t\t\t

You can delete a reusable delegation set only if it isn't associated with any\n\t\t\t\thosted zones.

\n\t\t \n\t\t

To verify that the reusable delegation set is not associated with any hosted zones,\n\t\t\tsubmit a GetReusableDelegationSet request and specify the ID of the reusable\n\t\t\tdelegation set that you want to delete.

", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/delegationset/{Id}", @@ -2442,7 +2969,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a traffic policy.

\n\t\t

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53 never fully deletes \n\t\t\tthe traffic policy. Note the following:

\n\t\t
    \n
  • \n

    Deleted traffic policies aren't listed if you run ListTrafficPolicies.

    \n
    • \n
  • \n

    \tThere's no way to get a list of deleted policies.

    \n
    • \n
  • \n

    If you retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running \n\t\t\t\tGetTrafficPolicy.

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

Deletes a traffic policy.

\n\t\t

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that\n\t\t\tit has been deleted. However, Route 53 never fully deletes the traffic policy. Note the\n\t\t\tfollowing:

\n\t\t
    \n
  • \n\t\t\t\t

    Deleted traffic policies aren't listed if you run ListTrafficPolicies.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    There's no way to get a list of deleted policies.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you retain the ID of the policy, you can get information about the policy,\n\t\t\t\t\tincluding the traffic policy document, by running GetTrafficPolicy.

    \n\t\t\t
    • \n
", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", @@ -2470,7 +2997,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.

\n\t\t \n\t\t\t

In the Route 53 console, traffic policy instances are known as policy records.

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

Deletes a traffic policy instance and all of the resource record sets that Amazon\n\t\t\tRoute 53 created when you created the instance.

\n\t\t \n\t\t\t

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n\t\t ", "smithy.api#http": { "method": "DELETE", "uri": "/2013-04-01/trafficpolicyinstance/{Id}", @@ -2484,7 +3011,7 @@ "Id": { "target": "com.amazonaws.route53#TrafficPolicyInstanceId", "traits": { - "smithy.api#documentation": "

The ID of the traffic policy instance that you want to delete.

\n\t\t \n\t\t\t

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created \n\t\t\t\tthe traffic policy instance.

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

The ID of the traffic policy instance that you want to delete.

\n\t\t \n\t\t\t

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the\n\t\t\t\tresource record sets that were created when you created the traffic policy\n\t\t\t\tinstance.

\n\t\t ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2558,7 +3085,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC \n\t\t\twith a hosted zone that was created by a different account. You must use the account that created the hosted zone \n\t\t\tto submit a DeleteVPCAssociationAuthorization request.

\n\t\t \n\t\t\t

Sending this request only prevents the Amazon Web Services account that created the VPC from associating the VPC \n\t\t\t\twith the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, \n\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. \n\t\t\t\tIf you want to delete an existing association, use DisassociateVPCFromHostedZone.

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

Removes authorization to submit an AssociateVPCWithHostedZone request to\n\t\t\tassociate a specified VPC with a hosted zone that was created by a different account.\n\t\t\tYou must use the account that created the hosted zone to submit a\n\t\t\t\tDeleteVPCAssociationAuthorization request.

\n\t\t \n\t\t\t

Sending this request only prevents the Amazon Web Services account that created the\n\t\t\t\tVPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If\n\t\t\t\tthe VPC is already associated with the hosted zone,\n\t\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from\n\t\t\t\tthe hosted zone. If you want to delete an existing association, use\n\t\t\t\t\tDisassociateVPCFromHostedZone.

\n\t\t ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/deauthorizevpcassociation", @@ -2572,7 +3099,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone \n\t\t\tthat was created with a different Amazon Web Services account, the ID of the hosted zone.

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

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2580,13 +3107,13 @@ "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { - "smithy.api#documentation": "

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone \n\t\t\tthat was created with a different Amazon Web Services account, a complex type that includes the ID and region of the VPC.

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

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the\n\t\t\tVPC.

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

A complex type that contains information about the request to remove authorization to associate a VPC \n\t\t\tthat was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains information about the request to remove authorization to\n\t\t\tassociate a VPC that was created by one Amazon Web Services account with a hosted zone\n\t\t\tthat was created with a different Amazon Web Services account.

" } }, "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse": { @@ -2602,20 +3129,20 @@ "Name": { "target": "com.amazonaws.route53#DimensionField", "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the name of one dimension.

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

For the metric that the CloudWatch alarm is associated with, the name of one\n\t\t\tdimension.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.route53#DimensionField", "traits": { - "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, the value of one dimension.

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

For the metric that the CloudWatch alarm is associated with, the value of one\n\t\t\tdimension.

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

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.

" + "smithy.api#documentation": "

For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about one dimension.

" } }, "com.amazonaws.route53#DimensionField": { @@ -2677,7 +3204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs)\n\t\tthat are active in the hosted zone.

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

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any\n\t\t\tkey-signing keys (KSKs) that are active in the hosted zone.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disable-dnssec", @@ -2744,7 +3271,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:

\n\t\t
    \n
  • \n

    You can't disassociate the last Amazon VPC from a private hosted zone.

    \n
    • \n
  • \n

    You can't convert a private hosted zone into a public hosted zone.

    \n
    • \n
  • \n

    You can submit a DisassociateVPCFromHostedZone request using either the account \n\t\t\t\tthat created the hosted zone or the account that created the Amazon VPC.

    \n
    • \n
  • \n

    Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate \n\t\t\t\tVPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. \n\t\t\t\tYou can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.

    \n\t\t\t\t

    When you run DisassociateVPCFromHostedZone, \n\t\t\t\t\tif the hosted zone has a value for OwningAccount, you can use DisassociateVPCFromHostedZone. \n\t\t\t\t\tIf the hosted zone has a value for OwningService, you can't use DisassociateVPCFromHostedZone.

    \n\t\t\t
    • \n
\n\t\t \n

When revoking access, the hosted zone and the Amazon VPC must belong to the same\n\t\t\t\tpartition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t
    \n
  • \n

    \n aws - Amazon Web Services Regions

    \n
    • \n
  • \n

    \n aws-cn - China Regions

    \n
    • \n
  • \n

    \n aws-us-gov - Amazon Web Services GovCloud (US) Region

    \n
    • \n
\n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

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

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53\n\t\t\tprivate hosted zone. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    You can't disassociate the last Amazon VPC from a private hosted zone.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can't convert a private hosted zone into a public hosted zone.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can submit a DisassociateVPCFromHostedZone request using\n\t\t\t\t\teither the account that created the hosted zone or the account that created the\n\t\t\t\t\tAmazon VPC.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Some services, such as Cloud Map and Amazon Elastic File System\n\t\t\t\t\t(Amazon EFS) automatically create hosted zones and associate VPCs with the\n\t\t\t\t\thosted zones. A service can create a hosted zone using your account or using its\n\t\t\t\t\town account. You can disassociate a VPC from a hosted zone only if the service\n\t\t\t\t\tcreated the hosted zone using your account.

    \n\t\t\t\t

    When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for\n\t\t\t\t\t\tOwningAccount, you can use\n\t\t\t\t\t\tDisassociateVPCFromHostedZone. If the hosted zone has a value\n\t\t\t\t\tfor OwningService, you can't use\n\t\t\t\t\t\tDisassociateVPCFromHostedZone.

    \n\t\t\t
    • \n
\n\t\t \n\t\t\t

When revoking access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    \n aws - Amazon Web Services Regions

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n aws-cn - China Regions

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n aws-us-gov - Amazon Web Services GovCloud (US) Region

    \n\t\t\t\t
    • \n
\n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t ", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disassociatevpc", @@ -2766,7 +3293,7 @@ "VPC": { "target": "com.amazonaws.route53#VPC", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPC that you're disassociating\n\t\t\tfrom the specified hosted zone.

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

A complex type that contains information about the VPC that you're disassociating from\n\t\t\tthe specified hosted zone.

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

A complex type that contains information about the VPC that you want to disassociate from a \n\t\t\tspecified private hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about the VPC that you want to disassociate\n\t\t\tfrom a specified private hosted zone.

" } }, "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse": { @@ -2787,13 +3314,13 @@ "ChangeInfo": { "target": "com.amazonaws.route53#ChangeInfo", "traits": { - "smithy.api#documentation": "

A complex type that describes the changes made to the specified private hosted zone.

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

A complex type that describes the changes made to the specified private hosted\n\t\t\tzone.

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

A complex type that contains the response information for the disassociate request.

" + "smithy.api#documentation": "

A complex type that contains the response information for the disassociate\n\t\t\trequest.

" } }, "com.amazonaws.route53#EnableHostedZoneDNSSEC": { @@ -2918,19 +3445,19 @@ "ContinentCode": { "target": "com.amazonaws.route53#GeoLocationContinentCode", "traits": { - "smithy.api#documentation": "

The two-letter code for the continent.

\n\t\t

Amazon Route 53 supports the following continent codes:

\n\t\t
    \n
  • \n

    \n AF: Africa

    \n
    • \n
  • \n

    \n AN: Antarctica

    \n
    • \n
  • \n

    \n AS: Asia

    \n
    • \n
  • \n

    \n EU: Europe

    \n
    • \n
  • \n

    \n OC: Oceania

    \n
    • \n
  • \n

    \n NA: North America

    \n
    • \n
  • \n

    \n SA: South America

    \n
    • \n
\n\t\t

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an \n\t\t\tInvalidInput error.

" + "smithy.api#documentation": "

The two-letter code for the continent.

\n\t\t

Amazon Route 53 supports the following continent codes:

\n\t\t
    \n
  • \n\t\t\t\t

    \n AF: Africa

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n AN: Antarctica

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n AS: Asia

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n EU: Europe

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n OC: Oceania

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n NA: North America

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n SA: South America

    \n\t\t\t
    • \n
\n\t\t

Constraint: Specifying ContinentCode with either CountryCode\n\t\t\tor SubdivisionCode returns an InvalidInput error.

" } }, "CountryCode": { "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a country.

\n\t\t

Amazon Route 53 uses the two-letter country codes that are specified in \n\t\t\tISO standard 3166-1 alpha-2.

" + "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a country.

\n\t\t

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

" } }, "SubdivisionCode": { "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a state of the United States. \n\t\t\tRoute 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see \n\t\t\tAppendix B: Two–Letter State and Possession Abbreviations \n\t\t\ton the United States Postal Service website.

\n\t\t

If you specify subdivisioncode, you must also specify US for CountryCode.

" + "smithy.api#documentation": "

For geolocation resource record sets, the two-letter code for a state of the United\n\t\t\tStates. Route 53 doesn't support any other values for SubdivisionCode. For\n\t\t\ta list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United\n\t\t\tStates Postal Service website.

\n\t\t

If you specify subdivisioncode, you must also specify US for\n\t\t\t\tCountryCode.

" } } }, @@ -3004,18 +3531,18 @@ "SubdivisionCode": { "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", "traits": { - "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.

" + "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

" } }, "SubdivisionName": { "target": "com.amazonaws.route53#GeoLocationSubdivisionName", "traits": { - "smithy.api#documentation": "

The full name of the subdivision. Route 53 currently supports only states in the United States.

" + "smithy.api#documentation": "

The full name of the subdivision. Route 53 currently supports only states in the\n\t\t\tUnited States.

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

A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

" + "smithy.api#documentation": "

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

" } }, "com.amazonaws.route53#GeoLocationDetailsList": { @@ -3059,7 +3586,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the specified limit for the current account, for example, the maximum number of health checks that you \n\t\t\tcan create using the account.

\n\t\t

For the default limit, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide. To request a higher limit, \n\t\t\topen a case.

\n\t\t \n

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services Management Console and open the Trusted Advisor console at \n\t\t\thttps://console.aws.amazon.com/trustedadvisor/. Then choose \n\t\t\tService limits in the navigation pane.

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

Gets the specified limit for the current account, for example, the maximum number of\n\t\t\thealth checks that you can create using the account.

\n\t\t

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

\n\t\t \n\t\t\t

You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to\n\t\t\t\tthe Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.

\n\t\t ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/accountlimit/{Type}", @@ -3073,14 +3600,14 @@ "Type": { "target": "com.amazonaws.route53#AccountLimitType", "traits": { - "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n\t\t
    \n
  • \n

    \n MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create \n\t\t\t\tusing the current account.

    \n
    • \n
  • \n

    \n MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create \n\t\t\t\tusing the current account.

    \n
    • \n
  • \n

    \n MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets \n\t\t\t\tthat you can create using the current account.

    \n
    • \n
  • \n

    \n MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies \n\t\t\t\tthat you can create using the current account.

    \n
    • \n
  • \n

    \n MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances \n\t\t\t\tthat you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the \n\t\t\t\tAmazon Route 53 console.)

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

The limit that you want to get. Valid values include the following:

\n\t\t
    \n
  • \n\t\t\t\t

    \n MAX_HEALTH_CHECKS_BY_OWNER: The maximum\n\t\t\t\t\tnumber of health checks that you can create using the current account.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_HOSTED_ZONES_BY_OWNER: The maximum number\n\t\t\t\t\tof hosted zones that you can create using the current account.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The\n\t\t\t\t\tmaximum number of reusable delegation sets that you can create using the current\n\t\t\t\t\taccount.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum\n\t\t\t\t\tnumber of traffic policies that you can create using the current account.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The\n\t\t\t\t\tmaximum number of traffic policy instances that you can create using the current\n\t\t\t\t\taccount. (Traffic policy instances are referred to as traffic flow policy\n\t\t\t\t\trecords in the Amazon Route 53 console.)

    \n\t\t\t
    • \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" } }, "com.amazonaws.route53#GetAccountLimitResponse": { @@ -3089,14 +3616,14 @@ "Limit": { "target": "com.amazonaws.route53#AccountLimit", "traits": { - "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of \n\t\t\tType in the request, the value of Limit is the maximum number of health checks that you can create \n\t\t\tusing the current account.

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

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the\n\t\t\trequest, the value of Limit is the maximum number of health checks that you\n\t\t\tcan create using the current account.

", "smithy.api#required": {} } }, "Count": { "target": "com.amazonaws.route53#UsageCount", "traits": { - "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For example, if you specified \n\t\t\tMAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Count \n\t\t\tis the current number of health checks that you have created using the current account.

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

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of health checks that you have created using the current account.

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

Returns the current status of a change batch request. The status is one of the\n\t\t\tfollowing values:

\n\t\t
    \n
  • \n\t\t\t\t

    \n PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. \n\t\t\t\t\tThis is the initial status of all change batch requests.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n INSYNC indicates that the changes have propagated to all Route 53 DNS servers.

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

Returns the current status of a change batch request. The status is one of the\n\t\t\tfollowing values:

\n\t\t
    \n
  • \n\t\t\t\t

    \n PENDING indicates that the changes in this request have not\n\t\t\t\t\tpropagated to all Amazon Route 53 DNS servers. This is the initial status of all\n\t\t\t\t\tchange batch requests.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n INSYNC indicates that the changes have propagated to all Route 53\n\t\t\t\t\tDNS servers.

    \n\t\t\t
    • \n
", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/change/{Id}", @@ -3151,9 +3678,9 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.route53#ResourceId", + "target": "com.amazonaws.route53#ChangeId", "traits": { - "smithy.api#documentation": "

The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets \n\t\t\treturned in the Id element when you submitted the request.

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

The ID of the change batch request. The value that you specify here is the value that\n\t\t\t\tChangeResourceRecordSets returned in the Id element when\n\t\t\tyou submitted the request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3187,7 +3714,7 @@ "target": "com.amazonaws.route53#GetCheckerIpRangesResponse" }, "traits": { - "smithy.api#documentation": "

Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.

\n\t \n\t\t\t

\n GetCheckerIpRanges still works, but we recommend that you download \n\t\t\t\tip-ranges.json, which includes IP address ranges for all Amazon Web Services services. For more information, see \n\t\t\tIP Address Ranges of Amazon Route 53 Servers \n\t\t\tin the Amazon Route 53 Developer Guide.

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

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n\t\t \n\t\t\t

\n GetCheckerIpRanges still works, but we recommend that you download\n\t\t\t\tip-ranges.json, which includes IP address ranges for all Amazon Web Services\n\t\t\t\tservices. For more information, see IP Address Ranges\n\t\t\t\t\tof Amazon Route 53 Servers in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.

\n\t\t ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/checkeripranges", @@ -3208,7 +3735,7 @@ "CheckerIpRanges": { "target": "com.amazonaws.route53#CheckerIpRanges", "traits": { - "smithy.api#documentation": "

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health\n\t\t\tcheckers.

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

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route\n\t\t\t53 health checkers.

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

Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.

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

Returns information about DNSSEC for a specific hosted zone, including the key-signing\n\t\t\tkeys (KSKs) in the hosted zone.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/dnssec", @@ -3294,7 +3821,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation \n\t\t\tresource record sets.

\n\t

Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.

\n\t\t\n\t\t

Use the following syntax to determine whether a continent is supported for geolocation:

\n\t\t

\n GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent\n \n

\n\t\t\n\t\t

Use the following syntax to determine whether a country is supported for geolocation:

\n\t\t

\n GET /2013-04-01/geolocation?countrycode=two-character country code\n \n

\n\t\t\n\t\t

Use the following syntax to determine whether a subdivision of a country is supported for geolocation:

\n\t\t

\n GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code\n \n

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

Gets information about whether a specified geographic location is supported for Amazon\n\t\t\tRoute 53 geolocation resource record sets.

\n\t\t

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n\t\t

Use the following syntax to determine whether a continent is supported for\n\t\t\tgeolocation:

\n\t\t

\n GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for\n\t\t\t\t\ta continent\n \n

\n\t\t

Use the following syntax to determine whether a country is supported for\n\t\t\tgeolocation:

\n\t\t

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode\n \n

\n\t\t

Use the following syntax to determine whether a subdivision of a country is supported\n\t\t\tfor geolocation:

\n\t\t

\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode&subdivisioncode=subdivision\n\t\t\tcode\n \n

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/geolocation", @@ -3308,27 +3835,27 @@ "ContinentCode": { "target": "com.amazonaws.route53#GeoLocationContinentCode", "traits": { - "smithy.api#documentation": "

For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Amazon Route 53 supports the following continent codes:

\n\t\t
    \n
  • \n

    \n AF: Africa

    \n
    • \n
  • \n

    \n AN: Antarctica

    \n
    • \n
  • \n

    \n AS: Asia

    \n
    • \n
  • \n

    \n EU: Europe

    \n
    • \n
  • \n

    \n OC: Oceania

    \n
    • \n
  • \n

    \n NA: North America

    \n
    • \n
  • \n

    \n SA: South America

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

For geolocation resource record sets, a two-letter abbreviation that identifies a\n\t\t\tcontinent. Amazon Route 53 supports the following continent codes:

\n\t\t
    \n
  • \n\t\t\t\t

    \n AF: Africa

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n AN: Antarctica

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n AS: Asia

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n EU: Europe

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n OC: Oceania

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n NA: North America

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n SA: South America

    \n\t\t\t
    • \n
", "smithy.api#httpQuery": "continentcode" } }, "CountryCode": { "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { - "smithy.api#documentation": "

Amazon Route 53 uses the two-letter country codes that are specified in \n\t\t\tISO standard 3166-1 alpha-2.

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

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.

", "smithy.api#httpQuery": "countrycode" } }, "SubdivisionCode": { "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", "traits": { - "smithy.api#documentation": "

The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.

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

The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.

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

A request for information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

" + "smithy.api#documentation": "

A request for information about whether a specified geographic location is supported\n\t\t\tfor Amazon Route 53 geolocation resource record sets.

" } }, "com.amazonaws.route53#GetGeoLocationResponse": { @@ -3337,13 +3864,13 @@ "GeoLocationDetails": { "target": "com.amazonaws.route53#GeoLocationDetails", "traits": { - "smithy.api#documentation": "

A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

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

A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.

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

A complex type that contains the response information for the specified geolocation code.

" + "smithy.api#documentation": "

A complex type that contains the response information for the specified geolocation\n\t\t\tcode.

" } }, "com.amazonaws.route53#GetHealthCheck": { @@ -3410,7 +3937,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheckCount request.

" + "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheckCount\n\t\t\trequest.

" } }, "com.amazonaws.route53#GetHealthCheckLastFailureReason": { @@ -3444,7 +3971,7 @@ "HealthCheckId": { "target": "com.amazonaws.route53#HealthCheckId", "traits": { - "smithy.api#documentation": "

The ID for the health check for which you want the last failure reason. When you created the health check, \n\t\t\tCreateHealthCheck returned the ID in the response, in the HealthCheckId element.

\n\t\t \n

If you want to get the last failure reason for a calculated health check, you must use the Amazon Route 53 console or the \n\t\t\tCloudWatch console. You can't use GetHealthCheckLastFailureReason for a calculated health check.

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

The ID for the health check for which you want the last failure reason. When you\n\t\t\tcreated the health check, CreateHealthCheck returned the ID in the\n\t\t\tresponse, in the HealthCheckId element.

\n\t\t \n\t\t\t

If you want to get the last failure reason for a calculated health check, you must\n\t\t\t\tuse the Amazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckLastFailureReason for a calculated health\n\t\t\t\tcheck.

\n\t\t ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3460,13 +3987,13 @@ "HealthCheckObservations": { "target": "com.amazonaws.route53#HealthCheckObservations", "traits": { - "smithy.api#documentation": "

A list that contains one Observation element for each Amazon Route 53 health checker that is reporting a last failure reason.

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

A list that contains one Observation element for each Amazon Route 53\n\t\t\thealth checker that is reporting a last failure reason.

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

A complex type that contains the response to a GetHealthCheckLastFailureReason request.

" + "smithy.api#documentation": "

A complex type that contains the response to a\n\t\t\t\tGetHealthCheckLastFailureReason request.

" } }, "com.amazonaws.route53#GetHealthCheckRequest": { @@ -3475,7 +4002,7 @@ "HealthCheckId": { "target": "com.amazonaws.route53#HealthCheckId", "traits": { - "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, \n\t\t\tyou use this value to specify which health check to use. The value can be up to 64 characters long.

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

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3491,13 +4018,13 @@ "HealthCheck": { "target": "com.amazonaws.route53#HealthCheck", "traits": { - "smithy.api#documentation": "

A complex type that contains information about one health check that is associated with\n\t\t\tthe current Amazon Web Services account.

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

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

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

A complex type that contains the response to a GetHealthCheck request.

" + "smithy.api#documentation": "

A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.

" } }, "com.amazonaws.route53#GetHealthCheckStatus": { @@ -3517,7 +4044,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets status of a specified health check.

\n\t\t \n

This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.

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

Gets status of a specified health check.

\n\t\t \n\t\t\t

This API is intended for use during development to diagnose behavior. It doesn’t\n\t\t\t\tsupport production use-cases with high query rates that require immediate and\n\t\t\t\tactionable responses.

\n\t\t ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/healthcheck/{HealthCheckId}/status", @@ -3531,7 +4058,7 @@ "HealthCheckId": { "target": "com.amazonaws.route53#HealthCheckId", "traits": { - "smithy.api#documentation": "

The ID for the health check that you want the current status for. When you created the health check, \n\t\t\tCreateHealthCheck returned the ID in the response, in the HealthCheckId element.

\n\t\t \n

If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. \n\t\t\tYou can't use GetHealthCheckStatus to get the status of a calculated health check.

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

The ID for the health check that you want the current status for. When you created the\n\t\t\thealth check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

\n\t\t \n\t\t\t

If you want to check the status of a calculated health check, you must use the\n\t\t\t\tAmazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckStatus to get the status of a calculated health\n\t\t\t\tcheck.

\n\t\t ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3547,7 +4074,7 @@ "HealthCheckObservations": { "target": "com.amazonaws.route53#HealthCheckObservations", "traits": { - "smithy.api#documentation": "

A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status \n\t\t\tabout the health check endpoint.

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

A list that contains one HealthCheckObservation element for each Amazon\n\t\t\tRoute 53 health checker that is reporting a status about the health check\n\t\t\tendpoint.

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

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

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

Gets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzone/{Id}", @@ -3607,7 +4134,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

A request to retrieve a count of all the hosted zones that are associated with the current Amazon Web Services account.

" + "smithy.api#documentation": "

A request to retrieve a count of all the hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" } }, "com.amazonaws.route53#GetHostedZoneCountResponse": { @@ -3616,13 +4143,13 @@ "HostedZoneCount": { "target": "com.amazonaws.route53#HostedZoneCount", "traits": { - "smithy.api#documentation": "

The total number of public and private hosted zones that are associated with the current Amazon Web Services account.

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

The total number of public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.

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

A complex type that contains the response to a GetHostedZoneCount request.

" + "smithy.api#documentation": "

A complex type that contains the response to a GetHostedZoneCount\n\t\t\trequest.

" } }, "com.amazonaws.route53#GetHostedZoneLimit": { @@ -3645,7 +4172,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you \n\t\t\tcan create in the hosted zone.

\n\t\t

For the default limit, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide. To request a higher limit, \n\t\t\topen a case.

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

Gets the specified limit for a specified hosted zone, for example, the maximum number\n\t\t\tof records that you can create in the hosted zone.

\n\t\t

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzonelimit/{HostedZoneId}/{Type}", @@ -3659,7 +4186,7 @@ "Type": { "target": "com.amazonaws.route53#HostedZoneLimitType", "traits": { - "smithy.api#documentation": "

The limit that you want to get. Valid values include the following:

\n\t\t
    \n
  • \n

    \n MAX_RRSETS_BY_ZONE: The maximum number of records that you can create \n\t\t\t\tin the specified hosted zone.

    \n
    • \n
  • \n

    \n MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can \n\t\t\t\tassociate with the specified private hosted zone.

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

The limit that you want to get. Valid values include the following:

\n\t\t
    \n
  • \n\t\t\t\t

    \n MAX_RRSETS_BY_ZONE: The maximum number of\n\t\t\t\t\trecords that you can create in the specified hosted zone.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum\n\t\t\t\t\tnumber of Amazon VPCs that you can associate with the specified private hosted\n\t\t\t\t\tzone.

    \n\t\t\t
    • \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3674,7 +4201,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" } }, "com.amazonaws.route53#GetHostedZoneLimitResponse": { @@ -3683,14 +4210,14 @@ "Limit": { "target": "com.amazonaws.route53#HostedZoneLimit", "traits": { - "smithy.api#documentation": "

The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for the value of \n\t\t\tType in the request, the value of Limit is the maximum number of records that you can create \n\t\t\tin the specified hosted zone.

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

The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request,\n\t\t\tthe value of Limit is the maximum number of records that you can create in\n\t\t\tthe specified hosted zone.

", "smithy.api#required": {} } }, "Count": { "target": "com.amazonaws.route53#UsageCount", "traits": { - "smithy.api#documentation": "

The current number of entities that you have created of the specified type. For example, if you specified \n\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Count \n\t\t\tis the current number of records that you have created in the specified hosted zone.

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

The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_RRSETS_BY_ZONE for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of records that you have created in the specified hosted zone.

", "smithy.api#required": {} } } @@ -3721,25 +4248,25 @@ "HostedZone": { "target": "com.amazonaws.route53#HostedZone", "traits": { - "smithy.api#documentation": "

A complex type that contains general information about the specified hosted zone.

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

A complex type that contains general information about the specified hosted\n\t\t\tzone.

", "smithy.api#required": {} } }, "DelegationSet": { "target": "com.amazonaws.route53#DelegationSet", "traits": { - "smithy.api#documentation": "

A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.

" + "smithy.api#documentation": "

A complex type that lists the Amazon Route 53 name servers for the specified hosted\n\t\t\tzone.

" } }, "VPCs": { "target": "com.amazonaws.route53#VPCs", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the VPCs that are associated with the specified hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about the VPCs that are associated with the\n\t\t\tspecified hosted zone.

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

A complex type that contain the response to a GetHostedZone request.

" + "smithy.api#documentation": "

A complex type that contain the response to a GetHostedZone\n\t\t\trequest.

" } }, "com.amazonaws.route53#GetQueryLoggingConfig": { @@ -3759,7 +4286,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a specified configuration for DNS query logging.

\n\t\t\n\t\t

For more information about DNS query logs, see \n\t\t\tCreateQueryLoggingConfig\n\t\t\tand \n\t\t\tLogging DNS Queries.

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

Gets information about a specified configuration for DNS query logging.

\n\t\t

For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS\n\t\t\tQueries.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/queryloggingconfig/{Id}", @@ -3773,7 +4300,7 @@ "Id": { "target": "com.amazonaws.route53#QueryLoggingConfigId", "traits": { - "smithy.api#documentation": "

The ID of the configuration for DNS query logging that you want to get information about.

", + "smithy.api#documentation": "

The ID of the configuration for DNS query logging that you want to get information\n\t\t\tabout.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3786,7 +4313,7 @@ "QueryLoggingConfig": { "target": "com.amazonaws.route53#QueryLoggingConfig", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the query logging configuration that you specified in a \n\t\t\tGetQueryLoggingConfig request.

", + "smithy.api#documentation": "

A complex type that contains information about the query logging configuration that\n\t\t\tyou specified in a GetQueryLoggingConfig request.

", "smithy.api#required": {} } } @@ -3812,7 +4339,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a specified reusable delegation set, including the four name servers that are assigned \n\t\t\tto the delegation set.

", + "smithy.api#documentation": "

Retrieves information about a specified reusable delegation set, including the four\n\t\t\tname servers that are assigned to the delegation set.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/delegationset/{Id}", @@ -3837,7 +4364,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.

\n\t\t

For the default limit, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide. To request a higher limit, \n\t\t\topen a case.

", + "smithy.api#documentation": "

Gets the maximum number of hosted zones that you can associate with the specified\n\t\t\treusable delegation set.

\n\t\t

For the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/reusabledelegationsetlimit/{DelegationSetId}/{Type}", @@ -3851,7 +4378,7 @@ "Type": { "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", "traits": { - "smithy.api#documentation": "

Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of hosted zones that you can associate \n\t\t\twith the specified reusable delegation set.

", + "smithy.api#documentation": "

Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of\n\t\t\thosted zones that you can associate with the specified reusable delegation set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3866,7 +4393,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about the request to create a hosted\n\t\t\tzone.

" } }, "com.amazonaws.route53#GetReusableDelegationSetLimitResponse": { @@ -3875,14 +4402,14 @@ "Limit": { "target": "com.amazonaws.route53#ReusableDelegationSetLimit", "traits": { - "smithy.api#documentation": "

The current setting for the limit on hosted zones that you can associate with the specified reusable delegation set.

", + "smithy.api#documentation": "

The current setting for the limit on hosted zones that you can associate with the\n\t\t\tspecified reusable delegation set.

", "smithy.api#required": {} } }, "Count": { "target": "com.amazonaws.route53#UsageCount", "traits": { - "smithy.api#documentation": "

The current number of hosted zones that you can associate with the specified reusable delegation set.

", + "smithy.api#documentation": "

The current number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

", "smithy.api#required": {} } } @@ -3897,7 +4424,7 @@ "Id": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the reusable delegation set that you want to get a list of name servers for.

", + "smithy.api#documentation": "

The ID of the reusable delegation set that you want to get a list of name servers\n\t\t\tfor.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3919,7 +4446,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the GetReusableDelegationSet request.

" + "smithy.api#documentation": "

A complex type that contains the response to the GetReusableDelegationSet\n\t\t\trequest.

" } }, "com.amazonaws.route53#GetTrafficPolicy": { @@ -3939,7 +4466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a specific traffic policy version.

\n\t\t

For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see \n\t\t\tDeleteTrafficPolicy.\n\t\t

", + "smithy.api#documentation": "

Gets information about a specific traffic policy version.

\n\t\t

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tGetTrafficPolicy, see DeleteTrafficPolicy.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", @@ -3964,7 +4491,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, \n\t\t\t\tthere's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For \n\t\t\t\tmore information, see the State response element.

\n\t\t \n\t\t \n\t\t\t

In the Route 53 console, traffic policy instances are known as policy records.

\n\t\t ", + "smithy.api#documentation": "

Gets information about a specified traffic policy instance.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n\t\t \n\t\t \n\t\t\t

In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.

\n\t\t ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstance/{Id}", @@ -3981,7 +4508,7 @@ "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse" }, "traits": { - "smithy.api#documentation": "

Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.

", + "smithy.api#documentation": "

Gets the number of traffic policy instances that are associated with the current\n\t\t\t\tAmazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstancecount", @@ -3993,7 +4520,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Request to get the number of traffic policy instances that are associated with the current Amazon Web Services account.

" + "smithy.api#documentation": "

Request to get the number of traffic policy instances that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" } }, "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse": { @@ -4008,7 +4535,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

" + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" } }, "com.amazonaws.route53#GetTrafficPolicyInstanceRequest": { @@ -4039,7 +4566,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

" + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" } }, "com.amazonaws.route53#GetTrafficPolicyRequest": { @@ -4056,7 +4583,7 @@ "Version": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

The version number of the traffic policy that you want to get information about.

", + "smithy.api#documentation": "

The version number of the traffic policy that you want to get information\n\t\t\tabout.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4087,7 +4614,7 @@ "Id": { "target": "com.amazonaws.route53#HealthCheckId", "traits": { - "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use \n\t\t\tthis value to specify which health check to use. The value can be up to 64 characters long.

", + "smithy.api#documentation": "

The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.

", "smithy.api#required": {} } }, @@ -4101,7 +4628,7 @@ "LinkedService": { "target": "com.amazonaws.route53#LinkedService", "traits": { - "smithy.api#documentation": "

If the health check was created by another service, the service that created the health check. When a health check is created \n\t\t\tby another service, you can't edit or delete it using Amazon Route 53.

" + "smithy.api#documentation": "

If the health check was created by another service, the service that created the\n\t\t\thealth check. When a health check is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" } }, "HealthCheckConfig": { @@ -4114,19 +4641,19 @@ "HealthCheckVersion": { "target": "com.amazonaws.route53#HealthCheckVersion", "traits": { - "smithy.api#documentation": "

The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting \n\t\t\tanother change to the health check.

", + "smithy.api#documentation": "

The version of the health check. You can optionally pass this value in a call to\n\t\t\t\tUpdateHealthCheck to prevent overwriting another change to the health\n\t\t\tcheck.

", "smithy.api#required": {} } }, "CloudWatchAlarmConfiguration": { "target": "com.amazonaws.route53#CloudWatchAlarmConfiguration", "traits": { - "smithy.api#documentation": "

A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

" + "smithy.api#documentation": "

A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about one health check that is associated with the current Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.

" } }, "com.amazonaws.route53#HealthCheckAlreadyExists": { @@ -4140,7 +4667,7 @@ } }, "traits": { - "smithy.api#documentation": "

The health check you're attempting to create already exists. Amazon Route 53 returns this error when you submit a request that \n\t\t\thas the following values:

\n\t\t
    \n
  • \n

    The same value for CallerReference as an existing health check, and one or more values that differ \n\t\t\t\tfrom the existing health check that has the same caller reference.

    \n
    • \n
  • \n

    The same value for CallerReference as a health check that you created and later deleted, \n\t\t\t\tregardless of the other settings in the request.

    \n
    • \n
", + "smithy.api#documentation": "

The health check you're attempting to create already exists. Amazon Route 53 returns\n\t\t\tthis error when you submit a request that has the following values:

\n\t\t
    \n
  • \n\t\t\t\t

    The same value for CallerReference as an existing health check,\n\t\t\t\t\tand one or more values that differ from the existing health check that has the\n\t\t\t\t\tsame caller reference.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The same value for CallerReference as a health check that you\n\t\t\t\t\tcreated and later deleted, regardless of the other settings in the\n\t\t\t\t\trequest.

    \n\t\t\t
    • \n
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -4151,110 +4678,110 @@ "IPAddress": { "target": "com.amazonaws.route53#IPAddress", "traits": { - "smithy.api#documentation": "

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for \n\t\t\tIPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName \n\t\t\tat the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health \n\t\t\tof the endpoint.

\n\n\t\t

Use one of the following formats for the value of IPAddress:

\n\t\t
    \n
  • \n

    \n IPv4 address: four values between 0 and 255, separated by periods (.), \n\t\t\t\tfor example, 192.0.2.44.

    \n
    • \n
  • \n

    \n IPv6 address: eight groups of four hexadecimal values, separated by colons (:), \n\t\t\t\tfor example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, \n\t\t\t\tfor example, 2001:db8:85a3::abcd:1:2345.

    \n
    • \n
\n\t\t

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and \n\t\t\tspecify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

\n\t\t

For more information, see \n\t\t\tFullyQualifiedDomainName.\n\t\t

\n\t\t

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or \n\t\t\tmulticast ranges. For more information about IP addresses for which you can't create health checks, see the following \n\t\t\tdocuments:

\n\t\t \n\t\t

When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

" + "smithy.api#documentation": "

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address returned by DNS, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n\t\t

Use one of the following formats for the value of IPAddress:

\n\t\t
    \n
  • \n\t\t\t\t

    \n IPv4 address: four values between 0 and 255,\n\t\t\t\t\tseparated by periods (.), for example, 192.0.2.44.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n IPv6 address: eight groups of four\n\t\t\t\t\thexadecimal values, separated by colons (:), for example,\n\t\t\t\t\t\t2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten\n\t\t\t\t\tIPv6 addresses as described in RFC 5952, for example,\n\t\t\t\t\t\t2001:db8:85a3::abcd:1:2345.

    \n\t\t\t
    • \n
\n\t\t

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance will never\n\t\t\tchange.

\n\t\t

For more information, see FullyQualifiedDomainName.

\n\t\t

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n\t\t \n\t\t

When the value of Type is CALCULATED or\n\t\t\t\tCLOUDWATCH_METRIC, omit IPAddress.

" } }, "Port": { "target": "com.amazonaws.route53#Port", "traits": { - "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

\n\t\t \n\t\t\t

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or \n\t\t\t\tCALCULATED.

\n\t\t " + "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n\t\t \n\t\t\t

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n\t\t " } }, "Type": { "target": "com.amazonaws.route53#HealthCheckType", "traits": { - "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

\n\t\t \n\t\t\t

You can't change the value of Type after you create a health check.

\n\t\t \n\t\t

You can create the following types of health checks:

\n\t\t
    \n
  • \n\t\t\t\t

    \n HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request \n\t\t\t\t\tand waits for an HTTP status code of 200 or greater and less than 400.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request \n\t\t\t\t\tand waits for an HTTP status code of 200 or greater and less than 400.

    \n\t\t\t\t \n\t\t\t\t\t

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

    \n\t\t\t\t     \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an \n\t\t\t\t\tHTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an \n\t\t\t\t\tHTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n TCP: Route 53 tries to establish a TCP connection.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is \n\t\t\t\t\tOK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. \n\t\t\t\t\tIf CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status \n\t\t\t\t\tdepends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or \n\t\t\t\t\tLastKnownStatus.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up \n\t\t\t\t\tthe number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of \n\t\t\t\t\tHealthThreshold.

    \n\t\t\t
    • \n
  • \n

    \n RECOVERY_CONTROL: The health check is assocated with a Route53 Application Recovery Controller routing control. \n\t\t\t\tIf the routing control state is ON, the health check is considered healthy. If the state is OFF, the health check is considered unhealthy. \n\t\t\t\t

    \n
    • \n
\n\t\t

For more information, see \n\t\t\tHow Route 53 \n\t\t\tDetermines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

", + "smithy.api#documentation": "

The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.

\n\t\t \n\t\t\t

You can't change the value of Type after you create a health\n\t\t\t\tcheck.

\n\t\t \n\t\t

You can create the following types of health checks:

\n\t\t
    \n
  • \n\t\t\t\t

    \n HTTP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTP request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n HTTPS: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTPS request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.

    \n\t\t\t\t \n\t\t\t\t\t

    If you specify HTTPS for the value of Type, the\n\t\t\t\t\t\tendpoint must support TLS v1.0 or later.

    \n\t\t\t\t     \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n HTTP_STR_MATCH: Route 53 tries to establish a\n\t\t\t\t\tTCP connection. If successful, Route 53 submits an HTTP request and searches the\n\t\t\t\t\tfirst 5,120 bytes of the response body for the string that you specify in\n\t\t\t\t\t\tSearchString.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n HTTPS_STR_MATCH: Route 53 tries to establish\n\t\t\t\t\ta TCP connection. If successful, Route 53 submits an HTTPS request\n\t\t\t\t\tand searches the first 5,120 bytes of the response body for the string that you\n\t\t\t\t\tspecify in SearchString.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n TCP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n CLOUDWATCH_METRIC: The health check is\n\t\t\t\t\tassociated with a CloudWatch alarm. If the state of the alarm is\n\t\t\t\t\tOK, the health check is considered healthy. If the state is\n\t\t\t\t\t\tALARM, the health check is considered unhealthy. If CloudWatch\n\t\t\t\t\tdoesn't have sufficient data to determine whether the state is OK\n\t\t\t\t\tor ALARM, the health check status depends on the setting for\n\t\t\t\t\t\tInsufficientDataHealthStatus: Healthy,\n\t\t\t\t\t\tUnhealthy, or LastKnownStatus.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n CALCULATED: For health checks that monitor\n\t\t\t\t\tthe status of other health checks, Route 53 adds up the number of health checks\n\t\t\t\t\tthat Route 53 health checkers consider to be healthy and compares that number\n\t\t\t\t\twith the value of HealthThreshold.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n RECOVERY_CONTROL: The health check is\n\t\t\t\t\tassocated with a Route53 Application Recovery Controller routing control. If the\n\t\t\t\t\trouting control state is ON, the health check is considered\n\t\t\t\t\thealthy. If the state is OFF, the health check is considered\n\t\t\t\t\tunhealthy.

    \n\t\t\t
    • \n
\n\t\t

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

", "smithy.api#required": {} } }, "ResourcePath": { "target": "com.amazonaws.route53#ResourcePath", "traits": { - "smithy.api#documentation": "

The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint \n\t\t\twill return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. \n\t\t\tYou can also include query string parameters, for example, /welcome.html?language=jp&login=y. \n\t\t

" + "smithy.api#documentation": "

The path, if any, that you want Amazon Route 53 to request when performing health\n\t\t\tchecks. The path can be any value for which your endpoint will return an HTTP status\n\t\t\tcode of 2xx or 3xx when the endpoint is healthy, for example, the file\n\t\t\t/docs/route53-health-check.html. You can also include query string parameters, for\n\t\t\texample, /welcome.html?language=jp&login=y.

" } }, "FullyQualifiedDomainName": { "target": "com.amazonaws.route53#FullyQualifiedDomainName", "traits": { - "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

\n\t\t\n\t\t

\n If you specify a value for \n IPAddress:

\n\t\t

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName \n\t\t\tin the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint \n\t\t\ton which you want Route 53 to perform health checks.

\n\t\t

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify another value for Port and any value except TCP for Type, Route 53 passes \n\t\t\t\t\tFullyQualifiedDomainName:Port to the endpoint in the Host header.

    \n\t\t\t
    • \n
\n\t\t

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the \n\t\t\tHost header in each of the preceding cases.

\n\t\t\n\t\t

\n If you don't specify a value for \n IPAddress:

\n\t\t

Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for \n\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

\n\t\t \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's \n\t\t\tno resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \n\t\t\t\"DNS resolution failed\" error.

\n \n\t\t

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by \n\t\t\tFullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a \n\t\t\thealth check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, \n\t\t\tspecify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

\n\t\t \n\t\t\t

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the \n\t\t\t\tresource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

\n\t\t \n\t\t

In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or \n\t\t\tHTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you \n\t\t\tspecify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

" + "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n\t\t

\n If you specify a value for\n\t\t\t IPAddress:

\n\t\t

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and\n\t\t\tpasses the value of FullyQualifiedDomainName in the Host\n\t\t\theader for all health checks except TCP health checks. This is typically the fully\n\t\t\tqualified DNS name of the endpoint on which you want Route 53 to perform health\n\t\t\tchecks.

\n\t\t

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a value of 80 for Port and\n\t\t\t\t\t\tHTTP or HTTP_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify a value of 443 for Port and\n\t\t\t\t\t\tHTTPS or HTTPS_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify another value for Port and any value except\n\t\t\t\t\t\tTCP for Type, Route 53 passes\n\t\t\t\t\t\tFullyQualifiedDomainName:Port to the endpoint in the\n\t\t\t\t\t\tHost header.

    \n\t\t\t
    • \n
\n\t\t

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the preceding cases.

\n\t\t

\n If you don't specify a value for\n\t\t\t IPAddress:

\n\t\t

Route 53 sends a DNS request to the domain that you specify for\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify for\n\t\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then\n\t\t\tchecks the health of the endpoint.

\n\t\t \n\t\t\t

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n\t\t \n\t\t

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record sets\n\t\t\t(www.example.com).

\n\t\t \n\t\t\t

In this configuration, if you create a health check for which the value of\n\t\t\t\t\tFullyQualifiedDomainName matches the name of the resource record\n\t\t\t\tsets and you then associate the health check with those resource record sets, health\n\t\t\t\tcheck results will be unpredictable.

\n\t\t \n\t\t

In addition, if the value that you specify for Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" } }, "SearchString": { "target": "com.amazonaws.route53#SearchString", "traits": { - "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the \n\t\t\tresponse body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.

\n\t\t

Route 53 considers case when searching for SearchString in the response body.

" + "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH,\n\t\t\tthe string that you want Amazon Route 53 to search for in the response body from the\n\t\t\tspecified resource. If the string appears in the response body, Route 53 considers the\n\t\t\tresource healthy.

\n\t\t

Route 53 considers case when searching for SearchString in the response\n\t\t\tbody.

" } }, "RequestInterval": { "target": "com.amazonaws.route53#RequestInterval", "traits": { - "smithy.api#documentation": "

The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next \n\t\t\thealth check request. Each Route 53 health checker makes requests at this interval.

\n\t\t \n\t\t\t

You can't change the value of RequestInterval after you create a health check.

\n\t\t \n\t\t

If you don't specify a value for RequestInterval, the default value is 30 seconds.

" + "smithy.api#documentation": "

The number of seconds between the time that Amazon Route 53 gets a response from your\n\t\t\tendpoint and the time that it sends the next health check request. Each Route 53 health\n\t\t\tchecker makes requests at this interval.

\n\t\t \n\t\t\t

You can't change the value of RequestInterval after you create a\n\t\t\t\thealth check.

\n\t\t \n\t\t

If you don't specify a value for RequestInterval, the default value is\n\t\t\t\t30 seconds.

" } }, "FailureThreshold": { "target": "com.amazonaws.route53#FailureThreshold", "traits": { - "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint \n\t\t\tfrom unhealthy to healthy or vice versa. For more information, see \n\t\t\tHow Amazon Route 53 Determines Whether an Endpoint Is Healthy \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

If you don't specify a value for FailureThreshold, the default value is three health checks.

" + "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" } }, "MeasureLatency": { "target": "com.amazonaws.route53#MeasureLatency", "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon Web Services regions and your endpoint, and to \n\t\t\tdisplay CloudWatch latency graphs on the Health Checks page in the Route 53 console.

\n\t\t \n\t\t\t

You can't change the value of MeasureLatency after you create a health check.

\n\t\t " + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to measure the latency between health\n\t\t\tcheckers in multiple Amazon Web Services regions and your endpoint, and to display\n\t\t\tCloudWatch latency graphs on the Health Checks page in\n\t\t\tthe Route 53 console.

\n\t\t \n\t\t\t

You can't change the value of MeasureLatency after you create a\n\t\t\t\thealth check.

\n\t\t " } }, "Inverted": { "target": "com.amazonaws.route53#Inverted", "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it \n\t\t\totherwise would be considered healthy.

" + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" } }, "Disabled": { "target": "com.amazonaws.route53#Disabled", "traits": { - "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

\n\t\t
    \n
  • \n

    \n Health checks that check the health of endpoints: \n\t\t\t\tRoute 53 stops submitting requests to your application, server, or other resource.

    \n
    • \n
  • \n

    \n Calculated health checks: \n\t\t\t\tRoute 53 stops aggregating the status of the referenced health checks.

    \n
    • \n
  • \n

    \n Health checks that monitor CloudWatch alarms: \n\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

    \n
    • \n
\n\t\t\n\t\t

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, \n\t\t\tRoute 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of \n\t\t\tInverted.\n\t\t

\n\t\t\n\t\t

Charges for a health check still apply when the health check is disabled. For more information, see \n\t\t\tAmazon Route 53 Pricing.

" + "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Health checks that check the health of\n\t\t\t\t\t\tendpoints: Route 53 stops submitting requests to your\n\t\t\t\t\tapplication, server, or other resource.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Calculated health checks: Route 53 stops\n\t\t\t\t\taggregating the status of the referenced health checks.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Health checks that monitor CloudWatch alarms:\n\t\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

    \n\t\t\t
    • \n
\n\t\t

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n\t\t

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" } }, "HealthThreshold": { "target": "com.amazonaws.route53#HealthThreshold", "traits": { - "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the \n\t\t\tCALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a \n\t\t\tCALCULATED health check, use the \n\t\t\tChildHealthChecks \n\t\t\telement.

\n\t\t

Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify 0, Route 53 always considers this health check to be healthy.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth check that Amazon Route 53 must consider healthy for the CALCULATED\n\t\t\thealth check to be considered healthy. To specify the child health checks that you want\n\t\t\tto associate with a CALCULATED health check, use the ChildHealthChecks element.

\n\t\t

Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a number greater than the number of child health checks, Route\n\t\t\t\t\t53 always considers this health check to be unhealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify 0, Route 53 always considers this health check to\n\t\t\t\t\tbe healthy.

    \n\t\t\t
    • \n
" } }, "ChildHealthChecks": { "target": "com.amazonaws.route53#ChildHealthCheckList", "traits": { - "smithy.api#documentation": "

(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that \n\t\t\tyou want to associate with a CALCULATED health check.

" + "smithy.api#documentation": "

(CALCULATED Health Checks Only) A complex type that contains one\n\t\t\t\tChildHealthCheck element for each health check that you want to\n\t\t\tassociate with a CALCULATED health check.

" } }, "EnableSNI": { "target": "com.amazonaws.route53#EnableSNI", "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello\n\t\t\tmessage during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable \n\t\t\tSSL/TLS certificate.

\n\t\t

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't \n\t\t\tenable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for \n\t\t\tother reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that \n\t\t\tyour certificate is valid.

\n\t\t

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the \n\t\t\tSubject Alternative Names field. One of the domain names in the certificate should match the value that you specify for \n\t\t\tFullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not \n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the \n\t\t\tsecond attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

" + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows the endpoint\n\t\t\tto respond to HTTPS health check requests with the applicable SSL/TLS\n\t\t\tcertificate.

\n\t\t

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n\t\t

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" } }, "Regions": { "target": "com.amazonaws.route53#HealthCheckRegionList", "traits": { - "smithy.api#documentation": "

A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the \n\t\t\tspecified endpoint.

\n\t\t

If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under \n\t\t\tValid Values.

\n\t\t

If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks \n\t\t\tfrom that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with \n\t\t\tfour different regions).

" + "smithy.api#documentation": "

A complex type that contains one Region element for each region from\n\t\t\twhich you want Amazon Route 53 health checkers to check the specified endpoint.

\n\t\t

If you don't specify any regions, Route 53 health checkers automatically performs\n\t\t\tchecks from all of the regions that are listed under Valid\n\t\t\t\tValues.

\n\t\t

If you update a health check to remove a region that has been performing health\n\t\t\tchecks, Route 53 will briefly continue to perform checks from that region to ensure that\n\t\t\tsome health checkers are always checking the endpoint (for example, if you replace three\n\t\t\tregions with four different regions).

" } }, "AlarmIdentifier": { "target": "com.amazonaws.route53#AlarmIdentifier", "traits": { - "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether \n\t\t\tthe specified health check is healthy.

" + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" } }, "InsufficientDataHealthStatus": { "target": "com.amazonaws.route53#InsufficientDataHealthStatus", "traits": { - "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Healthy: Route 53 considers the health check to be healthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Unhealthy: Route 53 considers the health check to be unhealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data \n\t\t\t\t\tto determine the alarm state. For new health checks that have no last known status, the default status for the health check is \n\t\t\t\t\thealthy.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Healthy: Route 53 considers the health check to be\n\t\t\t\t\thealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Unhealthy: Route 53 considers the health check to be\n\t\t\t\t\tunhealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n LastKnownStatus: Route 53 uses the status of the health check\n\t\t\t\t\tfrom the last time that CloudWatch had sufficient data to determine the alarm\n\t\t\t\t\tstate. For new health checks that have no last known status, the default status\n\t\t\t\t\tfor the health check is healthy.

    \n\t\t\t
    • \n
" } }, "RoutingControlArn": { "target": "com.amazonaws.route53#RoutingControlArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

\n\t\t

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller\n\t\t\trouting control.

\n\t\t

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

" } } }, @@ -4309,24 +4836,24 @@ "Region": { "target": "com.amazonaws.route53#HealthCheckRegion", "traits": { - "smithy.api#documentation": "

The region of the Amazon Route 53 health checker that provided the status in StatusReport.

" + "smithy.api#documentation": "

The region of the Amazon Route 53 health checker that provided the status in\n\t\t\t\tStatusReport.

" } }, "IPAddress": { "target": "com.amazonaws.route53#IPAddress", "traits": { - "smithy.api#documentation": "

The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport.

" + "smithy.api#documentation": "

The IP address of the Amazon Route 53 health checker that provided the failure reason\n\t\t\tin StatusReport.

" } }, "StatusReport": { "target": "com.amazonaws.route53#StatusReport", "traits": { - "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.

" + "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker and the time of the failed health check.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker.

" + "smithy.api#documentation": "

A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker.

" } }, "com.amazonaws.route53#HealthCheckObservations": { @@ -4452,7 +4979,7 @@ } }, "traits": { - "smithy.api#documentation": "

The value of HealthCheckVersion in the request doesn't match the value of HealthCheckVersion \n\t\t\tin the health check.

", + "smithy.api#documentation": "

The value of HealthCheckVersion in the request doesn't match the value of\n\t\t\t\tHealthCheckVersion in the health check.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -4489,7 +5016,7 @@ "Name": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

The name of the domain. For public hosted zones, this is the name that you have\n\t\t\tregistered with your DNS registrar.

\n\t\t

For information about how to specify characters other than a-z,\n\t\t\t0-9, and - (hyphen) and how to specify internationalized domain names, see \n\t\t\tCreateHostedZone.

", + "smithy.api#documentation": "

The name of the domain. For public hosted zones, this is the name that you have\n\t\t\tregistered with your DNS registrar.

\n\t\t

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see CreateHostedZone.

", "smithy.api#required": {} } }, @@ -4503,7 +5030,7 @@ "Config": { "target": "com.amazonaws.route53#HostedZoneConfig", "traits": { - "smithy.api#documentation": "

A complex type that includes the Comment and PrivateZone\n\t\t\telements. If you omitted the HostedZoneConfig and Comment elements\n\t\t\tfrom the request, the Config and Comment elements don't appear in\n\t\t\tthe response.

" + "smithy.api#documentation": "

A complex type that includes the Comment and PrivateZone\n\t\t\telements. If you omitted the HostedZoneConfig and Comment\n\t\t\telements from the request, the Config and Comment elements\n\t\t\tdon't appear in the response.

" } }, "ResourceRecordSetCount": { @@ -4515,7 +5042,7 @@ "LinkedService": { "target": "com.amazonaws.route53#LinkedService", "traits": { - "smithy.api#documentation": "

If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created \n\t\t\tby another service, you can't edit or delete it using Route 53.

" + "smithy.api#documentation": "

If the hosted zone was created by another service, the service that created the hosted\n\t\t\tzone. When a hosted zone is created by another service, you can't edit or delete it\n\t\t\tusing Route 53.

" } } }, @@ -4534,7 +5061,7 @@ } }, "traits": { - "smithy.api#documentation": "

The hosted zone you're trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created \n\t\t\twith the specified CallerReference.

", + "smithy.api#documentation": "

The hosted zone you're trying to create already exists. Amazon Route 53 returns this\n\t\t\terror when a hosted zone has already been created with the specified\n\t\t\t\tCallerReference.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -4556,7 +5083,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains an optional comment about your hosted zone. If you don't\n\t\t\twant to specify a comment, omit both the HostedZoneConfig and\n\t\t\tComment elements.

" + "smithy.api#documentation": "

A complex type that contains an optional comment about your hosted zone. If you don't\n\t\t\twant to specify a comment, omit both the HostedZoneConfig and\n\t\t\t\tComment elements.

" } }, "com.amazonaws.route53#HostedZoneCount": { @@ -4571,7 +5098,7 @@ "Type": { "target": "com.amazonaws.route53#HostedZoneLimitType", "traits": { - "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n\t\t
    \n
  • \n

    \n MAX_RRSETS_BY_ZONE: The maximum number of records that you can create \n\t\t\t\tin the specified hosted zone.

    \n
    • \n
  • \n

    \n MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can \n\t\t\t\tassociate with the specified private hosted zone.

    \n
    • \n
", + "smithy.api#documentation": "

The limit that you requested. Valid values include the following:

\n\t\t
    \n
  • \n\t\t\t\t

    \n MAX_RRSETS_BY_ZONE: The maximum number of\n\t\t\t\t\trecords that you can create in the specified hosted zone.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum\n\t\t\t\t\tnumber of Amazon VPCs that you can associate with the specified private hosted\n\t\t\t\t\tzone.

    \n\t\t\t
    • \n
", "smithy.api#required": {} } }, @@ -4584,7 +5111,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and the current value for that limit.

" + "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" } }, "com.amazonaws.route53#HostedZoneLimitType": { @@ -4654,18 +5181,18 @@ "OwningAccount": { "target": "com.amazonaws.route53#AWSAccountID", "traits": { - "smithy.api#documentation": "

If the hosted zone was created by an Amazon Web Services account, or was created by an Amazon Web Services service that creates hosted zones using the current account, \n\t\t\tOwningAccount contains the account ID of that account. For example, when you use Cloud Map to create a hosted zone, Cloud Map \n\t\t\tcreates the hosted zone using the current Amazon Web Services account.

" + "smithy.api#documentation": "

If the hosted zone was created by an Amazon Web Services account, or was created by an\n\t\t\t\tAmazon Web Services service that creates hosted zones using the current account,\n\t\t\t\tOwningAccount contains the account ID of that account. For example,\n\t\t\twhen you use Cloud Map to create a hosted zone, Cloud Map creates the hosted\n\t\t\tzone using the current Amazon Web Services account.

" } }, "OwningService": { "target": "com.amazonaws.route53#HostedZoneOwningService", "traits": { - "smithy.api#documentation": "

If an Amazon Web Services service uses its own account to create a hosted zone and associate the specified VPC with that hosted zone, OwningService \n\t\t\tcontains an abbreviation that identifies the service. For example, if Amazon Elastic File System (Amazon EFS) created a hosted zone and \n\t\t\tassociated a VPC with the hosted zone, the value of OwningService is efs.amazonaws.com.

" + "smithy.api#documentation": "

If an Amazon Web Services service uses its own account to create a hosted zone and\n\t\t\tassociate the specified VPC with that hosted zone, OwningService contains\n\t\t\tan abbreviation that identifies the service. For example, if Amazon Elastic File System\n\t\t\t(Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value\n\t\t\tof OwningService is efs.amazonaws.com.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that identifies a hosted zone that a specified Amazon VPC is associated with and the owner of the hosted zone. \n\t\t\tIf there is a value for OwningAccount, there is no value for OwningService, and vice versa.

" + "smithy.api#documentation": "

A complex type that identifies a hosted zone that a specified Amazon VPC is associated\n\t\t\twith and the owner of the hosted zone. If there is a value for\n\t\t\t\tOwningAccount, there is no value for OwningService, and\n\t\t\tvice versa.

" } }, "com.amazonaws.route53#HostedZoneOwningService": { @@ -4685,7 +5212,7 @@ } }, "traits": { - "smithy.api#documentation": "

The hosted zone nameservers don't match the parent nameservers. The hosted zone and parent must have the same nameservers.

", + "smithy.api#documentation": "

The hosted zone nameservers don't match the parent nameservers. The hosted zone and\n\t\t\tparent must have the same nameservers.

", "smithy.api#error": "client" } }, @@ -4710,7 +5237,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The Route 53 hosted zone ID of a private hosted zone that the specified VPC is associated with.

", + "smithy.api#documentation": "

The Route 53 hosted zone ID of a private hosted zone that the specified VPC is\n\t\t\tassociated with.

", "smithy.api#required": {} } }, @@ -4724,13 +5251,13 @@ "Owner": { "target": "com.amazonaws.route53#HostedZoneOwner", "traits": { - "smithy.api#documentation": "

The owner of a private hosted zone that the specified VPC is associated with. The owner can be either an Amazon Web Services account or \n\t\t\tan Amazon Web Services service.

", + "smithy.api#documentation": "

The owner of a private hosted zone that the specified VPC is associated with. The\n\t\t\towner can be either an Amazon Web Services account or an Amazon Web Services\n\t\t\tservice.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

In the response to a ListHostedZonesByVPC request, the HostedZoneSummaries element contains one \n\t\t\tHostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. \n\t\t\tEach HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

" + "smithy.api#documentation": "

In the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.

" } }, "com.amazonaws.route53#HostedZones": { @@ -4763,7 +5290,7 @@ } }, "traits": { - "smithy.api#documentation": "

The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.

", + "smithy.api#documentation": "

The resource you're trying to access is unsupported on this Amazon Route 53\n\t\t\tendpoint.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4776,7 +5303,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon Route 53 doesn't have the permissions required to create log streams and send query logs to log streams. Possible causes \n\t\t\tinclude the following:

\n\t\t
    \n
  • \n

    There is no resource policy that specifies the log group ARN in the value for Resource.

    \n
    • \n
  • \n

    The resource policy that includes the log group ARN in the value for Resource doesn't have the \n\t\t\t\tnecessary permissions.

    \n
    • \n
  • \n

    The resource policy hasn't finished propagating yet.

    \n
    • \n
  • \n

    The Key management service (KMS) key you specified doesn’t exist or it can’t be used with the \n\t\t\t\tlog group associated with query log. Update or provide a resource policy to grant permissions for the KMS key.

    \n
    • \n
", + "smithy.api#documentation": "

Amazon Route 53 doesn't have the permissions required to create log streams and send\n\t\t\tquery logs to log streams. Possible causes include the following:

\n\t\t
    \n
  • \n\t\t\t\t

    There is no resource policy that specifies the log group ARN in the value for\n\t\t\t\t\t\tResource.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The resource policy that includes the log group ARN in the value for\n\t\t\t\t\t\tResource doesn't have the necessary permissions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The resource policy hasn't finished propagating yet.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The Key management service (KMS) key you specified doesn’t exist or it can’t\n\t\t\t\t\tbe used with the log group associated with query log. Update or provide a\n\t\t\t\t\tresource policy to grant permissions for the KMS key.

    \n\t\t\t
    • \n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4829,7 +5356,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception contains a list of messages that might contain one or more error messages. Each error message indicates \n\t\t\tone error in the change batch.

", + "smithy.api#documentation": "

This exception contains a list of messages that might contain one or more error\n\t\t\tmessages. Each error message indicates one error in the change batch.

", "smithy.api#error": "client" } }, @@ -4873,7 +5400,7 @@ } }, "traits": { - "smithy.api#documentation": "

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.

", + "smithy.api#documentation": "

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC\n\t\t\tsigning.

", "smithy.api#error": "client" } }, @@ -4898,7 +5425,7 @@ } }, "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) status isn't valid or another KSK has the status INTERNAL_FAILURE.

", + "smithy.api#documentation": "

The key-signing key (KSK) status isn't valid or another KSK has the status\n\t\t\t\tINTERNAL_FAILURE.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4911,7 +5438,7 @@ } }, "traits": { - "smithy.api#documentation": "

The value that you specified to get the second or subsequent page of results is invalid.

", + "smithy.api#documentation": "

The value that you specified to get the second or subsequent page of results is\n\t\t\tinvalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4924,7 +5451,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your hosted zone status isn't valid for this operation. In the hosted zone, change the status to enable DNSSEC \n\t\t\tor disable DNSSEC.

", + "smithy.api#documentation": "

Your hosted zone status isn't valid for this operation. In the hosted zone, change the\n\t\t\tstatus to enable DNSSEC or disable DNSSEC.

", "smithy.api#error": "client" } }, @@ -4939,7 +5466,7 @@ } }, "traits": { - "smithy.api#documentation": "

The format of the traffic policy document that you specified in the Document element is not valid.

", + "smithy.api#documentation": "

The format of the traffic policy document that you specified in the\n\t\t\t\tDocument element is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4955,7 +5482,7 @@ } }, "traits": { - "smithy.api#documentation": "

The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.

", + "smithy.api#documentation": "

The VPC ID that you specified either isn't a valid ID or the current account is not\n\t\t\tauthorized to access this VPC.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4975,61 +5502,61 @@ "Name": { "target": "com.amazonaws.route53#SigningKeyName", "traits": { - "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same \n\t\t\thosted zone.

" + "smithy.api#documentation": "

A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.

" } }, "KmsArn": { "target": "com.amazonaws.route53#SigningKeyString", "traits": { - "smithy.api#documentation": "

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS).\n\t\t\tThe KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.

\n\t\t

You must configure the customer managed key as follows:

\n\t\t
\n
Status
\n
\n

Enabled

\n
\n
Key spec
\n
\n

ECC_NIST_P256

\n
\n
Key usage
\n
\n

Sign and verify

\n
\n
Key policy
\n
\n

The key policy must give permission for the following actions:

\n\t\t\t\t
    \n
  • \n

    DescribeKey

    \n
    • \n
  • \n

    GetPublicKey

    \n
    • \n
  • \n

    Sign

    \n
    • \n
\n\t\t\t\t\t

The key policy must also include the Amazon Route 53 service in the principal for your account. \n\t\t\t\t\t\tSpecify the following:

\n\t\t\t\t\t
    \n
  • \n

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n
    • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with the customer managed key in KMS, see \n\t\t\tKey Management Service concepts.

" + "smithy.api#documentation": "

The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each\n\t\t\tkey-signing key (KSK) in a single hosted zone.

\n\t\t

You must configure the customer managed key as follows:

\n\t\t
\n
Status
\n
\n\t\t\t\t\t

Enabled

\n\t\t\t\t
\n
Key spec
\n
\n\t\t\t\t\t

ECC_NIST_P256

\n\t\t\t\t
\n
Key usage
\n
\n\t\t\t\t\t

Sign and verify

\n\t\t\t\t
\n
Key policy
\n
\n\t\t\t\t\t

The key policy must give permission for the following actions:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    DescribeKey

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    GetPublicKey

    \n\t\t\t\t\t\t
    • \n
  • \n\t\t\t\t\t\t\t

    Sign

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t\t

The key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:

\n\t\t\t\t\t
    \n
  • \n\t\t\t\t\t\t\t

    \n \"Service\": \"dnssec-route53.amazonaws.com\"\n

    \n\t\t\t\t\t\t
    • \n
\n\t\t\t\t
\n
\n\t\t

For more information about working with the customer managed key in KMS, see Key Management Service\n\t\t\t\tconcepts.

" } }, "Flag": { "target": "com.amazonaws.route53#SigningKeyInteger", "traits": { - "smithy.api#documentation": "

An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.

" + "smithy.api#documentation": "

An integer that specifies how the key is used. For key-signing key (KSK), this value\n\t\t\tis always 257.

" } }, "SigningAlgorithmMnemonic": { "target": "com.amazonaws.route53#SigningKeyString", "traits": { - "smithy.api#documentation": "

A string used to represent the signing algorithm. This value must follow the guidelines provided by\n\t\t\tRFC-8624 Section 3.1.\n\t\t

" + "smithy.api#documentation": "

A string used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" } }, "SigningAlgorithmType": { "target": "com.amazonaws.route53#SigningKeyInteger", "traits": { - "smithy.api#documentation": "

An integer used to represent the signing algorithm. This value must follow the guidelines provided by\n\t\t\tRFC-8624 Section 3.1.\n\t\t

" + "smithy.api#documentation": "

An integer used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.

" } }, "DigestAlgorithmMnemonic": { "target": "com.amazonaws.route53#SigningKeyString", "traits": { - "smithy.api#documentation": "

A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by\n\t\t\tRFC-8624 Section 3.3.\n\t\t

" + "smithy.api#documentation": "

A string used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section 3.3.\n\t\t

" } }, "DigestAlgorithmType": { "target": "com.amazonaws.route53#SigningKeyInteger", "traits": { - "smithy.api#documentation": "

An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by\n\t\t\tRFC-8624 Section 3.3.

" + "smithy.api#documentation": "

An integer used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section\n\t\t\t3.3.

" } }, "KeyTag": { "target": "com.amazonaws.route53#SigningKeyTag", "traits": { - "smithy.api#documentation": "

An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in\n\t\t\tRFC-4034 Appendix B.

" + "smithy.api#documentation": "

An integer used to identify the DNSSEC record for the domain name. The process used to\n\t\t\tcalculate the value is described in RFC-4034 Appendix B.

" } }, "DigestValue": { "target": "com.amazonaws.route53#SigningKeyString", "traits": { - "smithy.api#documentation": "

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers \n\t\t\tcan use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.

" + "smithy.api#documentation": "

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to\n\t\t\tpublish the public key that resolvers can use to verify DNSSEC signatures that are used\n\t\t\tto secure certain kinds of information provided by the DNS system.

" } }, "PublicKey": { "target": "com.amazonaws.route53#SigningKeyString", "traits": { - "smithy.api#documentation": "

The public key, represented as a Base64 encoding, as required by \n\t\t\tRFC-4034 Page 5.

" + "smithy.api#documentation": "

The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

" } }, "DSRecord": { @@ -5047,13 +5574,13 @@ "Status": { "target": "com.amazonaws.route53#SigningKeyStatus", "traits": { - "smithy.api#documentation": "

A string that represents the current key-signing key (KSK) status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
ACTIVE
\n
\n

The KSK is being used for signing.

\n
\n
INACTIVE
\n
\n

The KSK is not being used for signing.

\n
\n
DELETING
\n
\n

The KSK is in the process of being deleted.

\n
\n
ACTION_NEEDED
\n
\n

There is a problem with the KSK that requires you to take action to resolve.\n\t\t\t\t\tFor example, the customer managed key might have been deleted, or the\n\t\t\t\t\tpermissions for the customer managed key might have been changed.

\n
\n
INTERNAL_FAILURE
\n
\n

There was an error during a request. Before you can continue to work with DNSSEC\n\t\t\t\t\tsigning, including actions that involve this KSK, you must correct the problem. For example,\n\t\t\t\t\tyou may need to activate or deactivate the KSK.

\n
\n
" + "smithy.api#documentation": "

A string that represents the current key-signing key (KSK) status.

\n\t\t

Status can have one of the following values:

\n\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

The KSK is being used for signing.

\n\t\t\t\t
\n
INACTIVE
\n
\n\t\t\t\t\t

The KSK is not being used for signing.

\n\t\t\t\t
\n
DELETING
\n
\n\t\t\t\t\t

The KSK is in the process of being deleted.

\n\t\t\t\t
\n
ACTION_NEEDED
\n
\n\t\t\t\t\t

There is a problem with the KSK that requires you to take action to\n\t\t\t\t\t\tresolve. For example, the customer managed key might have been deleted,\n\t\t\t\t\t\tor the permissions for the customer managed key might have been\n\t\t\t\t\t\tchanged.

\n\t\t\t\t
\n
INTERNAL_FAILURE
\n
\n\t\t\t\t\t

There was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including actions that involve this KSK, you must correct\n\t\t\t\t\t\tthe problem. For example, you may need to activate or deactivate the\n\t\t\t\t\t\tKSK.

\n\t\t\t\t
\n
" } }, "StatusMessage": { "target": "com.amazonaws.route53#SigningKeyStatusMessage", "traits": { - "smithy.api#documentation": "

The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or \n\t\t\tINTERNAL_FAILURE. The status message includes information about what the problem might be and steps \n\t\t\tthat you can take to correct the issue.

" + "smithy.api#documentation": "

The status message provided for the following key-signing key (KSK) statuses:\n\t\t\t\tACTION_NEEDED or INTERNAL_FAILURE. The status message\n\t\t\tincludes information about what the problem might be and steps that you can take to\n\t\t\tcorrect the issue.

" } }, "CreatedDate": { @@ -5070,7 +5597,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key-signing key (KSK) is a complex type that represents a public/private key pair. The private key is used to generate\n\t\ta digital signature for the zone signing key (ZSK). The public key is stored in the DNS and is used to authenticate the ZSK. \n\t\tA KSK is always associated with a hosted zone; it cannot exist by itself.

" + "smithy.api#documentation": "

A key-signing key (KSK) is a complex type that represents a public/private key pair.\n\t\t\tThe private key is used to generate a digital signature for the zone signing key (ZSK).\n\t\t\tThe public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always\n\t\t\tassociated with a hosted zone; it cannot exist by itself.

" } }, "com.amazonaws.route53#KeySigningKeyAlreadyExists": { @@ -5107,7 +5634,7 @@ } }, "traits": { - "smithy.api#documentation": "

The key-signing key (KSK) that you specified can't be deactivated because it's the only KSK for a\n\t\tcurrently-enabled DNSSEC. Disable DNSSEC signing, or add or enable another KSK.

", + "smithy.api#documentation": "

The key-signing key (KSK) that you specified can't be deactivated because it's the\n\t\t\tonly KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable\n\t\t\tanother KSK.

", "smithy.api#error": "client" } }, @@ -5140,7 +5667,7 @@ } }, "traits": { - "smithy.api#documentation": "

The VPC that you're trying to disassociate from the private hosted zone is the last VPC that is associated with \n\t\t\tthe hosted zone. Amazon Route 53 doesn't support disassociating the last VPC from a hosted zone.

", + "smithy.api#documentation": "

The VPC that you're trying to disassociate from the private hosted zone is the last\n\t\t\tVPC that is associated with the hosted zone. Amazon Route 53 doesn't support\n\t\t\tdisassociating the last VPC from a hosted zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -5164,7 +5691,7 @@ } }, "traits": { - "smithy.api#documentation": "

This operation can't be completed either because the current account has reached the limit on reusable delegation sets \n\t\t\tthat it can create or because you've reached the limit on the number of Amazon VPCs that you can associate with a private hosted zone. \n\t\t\tTo get the current limit on the number of reusable delegation sets, see \n\t\t\tGetAccountLimit.\n\t\t\tTo get the current limit on the number of Amazon VPCs that you can associate with a private hosted zone, see \n\t\t\tGetHostedZoneLimit.\n\t\t\tTo request a higher limit, create a case with the Amazon Web Services Support Center.

", + "smithy.api#documentation": "

This operation can't be completed because the current account has reached the\n\t\t\tlimit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", "smithy.api#error": "client" } }, @@ -5174,18 +5701,242 @@ "ServicePrincipal": { "target": "com.amazonaws.route53#ServicePrincipal", "traits": { - "smithy.api#documentation": "

If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created \n\t\t\tby another service, you can't edit or delete it using Amazon Route 53.

" + "smithy.api#documentation": "

If the health check or hosted zone was created by another service, the service that\n\t\t\tcreated the resource. When a resource is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.

" } }, "Description": { "target": "com.amazonaws.route53#ResourceDescription", "traits": { - "smithy.api#documentation": "

If the health check or hosted zone was created by another service, an optional description that can be provided by the other service.\n\t\t\tWhen a resource is created by another service, you can't edit or delete it using Amazon Route 53.

" + "smithy.api#documentation": "

If the health check or hosted zone was created by another service, an optional\n\t\t\tdescription that can be provided by the other service. When a resource is created by\n\t\t\tanother service, you can't edit or delete it using Amazon Route 53.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

If a health check or hosted zone was created by another service,\n\t\t\t\tLinkedService is a complex type that describes the service that created\n\t\t\tthe resource. When a resource is created by another service, you can't edit or delete it\n\t\t\tusing Amazon Route 53.

" + } + }, + "com.amazonaws.route53#ListCidrBlocks": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrBlocksRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrBlocksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrLocationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of location objects and their CIDR blocks.

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection/{CollectionId}/cidrblocks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrBlocks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrBlocksRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The UUID of the CIDR collection.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "

The name of the CIDR collection location.

", + "smithy.api#httpQuery": "location" + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Maximum number of results you want returned.

", + "smithy.api#httpQuery": "maxresults" + } + } + } + }, + "com.amazonaws.route53#ListCidrBlocksResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrBlocks": { + "target": "com.amazonaws.route53#CidrBlockSummaries", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR blocks.

" + } + } + } + }, + "com.amazonaws.route53#ListCidrCollections": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrCollectionsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrCollectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a paginated list of CIDR collections in the Amazon Web Services account\n\t\t\t(metadata only).

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrCollections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrCollectionsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of CIDR collections to return in the response.

", + "smithy.api#httpQuery": "maxresults" + } + } + } + }, + "com.amazonaws.route53#ListCidrCollectionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrCollections": { + "target": "com.amazonaws.route53#CollectionSummaries", + "traits": { + "smithy.api#documentation": "

A complex type with information about the CIDR collection.

" } } + } + }, + "com.amazonaws.route53#ListCidrLocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrLocationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrLocationsResponse" }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], "traits": { - "smithy.api#documentation": "

If a health check or hosted zone was created by another service, LinkedService is a complex type that \n\t\t\tdescribes the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

" + "smithy.api#documentation": "

Returns a paginated list of CIDR locations for the given collection (metadata only,\n\t\t\tdoes not include CIDR blocks).

", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection/{CollectionId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrLocations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrLocationsRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "

The CIDR collection ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of CIDR collection locations to return in the response.

", + "smithy.api#httpQuery": "maxresults" + } + } + } + }, + "com.amazonaws.route53#ListCidrLocationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "

An opaque\n\t\t\tpagination token to indicate where the service is to begin enumerating results.

\n\t\t

If no value is provided, the listing of results starts from the beginning.

" + } + }, + "CidrLocations": { + "target": "com.amazonaws.route53#LocationSummaries", + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the list of CIDR locations.

" + } + } } }, "com.amazonaws.route53#ListGeoLocations": { @@ -5202,7 +5953,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of supported geographic locations.

\n\t\t

Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), \n\t\t\tthe subdivisions for that country are listed in alphabetical order immediately after the corresponding country.

\n\t

Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.

\n\t

For a list of supported geolocation codes, see the \n\t\t\tGeoLocation data type.

", + "smithy.api#documentation": "

Retrieves a list of supported geographic locations.

\n\t\t

Countries are listed first, and continents are listed last. If Amazon Route 53\n\t\t\tsupports subdivisions for a country (for example, states or provinces), the subdivisions\n\t\t\tfor that country are listed in alphabetical order immediately after the corresponding\n\t\t\tcountry.

\n\t\t

Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.

\n\t\t

For a list of supported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/geolocations", @@ -5216,34 +5967,34 @@ "StartContinentCode": { "target": "com.amazonaws.route53#GeoLocationContinentCode", "traits": { - "smithy.api#documentation": "

The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already \n\t\t\treturned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous \n\t\t\tresponse has a value, enter that value in startcontinentcode to return the next page of results.

\n\t\t

Include startcontinentcode only if you want to list continents. Don't include startcontinentcode \n\t\t\twhen you're listing countries or countries with their subdivisions.

", + "smithy.api#documentation": "

The code for the continent with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if NextContinentCode from\n\t\t\tthe previous response has a value, enter that value in startcontinentcode\n\t\t\tto return the next page of results.

\n\t\t

Include startcontinentcode only if you want to list continents. Don't\n\t\t\tinclude startcontinentcode when you're listing countries or countries with\n\t\t\ttheir subdivisions.

", "smithy.api#httpQuery": "startcontinentcode" } }, "StartCountryCode": { "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { - "smithy.api#documentation": "

The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already \n\t\t\treturned a page or more of results, if IsTruncated is true, and if NextCountryCode from the \n\t\t\tprevious response has a value, enter that value in startcountrycode to return the next page of results.

", + "smithy.api#documentation": "

The code for the country with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if\n\t\t\t\tNextCountryCode from the previous response has a value, enter that\n\t\t\tvalue in startcountrycode to return the next page of results.

", "smithy.api#httpQuery": "startcountrycode" } }, "StartSubdivisionCode": { "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", "traits": { - "smithy.api#documentation": "

The code for the state of the United States with which you want to start listing locations that Amazon Route 53 supports \n\t\t\tfor geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if\n\t\t\tNextSubdivisionCode from the previous response has a value, enter that value in startsubdivisioncode \n\t\t\tto return the next page of results.

\n\t\t

To list subdivisions (U.S. states), you must include both startcountrycode and startsubdivisioncode.

", + "smithy.api#documentation": "

The code for the state of the United States with which you want to start listing\n\t\t\tlocations that Amazon Route 53 supports for geolocation. If Route 53 has already\n\t\t\treturned a page or more of results, if IsTruncated is true,\n\t\t\tand if NextSubdivisionCode from the previous response has a value, enter\n\t\t\tthat value in startsubdivisioncode to return the next page of\n\t\t\tresults.

\n\t\t

To list subdivisions (U.S. states), you must include both\n\t\t\t\tstartcountrycode and startsubdivisioncode.

", "smithy.api#httpQuery": "startsubdivisioncode" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of geolocations to be included in the response body for this request. If more than maxitems \n\t\t\tgeolocations remain to be listed, then the value of the IsTruncated element in the response is true.

", + "smithy.api#documentation": "

(Optional) The maximum number of geolocations to be included in the response body for\n\t\t\tthis request. If more than maxitems geolocations remain to be listed, then\n\t\t\tthe value of the IsTruncated element in the response is\n\t\t\ttrue.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets.

" + "smithy.api#documentation": "

A request to get a list of geographic locations that Amazon Route 53 supports for\n\t\t\tgeolocation resource record sets.

" } }, "com.amazonaws.route53#ListGeoLocationsResponse": { @@ -5252,33 +6003,33 @@ "GeoLocationDetailsList": { "target": "com.amazonaws.route53#GeoLocationDetailsList", "traits": { - "smithy.api#documentation": "

A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.

", + "smithy.api#documentation": "

A complex type that contains one GeoLocationDetails element for each\n\t\t\tlocation that Amazon Route 53 supports for geolocation.

", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of \n\t\t\tIsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, \n\t\t\tNextCountryCode, and NextSubdivisionCode in the startcontinentcode, startcountrycode, and \n\t\t\tstartsubdivisioncode, as applicable.

", + "smithy.api#documentation": "

A value that indicates whether more locations remain to be listed after the last\n\t\t\tlocation in this response. If so, the value of IsTruncated is\n\t\t\t\ttrue. To get more values, submit another request and include the values\n\t\t\tof NextContinentCode, NextCountryCode, and\n\t\t\t\tNextSubdivisionCode in the startcontinentcode,\n\t\t\t\tstartcountrycode, and startsubdivisioncode, as\n\t\t\tapplicable.

", "smithy.api#required": {} } }, "NextContinentCode": { "target": "com.amazonaws.route53#GeoLocationContinentCode", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of \n\t\t\tNextContinentCode in the startcontinentcode parameter in another ListGeoLocations request.

" + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextContinentCode in the\n\t\t\t\tstartcontinentcode parameter in another ListGeoLocations\n\t\t\trequest.

" } }, "NextCountryCode": { "target": "com.amazonaws.route53#GeoLocationCountryCode", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of \n\t\t\tNextCountryCode in the startcountrycode parameter in another ListGeoLocations request.

" + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextCountryCode in the\n\t\t\t\tstartcountrycode parameter in another ListGeoLocations\n\t\t\trequest.

" } }, "NextSubdivisionCode": { "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of \n\t\t\tNextSubdivisionCode in the startsubdivisioncode parameter in another ListGeoLocations request.

" + "smithy.api#documentation": "

If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextSubdivisionCode in the\n\t\t\t\tstartsubdivisioncode parameter in another ListGeoLocations\n\t\t\trequest.

" } }, "MaxItems": { @@ -5330,20 +6081,20 @@ "Marker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, \n\t\t\tsubmit another ListHealthChecks request.

\n\t\t

For the value of marker, specify the value of NextMarker from the previous response, \n\t\t\twhich is the ID of the first health check that Amazon Route 53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more health checks to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more health checks. To get another group, submit another\n\t\t\t\tListHealthChecks request.

\n\t\t

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first health check that Amazon Route\n\t\t\t53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more health checks to get.

", "smithy.api#httpQuery": "marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of health checks that you want ListHealthChecks to return in response to the current request. \n\t\t\tAmazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks.

", + "smithy.api#documentation": "

The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 100\n\t\t\titems. If you set MaxItems to a value greater than 100, Route 53 returns\n\t\t\tonly the first 100 health checks.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

A request to retrieve a list of the health checks that are associated with the current Amazon Web Services account.

" + "smithy.api#documentation": "

A request to retrieve a list of the health checks that are associated with the current\n\t\t\t\tAmazon Web Services account.

" } }, "com.amazonaws.route53#ListHealthChecksResponse": { @@ -5352,40 +6103,40 @@ "HealthChecks": { "target": "com.amazonaws.route53#HealthChecks", "traits": { - "smithy.api#documentation": "

A complex type that contains one HealthCheck element for each health check that is associated with the current \n\t\t\tAmazon Web Services account.

", + "smithy.api#documentation": "

A complex type that contains one HealthCheck element for each health\n\t\t\tcheck that is associated with the current Amazon Web Services account.

", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the \n\t\t\tmarker parameter in the previous request.

", + "smithy.api#documentation": "

For the second and subsequent calls to ListHealthChecks,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the previous request.

", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of \n\t\t\thealth checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the \n\t\t\tmarker parameter.

", + "smithy.api#documentation": "

A flag that indicates whether there are more health checks to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of health checks by submitting\n\t\t\tanother ListHealthChecks request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", "smithy.api#required": {} } }, "NextMarker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker identifies the first health check that Amazon Route 53 \n\t\t\treturns if you submit another ListHealthChecks request and specify the value of NextMarker in \n\t\t\tthe marker parameter.

" + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first health check that Amazon Route 53 returns if you submit another\n\t\t\t\tListHealthChecks request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the \n\t\t\tcurrent response.

", + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHealthChecks that produced the current response.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a ListHealthChecks request.

" + "smithy.api#documentation": "

A complex type that contains the response to a ListHealthChecks\n\t\t\trequest.

" } }, "com.amazonaws.route53#ListHostedZones": { @@ -5408,7 +6159,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response \n\t\t\tincludes a HostedZones child element for each hosted zone.

\n\t\t

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the \n\t\t\tmaxitems parameter to list them in groups of up to 100.

", + "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account. The response includes a HostedZones\n\t\t\tchild element for each hosted zone.

\n\t\t

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of\n\t\t\thosted zones, you can use the maxitems parameter to list them in groups of\n\t\t\tup to 100.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzone", @@ -5439,7 +6190,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element \n\t\t\tfor each hosted zone created by the current Amazon Web Services account.

\n\t\t

\n ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

\n\n\t\t

\n com.example.www.\n

\n\n\t\t

Note the trailing dot, which can change the sort order in some circumstances.

\n\t\t

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name \n\t\t\tusing the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone \n\t\t\tfor exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

\n\n\t\t

\n com.ex\\344mple.\n

\n\t\t\n\t\t

The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, \n\t\t\tincluding internationalized domain names, see DNS Domain Name Format in the \n\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list \n\t\t\tthem in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

\n\t\t
    \n
  • \n\t\t\t\t

    The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the \n\t\t\t\t\tdnsname and hostedzoneid parameters in the request that produced the current response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The MaxItems element in the response contains the value, if any, that you specified for the maxitems \n\t\t\t\t\tparameter in the request that produced the current response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If the value of IsTruncated in the response is true, there are more hosted zones associated with the \n\t\t\t\t\tcurrent Amazon Web Services account.

    \n\t\t\t\t

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. \n\t\t\t\t\tThe NextDNSName element and NextHostedZoneId elements are omitted from the response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the \n\t\t\t\t\thosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, \n\t\t\t\t\tmake another call to ListHostedZonesByName, and specify the value of NextDNSName and \n\t\t\t\t\tNextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

    \n\t\t\t
    • \n
", + "smithy.api#documentation": "

Retrieves a list of your hosted zones in lexicographic order. The response includes a\n\t\t\t\tHostedZones child element for each hosted zone created by the current\n\t\t\t\tAmazon Web Services account.

\n\t\t

\n ListHostedZonesByName sorts hosted zones by name with the labels\n\t\t\treversed. For example:

\n\t\t

\n com.example.www.\n

\n\t\t

Note the trailing dot, which can change the sort order in some circumstances.

\n\t\t

If the domain name includes escape characters or Punycode,\n\t\t\t\tListHostedZonesByName alphabetizes the domain name using the escaped or\n\t\t\tPunycoded value, which is the format that Amazon Route 53 saves in its database. For\n\t\t\texample, to create a hosted zone for exämple.com, you specify ex\\344mple.com for\n\t\t\tthe domain name. ListHostedZonesByName alphabetizes it as:

\n\t\t

\n com.ex\\344mple.\n

\n\t\t

The labels are reversed and alphabetized using the escaped value. For more information\n\t\t\tabout valid domain name formats, including internationalized domain names, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.

\n\t\t

Route 53 returns up to 100 items in each response. If you have a lot of hosted zones,\n\t\t\tuse the MaxItems parameter to list them in groups of up to 100. The\n\t\t\tresponse includes values that help navigate from one group of MaxItems\n\t\t\thosted zones to the next:

\n\t\t
    \n
  • \n\t\t\t\t

    The DNSName and HostedZoneId elements in the\n\t\t\t\t\tresponse contain the values, if any, specified for the dnsname and\n\t\t\t\t\t\thostedzoneid parameters in the request that produced the\n\t\t\t\t\tcurrent response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The MaxItems element in the response contains the value, if any,\n\t\t\t\t\tthat you specified for the maxitems parameter in the request that\n\t\t\t\t\tproduced the current response.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If the value of IsTruncated in the response is true, there are\n\t\t\t\t\tmore hosted zones associated with the current Amazon Web Services account.

    \n\t\t\t\t

    If IsTruncated is false, this response includes the last hosted\n\t\t\t\t\tzone that is associated with the current account. The NextDNSName\n\t\t\t\t\telement and NextHostedZoneId elements are omitted from the\n\t\t\t\t\tresponse.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The NextDNSName and NextHostedZoneId elements in the\n\t\t\t\t\tresponse contain the domain name and the hosted zone ID of the next hosted zone\n\t\t\t\t\tthat is associated with the current Amazon Web Services account. If you want to\n\t\t\t\t\tlist more hosted zones, make another call to ListHostedZonesByName,\n\t\t\t\t\tand specify the value of NextDNSName and\n\t\t\t\t\t\tNextHostedZoneId in the dnsname and\n\t\t\t\t\t\thostedzoneid parameters, respectively.

    \n\t\t\t
    • \n
", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzonesbyname", @@ -5453,27 +6204,27 @@ "DNSName": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to \n\t\t\tspecify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of \n\t\t\tthe hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and \n\t\t\thostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

", + "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, include the\n\t\t\t\tdnsname parameter only if you want to specify the name of the first\n\t\t\thosted zone in the response. If you don't include the dnsname parameter,\n\t\t\tAmazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both\n\t\t\t\tdnsname and hostedzoneid parameters. For\n\t\t\t\tdnsname, specify the value of NextDNSName from the\n\t\t\tprevious response.

", "smithy.api#httpQuery": "dnsname" } }, "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

\n\t\t

If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first \n\t\t\tmaxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to \n\t\t\tListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of \n\t\t\thostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

", + "smithy.api#documentation": "

(Optional) For your first request to ListHostedZonesByName, do not\n\t\t\tinclude the hostedzoneid parameter.

\n\t\t

If you have more hosted zones than the value of maxitems,\n\t\t\t\tListHostedZonesByName returns only the first maxitems\n\t\t\thosted zones. To get the next group of maxitems hosted zones, submit\n\t\t\tanother request to ListHostedZonesByName and include both\n\t\t\t\tdnsname and hostedzoneid parameters. For the value of\n\t\t\t\thostedzoneid, specify the value of the NextHostedZoneId\n\t\t\telement from the previous response.

", "smithy.api#httpQuery": "hostedzoneid" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems \n\t\t\thosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and \n\t\t\tNextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

", + "smithy.api#documentation": "

The maximum number of hosted zones to be included in the response body for this\n\t\t\trequest. If you have more than maxitems hosted zones, then the value of the\n\t\t\t\tIsTruncated element in the response is true, and the values of\n\t\t\t\tNextDNSName and NextHostedZoneId specify the first hosted\n\t\t\tzone in the next group of maxitems hosted zones.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account in ASCII order by domain \n\t\t\tname.

" + "smithy.api#documentation": "

Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account in ASCII order by domain name.

" } }, "com.amazonaws.route53#ListHostedZonesByNameResponse": { @@ -5489,7 +6240,7 @@ "DNSName": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the \n\t\t\tdnsname parameter in the request that produced the current response.

" + "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZonesByName,\n\t\t\t\tDNSName is the value that you specified for the dnsname\n\t\t\tparameter in the request that produced the current response.

" } }, "HostedZoneId": { @@ -5501,26 +6252,26 @@ "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of \n\t\t\tmaxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and \n\t\t\tNextHostedZoneId elements in the dnsname and hostedzoneid parameters.

", + "smithy.api#documentation": "

A flag that indicates whether there are more hosted zones to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of maxitems hosted zones\n\t\t\tby calling ListHostedZonesByName again and specifying the values of\n\t\t\t\tNextDNSName and NextHostedZoneId elements in the\n\t\t\t\tdnsname and hostedzoneid parameters.

", "smithy.api#required": {} } }, "NextDNSName": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of \n\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName \n\t\t\tand NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

\n\t\t

This element is present only if IsTruncated is true.

" + "smithy.api#documentation": "

If IsTruncated is true, the value of NextDNSName is the name\n\t\t\tof the first hosted zone in the next group of maxitems hosted zones. Call\n\t\t\t\tListHostedZonesByName again and specify the value of\n\t\t\t\tNextDNSName and NextHostedZoneId in the\n\t\t\t\tdnsname and hostedzoneid parameters, respectively.

\n\t\t

This element is present only if IsTruncated is true.

" } }, "NextHostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the \n\t\t\tnext group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName \n\t\t\tand NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

\n\t\t

This element is present only if IsTruncated is true.

" + "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tNextHostedZoneId identifies the first hosted zone in the next group of\n\t\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again\n\t\t\tand specify the value of NextDNSName and NextHostedZoneId in\n\t\t\tthe dnsname and hostedzoneid parameters, respectively.

\n\t\t

This element is present only if IsTruncated is true.

" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the \n\t\t\tcurrent response.

", + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZonesByName that produced the current response.

", "smithy.api#required": {} } } @@ -5546,7 +6297,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the \n\t\t\thosted zones. The HostedZoneOwner structure in the response contains one of the following values:

\n\t\t
    \n
  • \n

    An OwningAccount element, which contains the account number of either the current Amazon Web Services account or \n\t\t\t\tanother Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account.

    \n\t\t\t
    • \n
  • \n

    An OwningService element, which identifies the Amazon Web Services service that created and owns the hosted zone. \n\t\t\t\tFor example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of Owner is \n\t\t\t\tefs.amazonaws.com.

    \n\t\t\t
    • \n
\n\t\t \n

When listing private hosted zones, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition where the hosted zones were created. A partition is a group of\n\t\t\t\t\tAmazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\t\tpartition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t
    \n
  • \n

    \n aws - Amazon Web Services Regions

    \n
    • \n
  • \n

    \n aws-cn - China Regions

    \n
    • \n
  • \n

    \n aws-us-gov - Amazon Web Services GovCloud (US) Region

    \n
    • \n
\n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n ", + "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:

\n\t\t
    \n
  • \n\t\t\t\t

    An OwningAccount element, which contains the account number of\n\t\t\t\t\teither the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create\n\t\t\t\t\thosted zones using the current account.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    An OwningService element, which identifies the Amazon Web Services\n\t\t\t\t\tservice that created and owns the hosted zone. For example, if a hosted zone was\n\t\t\t\t\tcreated by Amazon Elastic File System (Amazon EFS), the value of\n\t\t\t\t\t\tOwner is efs.amazonaws.com.

    \n\t\t\t
    • \n
\n\t\t \n\t\t\t

When listing private hosted zones, the hosted zone and the Amazon VPC must\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.

\n\t\t\t

The following are the supported partitions:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    \n aws - Amazon Web Services Regions

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n aws-cn - China Regions

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    \n aws-us-gov - Amazon Web Services GovCloud (US) Region

    \n\t\t\t\t
    • \n
\n\t\t\t

For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.

\n\t\t ", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzonesbyvpc", @@ -5568,7 +6319,7 @@ "VPCRegion": { "target": "com.amazonaws.route53#VPCRegion", "traits": { - "smithy.api#documentation": "

For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in.

", + "smithy.api#documentation": "

For the Amazon VPC that you specified for VPCId, the Amazon Web Services\n\t\t\tRegion that you created the VPC in.

", "smithy.api#httpQuery": "vpcregion", "smithy.api#required": {} } @@ -5576,20 +6327,20 @@ "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with \n\t\t\tmore than MaxItems hosted zones, the response includes a NextToken element. NextToken contains \n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request.

", + "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf the specified VPC is associated with more than MaxItems hosted zones,\n\t\t\tthe response includes a NextToken element. NextToken contains\n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if\n\t\t\tyou submit another request.

", "smithy.api#httpQuery": "maxitems" } }, "NextToken": { "target": "com.amazonaws.route53#PaginationToken", "traits": { - "smithy.api#documentation": "

If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. \n\t\t\tTo get more hosted zones, submit another ListHostedZonesByVPC request.

\n\t\t

For the value of NextToken, specify the value of NextToken from the previous response.

\n\t\t

If the previous response didn't include a NextToken element, there are no more hosted zones to get.

", + "smithy.api#documentation": "

If the previous response included a NextToken element, the specified VPC\n\t\t\tis associated with more hosted zones. To get more hosted zones, submit another\n\t\t\t\tListHostedZonesByVPC request.

\n\t\t

For the value of NextToken, specify the value of NextToken\n\t\t\tfrom the previous response.

\n\t\t

If the previous response didn't include a NextToken element, there are no\n\t\t\tmore hosted zones to get.

", "smithy.api#httpQuery": "nexttoken" } } }, "traits": { - "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account created the hosted zones.

" + "smithy.api#documentation": "

Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account created the hosted zones.

" } }, "com.amazonaws.route53#ListHostedZonesByVPCResponse": { @@ -5598,21 +6349,21 @@ "HostedZoneSummaries": { "target": "com.amazonaws.route53#HostedZoneSummaries", "traits": { - "smithy.api#documentation": "

A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. \n\t\t\tEach HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

", + "smithy.api#documentation": "

A list that contains one HostedZoneSummary element for each hosted zone\n\t\t\tthat the specified Amazon VPC is associated with. Each HostedZoneSummary\n\t\t\telement contains the hosted zone name and ID, and information about who owns the hosted\n\t\t\tzone.

", "smithy.api#required": {} } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for MaxItems in the most recent ListHostedZonesByVPC request.

", + "smithy.api#documentation": "

The value that you specified for MaxItems in the most recent\n\t\t\t\tListHostedZonesByVPC request.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.route53#PaginationToken", "traits": { - "smithy.api#documentation": "

The value that you will use for NextToken in the next ListHostedZonesByVPC request.

" + "smithy.api#documentation": "

The value that you will use for NextToken in the next\n\t\t\t\tListHostedZonesByVPC request.

" } } } @@ -5623,27 +6374,27 @@ "Marker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more hosted zones. \n\t\t\tTo get more hosted zones, submit another ListHostedZones request.

\n\t\t

For the value of marker, specify the value of NextMarker from the previous response, \n\t\t\twhich is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more hosted zones. To get more hosted zones, submit\n\t\t\tanother ListHostedZones request.

\n\t\t

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first hosted zone that Amazon Route\n\t\t\t53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more hosted zones to get.

", "smithy.api#httpQuery": "marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems \n\t\t\thosted zones, the value of IsTruncated in the response is true, and the value of NextMarker \n\t\t\tis the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

", + "smithy.api#documentation": "

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf you have more than maxitems hosted zones, the value of\n\t\t\t\tIsTruncated in the response is true, and the value of\n\t\t\t\tNextMarker is the hosted zone ID of the first hosted zone that Route 53\n\t\t\twill return if you submit another request.

", "smithy.api#httpQuery": "maxitems" } }, "DelegationSetId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

If you're using reusable delegation sets and you want to list all of the hosted zones that are associated \n\t\t\twith a reusable delegation set, specify the ID of that reusable delegation set.

", + "smithy.api#documentation": "

If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.

", "smithy.api#httpQuery": "delegationsetid" } } }, "traits": { - "smithy.api#documentation": "

A request to retrieve a list of the public and private hosted zones that are associated with the current Amazon Web Services account.

" + "smithy.api#documentation": "

A request to retrieve a list of the public and private hosted zones that are\n\t\t\tassociated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListHostedZonesResponse": { @@ -5659,27 +6410,27 @@ "Marker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the \n\t\t\tmarker parameter in the request that produced the current response.

", + "smithy.api#documentation": "

For the second and subsequent calls to ListHostedZones,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones \n\t\t\tby submitting another ListHostedZones request and specifying the value of NextMarker in the \n\t\t\tmarker parameter.

", + "smithy.api#documentation": "

A flag indicating whether there are more hosted zones to be listed. If the response\n\t\t\twas truncated, you can get more hosted zones by submitting another\n\t\t\t\tListHostedZones request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", "smithy.api#required": {} } }, "NextMarker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group \n\t\t\tof hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the \n\t\t\tmarker parameter.

\n\t\t

This element is present only if IsTruncated is true.

" + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first hosted zone in the next group of hosted zones. Submit another\n\t\t\t\tListHostedZones request, and specify the value of\n\t\t\t\tNextMarker from the response in the marker\n\t\t\tparameter.

\n\t\t

This element is present only if IsTruncated is true.

" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to ListHostedZones that \n\t\t\tproduced the current response.

", + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZones that produced the current response.

", "smithy.api#required": {} } } @@ -5705,7 +6456,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration \n\t\t\tthat is associated with a specified hosted zone.

\n\n\t\t

For more information about DNS query logs, see \n\t\t\tCreateQueryLoggingConfig. \n\t\t\tAdditional information, including the format of DNS query logs, appears in \n\t\t\tLogging DNS Queries \n\t\t\tin the Amazon Route 53 Developer Guide.

", + "smithy.api#documentation": "

Lists the configurations for DNS query logging that are associated with the current\n\t\t\t\tAmazon Web Services account or the configuration that is associated with a specified\n\t\t\thosted zone.

\n\t\t

For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of\n\t\t\tDNS query logs, appears in Logging DNS Queries in\n\t\t\tthe Amazon Route 53 Developer Guide.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/queryloggingconfig", @@ -5725,21 +6476,21 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in \n\t\t\tHostedZoneId.

\n\t\t

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations \n\t\t\tthat are associated with the current Amazon Web Services account.

", + "smithy.api#documentation": "

(Optional) If you want to list the query logging configuration that is associated with\n\t\t\ta hosted zone, specify the ID in HostedZoneId.

\n\t\t

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns\n\t\t\tall of the configurations that are associated with the current Amazon Web Services account.

", "smithy.api#httpQuery": "hostedzoneid" } }, "NextToken": { "target": "com.amazonaws.route53#PaginationToken", "traits": { - "smithy.api#documentation": "

(Optional) If the current Amazon Web Services account has more than MaxResults query logging configurations, use NextToken \n\t\t\tto get the second and subsequent pages of results.

\n\t\t

For the first ListQueryLoggingConfigs request, omit this value.

\n\t\t

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value \n\t\t\tfor NextToken in the request.

", + "smithy.api#documentation": "

(Optional) If the current Amazon Web Services account has more than\n\t\t\t\tMaxResults query logging configurations, use NextToken to\n\t\t\tget the second and subsequent pages of results.

\n\t\t

For the first ListQueryLoggingConfigs request, omit this value.

\n\t\t

For the second and subsequent requests, get the value of NextToken from\n\t\t\tthe previous response and specify that value for NextToken in the\n\t\t\trequest.

", "smithy.api#httpQuery": "nexttoken" } }, "MaxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. \n\t\t\tIf the current Amazon Web Services account has more than MaxResults configurations, use the value of \n\t\t\tNextToken \n\t\t\tin the response to get the next page of results.

\n\t\t

If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.

", + "smithy.api#documentation": "

(Optional) The maximum number of query logging configurations that you want Amazon\n\t\t\tRoute 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the\n\t\t\tvalue of NextToken in the response to get the next page of results.

\n\t\t

If you don't specify a value for MaxResults, Route 53 returns up to 100\n\t\t\tconfigurations.

", "smithy.api#httpQuery": "maxresults" } } @@ -5751,14 +6502,14 @@ "QueryLoggingConfigs": { "target": "com.amazonaws.route53#QueryLoggingConfigs", "traits": { - "smithy.api#documentation": "

An array that contains one \n\t\t\tQueryLoggingConfig element \n\t\t\tfor each configuration for DNS query logging that is associated with the current Amazon Web Services account.

", + "smithy.api#documentation": "

An array that contains one QueryLoggingConfig element for each configuration for DNS query logging\n\t\t\tthat is associated with the current Amazon Web Services account.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.route53#PaginationToken", "traits": { - "smithy.api#documentation": "

If a response includes the last of the query logging configurations that are associated with the current Amazon Web Services account, \n\t\t\tNextToken doesn't appear in the response.

\n\t\t

If a response doesn't include the last of the configurations, you can get more configurations by submitting another \n\t\t\tListQueryLoggingConfigs \n\t\t\trequest. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in \n\t\t\tNextToken in the next request.

" + "smithy.api#documentation": "

If a response includes the last of the query logging configurations that are\n\t\t\tassociated with the current Amazon Web Services account, NextToken doesn't\n\t\t\tappear in the response.

\n\t\t

If a response doesn't include the last of the configurations, you can get more\n\t\t\tconfigurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken\n\t\t\tthat Amazon Route 53 returned in the previous response and include it in\n\t\t\t\tNextToken in the next request.

" } } } @@ -5780,7 +6531,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the resource record sets in a specified hosted zone.

\n\t\t

\n ListResourceRecordSets returns up to 300 resource record sets at a time in ASCII order, \n\t\t\tbeginning at a position specified by the name and type elements.

\n\t\t\n\t\t

\n Sort order\n

\n\t\t\t

\n ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example:

\n\t\t\t

\n com.example.www.\n

\n\t\t\t

Note the trailing dot, which can change the sort order when the record name contains characters that appear before \n\t\t\t\t. (decimal 46) in the ASCII table. These characters include the following: ! \" # $ % & ' ( ) * + , -\n

\n\t\t\t

When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type.

\n\t\t\n\t\t

\n Specifying where to start listing records\n

\n\t\t\t

You can use the name and type elements to specify the resource record set that the list begins with:

\n\t\t\t
\n
If you do not specify Name or Type
\n
\n

The results begin with the first resource record set that the hosted zone contains.

\n
\n
If you specify Name but not Type
\n
\n

The results begin with the first resource record set in the list whose name is greater than or equal to \n\t\t\t\t\t\tName.

\n
\n
If you specify Type but not Name
\n
\n

Amazon Route 53 returns the InvalidInput error.

\n
\n
If you specify both Name and Type
\n
\n

The results begin with the first resource record set in the list whose name is greater than or equal to \n\t\t\t\t\t\tName, and whose type is greater than or equal to Type.

\n
\n
\n\t\t\n\t\t

\n Resource record sets that are PENDING\n

\n\t\t\t

This action returns the most current version of the records. This includes records that are PENDING, \n\t\t\t\tand that are not yet available on all Route 53 DNS servers.

\n\t\t\n\t\t

\n Changing resource record sets\n

\n\t\t\t

To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, \n\t\t\t\tdo not submit a ChangeResourceRecordSets request while you're paging through the results of a \n\t\t\t\tListResourceRecordSets request. If you do, some pages may display results without the latest changes \n\t\t\t\twhile other pages display results with the latest changes.

\n\t\t\n\t\t

\n Displaying the next page of results\n

\n\t\t\t

If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated \n\t\t\t\tis true. To display the next page of results, get the values of NextRecordName, NextRecordType, \n\t\t\t\tand NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and \n\t\t\t\tspecify those values for StartRecordName, StartRecordType, and StartRecordIdentifier.

", + "smithy.api#documentation": "

Lists the resource record sets in a specified hosted zone.

\n\t\t

\n ListResourceRecordSets returns up to 300 resource record sets at a time\n\t\t\tin ASCII order, beginning at a position specified by the name and\n\t\t\t\ttype elements.

\n\t\t

\n Sort order\n

\n\t\t

\n ListResourceRecordSets sorts results first by DNS name with the labels\n\t\t\treversed, for example:

\n\t\t

\n com.example.www.\n

\n\t\t

Note the trailing dot, which can change the sort order when the record name contains\n\t\t\tcharacters that appear before . (decimal 46) in the ASCII table. These\n\t\t\tcharacters include the following: ! \" # $ % & ' ( ) * + , -\n

\n\t\t

When multiple records have the same DNS name, ListResourceRecordSets\n\t\t\tsorts results by the record type.

\n\t\t

\n Specifying where to start listing records\n

\n\t\t

You can use the name and type elements to specify the resource record set that the\n\t\t\tlist begins with:

\n\t\t
\n
If you do not specify Name or Type
\n
\n\t\t\t\t\t

The results begin with the first resource record set that the hosted zone\n\t\t\t\t\t\tcontains.

\n\t\t\t\t
\n
If you specify Name but not Type
\n
\n\t\t\t\t\t

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name.

\n\t\t\t\t
\n
If you specify Type but not Name
\n
\n\t\t\t\t\t

Amazon Route 53 returns the InvalidInput error.

\n\t\t\t\t
\n
If you specify both Name and Type
\n
\n\t\t\t\t\t

The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name, and whose type is\n\t\t\t\t\t\tgreater than or equal to Type.

\n\t\t\t\t
\n
\n\t\t

\n Resource record sets that are PENDING\n

\n\t\t

This action returns the most current version of the records. This includes records\n\t\t\tthat are PENDING, and that are not yet available on all Route 53 DNS\n\t\t\tservers.

\n\t\t

\n Changing resource record sets\n

\n\t\t

To ensure that you get an accurate listing of the resource record sets for a hosted\n\t\t\tzone at a point in time, do not submit a ChangeResourceRecordSets request\n\t\t\twhile you're paging through the results of a ListResourceRecordSets\n\t\t\trequest. If you do, some pages may display results without the latest changes while\n\t\t\tother pages display results with the latest changes.

\n\t\t

\n Displaying the next page of results\n

\n\t\t

If a ListResourceRecordSets command returns more than one page of\n\t\t\tresults, the value of IsTruncated is true. To display the next\n\t\t\tpage of results, get the values of NextRecordName,\n\t\t\t\tNextRecordType, and NextRecordIdentifier (if any) from the\n\t\t\tresponse. Then submit another ListResourceRecordSets request, and specify\n\t\t\tthose values for StartRecordName, StartRecordType, and\n\t\t\t\tStartRecordIdentifier.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", @@ -5794,7 +6545,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to list.

", + "smithy.api#documentation": "

The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tlist.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5802,34 +6553,34 @@ "StartRecordName": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

The first name in the lexicographic ordering of resource record sets that you want to list. \n\t\t\tIf the specified record name doesn't exist, the results begin with the first resource record set that has a name \n\t\t\tgreater than the value of name.

", + "smithy.api#documentation": "

The first name in the lexicographic ordering of resource record sets that you want to\n\t\t\tlist. If the specified record name doesn't exist, the results begin with the first\n\t\t\tresource record set that has a name greater than the value of name.

", "smithy.api#httpQuery": "name" } }, "StartRecordType": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

The type of resource record set to begin the record listing from.

\n\t\t

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | \n\t\t\tNAPTR | NS | PTR | SOA | SPF | SRV | TXT\n

\n\t\t

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | \n\t\t\tMX | NAPTR | PTR | SPF | SRV | TXT\n

\n\t\t

Values for alias resource record sets:

\n\t\t
    \n
  • \n

    \n API Gateway custom regional API or edge-optimized API: A

    \n
    • \n
  • \n

    \n CloudFront distribution: A or AAAA

    \n
    • \n
  • \n

    \n Elastic Beanstalk environment that has a regionalized subdomain: A

    \n
    • \n
  • \n

    \n Elastic Load Balancing load balancer: A | AAAA

    \n
    • \n
  • \n

    \n S3 bucket: A

    \n
    • \n
  • \n

    \n VPC interface VPC endpoint: A

    \n
    • \n
  • \n

    \n Another resource record set in this hosted zone: The type of the resource record set \n\t\t\t\tthat the alias references.

    \n
    • \n
\n\t\t

Constraint: Specifying type without specifying name returns an InvalidInput error.

", + "smithy.api#documentation": "

The type of resource record set to begin the record listing from.

\n\t\t

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | MX | NAPTR |\n\t\t\t\tNS | PTR | SOA | SPF |\n\t\t\t\tSRV | TXT\n

\n\t\t

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT\n

\n\t\t

Values for alias resource record sets:

\n\t\t
    \n
  • \n\t\t\t\t

    \n API Gateway custom regional API or edge-optimized\n\t\t\t\t\t\tAPI: A

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n CloudFront distribution: A or AAAA

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Elastic Beanstalk environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Elastic Load Balancing load balancer: A |\n\t\t\t\t\tAAAA

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n S3 bucket: A

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n VPC interface VPC endpoint: A

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Another resource record set in this hosted\n\t\t\t\t\t\tzone: The type of the resource record set that the alias\n\t\t\t\t\treferences.

    \n\t\t\t
    • \n
\n\t\t

Constraint: Specifying type without specifying name returns\n\t\t\tan InvalidInput error.

", "smithy.api#httpQuery": "type" } }, "StartRecordIdentifier": { "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, \n\t\t\tspecify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current \n\t\t\tDNS name and type.

", + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, specify\n\t\t\tthe value of NextRecordIdentifier from the previous response to get the\n\t\t\tnext resource record set that has the current DNS name and type.

", "smithy.api#httpQuery": "identifier" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes \n\t\t\tmore than maxitems resource record sets, the value of the IsTruncated element in the response is true, \n\t\t\tand the values of the NextRecordName and NextRecordType elements in the response identify the first \n\t\t\tresource record set in the next group of maxitems resource record sets.

", + "smithy.api#documentation": "

(Optional) The maximum number of resource records sets to include in the response body\n\t\t\tfor this request. If the response includes more than maxitems resource\n\t\t\trecord sets, the value of the IsTruncated element in the response is\n\t\t\t\ttrue, and the values of the NextRecordName and\n\t\t\t\tNextRecordType elements in the response identify the first resource\n\t\t\trecord set in the next group of maxitems resource record sets.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

A request for the resource record sets that are associated with a specified hosted zone.

" + "smithy.api#documentation": "

A request for the resource record sets that are associated with a specified hosted\n\t\t\tzone.

" } }, "com.amazonaws.route53#ListResourceRecordSetsResponse": { @@ -5845,7 +6596,7 @@ "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a \n\t\t\tfollow-up pagination request by using the NextRecordName element.

", + "smithy.api#documentation": "

A flag that indicates whether more resource record sets remain to be listed. If your\n\t\t\tresults were truncated, you can make a follow-up pagination request by using the\n\t\t\t\tNextRecordName element.

", "smithy.api#required": {} } }, @@ -5864,7 +6615,7 @@ "NextRecordIdentifier": { "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than simple: If results were truncated for a given \n\t\t\tDNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

\n\t\t

For information about routing policies, see \n\t\t\tChoosing a Routing Policy \n\t\t\tin the Amazon Route 53 Developer Guide.

" + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, the\n\t\t\tvalue of SetIdentifier for the next resource record set that has the\n\t\t\tcurrent DNS name and type.

\n\t\t

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" } }, "MaxItems": { @@ -5893,7 +6644,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.

", + "smithy.api#documentation": "

Retrieves a list of the reusable delegation sets that are associated with the current\n\t\t\t\tAmazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/delegationset", @@ -5907,20 +6658,20 @@ "Marker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. \n\t\t\tTo get another group, submit another ListReusableDelegationSets request.

\n\t\t

For the value of marker, specify the value of NextMarker from the previous response, \n\t\t\twhich is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more reusable delegation sets. To get another group,\n\t\t\tsubmit another ListReusableDelegationSets request.

\n\t\t

For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first reusable delegation set that\n\t\t\tAmazon Route 53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more reusable delegation sets to get.

", "smithy.api#httpQuery": "marker" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value \n\t\t\tgreater than 100, Route 53 returns only the first 100 reusable delegation sets.

", + "smithy.api#documentation": "

The number of reusable delegation sets that you want Amazon Route 53 to return in the\n\t\t\tresponse to this request. If you specify a value greater than 100, Route 53 returns only\n\t\t\tthe first 100 reusable delegation sets.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

A request to get a list of the reusable delegation sets that are associated with the current Amazon Web Services account.

" + "smithy.api#documentation": "

A request to get a list of the reusable delegation sets that are associated with the\n\t\t\tcurrent Amazon Web Services account.

" } }, "com.amazonaws.route53#ListReusableDelegationSetsResponse": { @@ -5929,40 +6680,40 @@ "DelegationSets": { "target": "com.amazonaws.route53#DelegationSets", "traits": { - "smithy.api#documentation": "

A complex type that contains one DelegationSet element for each reusable delegation set that was created \n\t\t\tby the current Amazon Web Services account.

", + "smithy.api#documentation": "

A complex type that contains one DelegationSet element for each reusable\n\t\t\tdelegation set that was created by the current Amazon Web Services account.

", "smithy.api#required": {} } }, "Marker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified \n\t\t\tfor the marker parameter in the request that produced the current response.

", + "smithy.api#documentation": "

For the second and subsequent calls to ListReusableDelegationSets,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.

", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more reusable delegation sets to be listed.

", + "smithy.api#documentation": "

A flag that indicates whether there are more reusable delegation sets to be\n\t\t\tlisted.

", "smithy.api#required": {} } }, "NextMarker": { "target": "com.amazonaws.route53#PageMarker", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set \n\t\t\tthat Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker \n\t\t\tin the marker parameter.

" + "smithy.api#documentation": "

If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the next reusable delegation set that Amazon Route 53 will return if you\n\t\t\tsubmit another ListReusableDelegationSets request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.

" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that \n\t\t\tproduced the current response.

", + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListReusableDelegationSets that produced the current response.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the reusable delegation sets that are associated with the current Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains information about the reusable delegation sets that are\n\t\t\tassociated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListTagsForResource": { @@ -5991,7 +6742,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists tags for one health check or hosted zone.

\n\t\t

For information about using tags for cost allocation, see \n\t\t\tUsing Cost Allocation Tags \n\t\t\tin the Billing and Cost Management User Guide.

", + "smithy.api#documentation": "

Lists tags for one health check or hosted zone.

\n\t\t

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", @@ -6005,7 +6756,7 @@ "ResourceType": { "target": "com.amazonaws.route53#TagResourceType", "traits": { - "smithy.api#documentation": "

The type of the resource.

\n\t\t
    \n
  • \n

    The resource type for health checks is healthcheck.

    \n
    • \n
  • \n

    The resource type for hosted zones is hostedzone.

    \n
    • \n
", + "smithy.api#documentation": "

The type of the resource.

\n\t\t
    \n
  • \n\t\t\t\t

    The resource type for health checks is healthcheck.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The resource type for hosted zones is hostedzone.

    \n\t\t\t
    • \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6020,7 +6771,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type containing information about a request for a list of the tags that are associated with an individual resource.

" + "smithy.api#documentation": "

A complex type containing information about a request for a list of the tags that are\n\t\t\tassociated with an individual resource.

" } }, "com.amazonaws.route53#ListTagsForResourceResponse": { @@ -6029,13 +6780,13 @@ "ResourceTagSet": { "target": "com.amazonaws.route53#ResourceTagSet", "traits": { - "smithy.api#documentation": "

A ResourceTagSet containing tags associated with the specified resource.

", + "smithy.api#documentation": "

A ResourceTagSet containing tags associated with the specified\n\t\t\tresource.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the health checks or hosted zones for which you want to list tags.

" + "smithy.api#documentation": "

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

" } }, "com.amazonaws.route53#ListTagsForResources": { @@ -6064,7 +6815,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists tags for up to 10 health checks or hosted zones.

\n\t\t

For information about using tags for cost allocation, see \n\t\t\tUsing Cost Allocation Tags \n\t\t\tin the Billing and Cost Management User Guide.

", + "smithy.api#documentation": "

Lists tags for up to 10 health checks or hosted zones.

\n\t\t

For information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/tags/{ResourceType}", @@ -6078,7 +6829,7 @@ "ResourceType": { "target": "com.amazonaws.route53#TagResourceType", "traits": { - "smithy.api#documentation": "

The type of the resources.

\n\t\t
    \n
  • \n

    The resource type for health checks is healthcheck.

    \n
    • \n
  • \n

    The resource type for hosted zones is hostedzone.

    \n
    • \n
", + "smithy.api#documentation": "

The type of the resources.

\n\t\t
    \n
  • \n\t\t\t\t

    The resource type for health checks is healthcheck.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The resource type for hosted zones is hostedzone.

    \n\t\t\t
    • \n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6086,13 +6837,13 @@ "ResourceIds": { "target": "com.amazonaws.route53#TagResourceIdList", "traits": { - "smithy.api#documentation": "

A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

", + "smithy.api#documentation": "

A complex type that contains the ResourceId element for each resource for which you\n\t\t\twant to get a list of tags.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the health checks or hosted zones for which you want to list tags.

" + "smithy.api#documentation": "

A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.

" } }, "com.amazonaws.route53#ListTagsForResourcesResponse": { @@ -6101,7 +6852,7 @@ "ResourceTagSets": { "target": "com.amazonaws.route53#ResourceTagSetList", "traits": { - "smithy.api#documentation": "

A list of ResourceTagSets containing tags associated with the specified resources.

", + "smithy.api#documentation": "

A list of ResourceTagSets containing tags associated with the specified\n\t\t\tresources.

", "smithy.api#required": {} } } @@ -6124,7 +6875,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. \n\t\t\tPolicies are listed in the order that they were created in.

\n\t\t\n\t\t

For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see \n\t\t\tDeleteTrafficPolicy.\n\n\t\t

", + "smithy.api#documentation": "

Gets information about the latest version for every traffic policy that is associated\n\t\t\twith the current Amazon Web Services account. Policies are listed in the order that they\n\t\t\twere created in.

\n\t\t

For information about how of deleting a traffic policy affects the response from\n\t\t\t\tListTrafficPolicies, see DeleteTrafficPolicy.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicies", @@ -6138,20 +6889,20 @@ "TrafficPolicyIdMarker": { "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

(Conditional) For your first request to ListTrafficPolicies, don't include the TrafficPolicyIdMarker parameter.

\n\t\t

If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first \n\t\t\tMaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. \n\t\t\tFor the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the \n\t\t\tprevious response.

", + "smithy.api#documentation": "

(Conditional) For your first request to ListTrafficPolicies, don't\n\t\t\tinclude the TrafficPolicyIdMarker parameter.

\n\t\t

If you have more traffic policies than the value of MaxItems,\n\t\t\t\tListTrafficPolicies returns only the first MaxItems\n\t\t\ttraffic policies. To get the next group of policies, submit another request to\n\t\t\t\tListTrafficPolicies. For the value of\n\t\t\t\tTrafficPolicyIdMarker, specify the value of\n\t\t\t\tTrafficPolicyIdMarker that was returned in the previous\n\t\t\tresponse.

", "smithy.api#httpQuery": "trafficpolicyid" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than \n\t\t\tMaxItems traffic policies, the value of IsTruncated in the response is true, and the \n\t\t\tvalue of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit \n\t\t\tanother request.

", + "smithy.api#documentation": "

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to\n\t\t\treturn in response to this request. If you have more than MaxItems traffic\n\t\t\tpolicies, the value of IsTruncated in the response is true,\n\t\t\tand the value of TrafficPolicyIdMarker is the ID of the first traffic\n\t\t\tpolicy that Route 53 will return if you submit another request.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the information about the request to list the traffic policies that are associated \n\t\t\twith the current Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains the information about the request to list the traffic\n\t\t\tpolicies that are associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListTrafficPoliciesResponse": { @@ -6160,28 +6911,28 @@ "TrafficPolicySummaries": { "target": "com.amazonaws.route53#TrafficPolicySummaries", "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account.

", + "smithy.api#documentation": "

A list that contains one TrafficPolicySummary element for each traffic\n\t\t\tpolicy that was created by the current Amazon Web Services account.

", "smithy.api#required": {} } }, "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of \n\t\t\ttraffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker \n\t\t\tin the TrafficPolicyIdMarker request parameter.

", + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicies request and specifying the value of\n\t\t\t\tTrafficPolicyIdMarker in the TrafficPolicyIdMarker request\n\t\t\tparameter.

", "smithy.api#required": {} } }, "TrafficPolicyIdMarker": { "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy \n\t\t\tin the next group of MaxItems traffic policies.

", + "smithy.api#documentation": "

If the value of IsTruncated is true,\n\t\t\t\tTrafficPolicyIdMarker is the ID of the first traffic policy in the next\n\t\t\tgroup of MaxItems traffic policies.

", "smithy.api#required": {} } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced \n\t\t\tthe current response.

", + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicies request that produced the current response.

", "smithy.api#required": {} } } @@ -6207,7 +6958,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.

\n\t\t \n\t\t\t

After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the \n\t\t\t\tresource record sets that are specified in the traffic policy definition. For more information, see the State response element.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the \n\t\t\tMaxItems parameter to list them in groups of up to 100.

", + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using the\n\t\t\tcurrent Amazon Web Services account.

\n\t\t \n\t\t\t

After you submit an UpdateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. For more information, see the\n\t\t\t\t\tState response element.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstances", @@ -6235,7 +6986,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created in a specified hosted zone.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a \n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, \n\t\t\t\tsee the State response element.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the \n\t\t\tMaxItems parameter to list them in groups of up to 100.

", + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created in a specified\n\t\t\thosted zone.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstances/hostedzone", @@ -6257,27 +7008,27 @@ "TrafficPolicyInstanceNameMarker": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, \n\t\t\tspecify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", "smithy.api#httpQuery": "trafficpolicyinstancename" } }, "TrafficPolicyInstanceTypeMarker": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, \n\t\t\tspecify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", "smithy.api#httpQuery": "trafficpolicyinstancetype" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than \n\t\t\tMaxItems traffic policy instances, the value of the IsTruncated element in the response is true, \n\t\t\tand the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker \n\t\t\trepresent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

", + "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

A request for the traffic policy instances that you created in a specified hosted zone.

" + "smithy.api#documentation": "

A request for the traffic policy instances that you created in a specified hosted\n\t\t\tzone.

" } }, "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse": { @@ -6286,33 +7037,33 @@ "TrafficPolicyInstances": { "target": "com.amazonaws.route53#TrafficPolicyInstances", "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

", + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", "smithy.api#required": {} } }, "TrafficPolicyInstanceNameMarker": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy \n\t\t\tinstance in the next group of traffic policy instances.

" + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of traffic policy instances.

" } }, "TrafficPolicyInstanceTypeMarker": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are \n\t\t\tassociated with the first traffic policy instance in the next group of traffic policy instances.

" + "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is\n\t\t\tthe DNS type of the resource record sets that are associated with the first traffic\n\t\t\tpolicy instance in the next group of traffic policy instances.

" } }, "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the \n\t\t\tnext group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying \n\t\t\tthe values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker \n\t\t\tin the corresponding request parameters.

", + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tsubmitting another ListTrafficPolicyInstancesByHostedZone request and\n\t\t\tspecifying the values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

", "smithy.api#required": {} } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request \n\t\t\tthat produced the current response.

", + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicyInstancesByHostedZone request that produced the\n\t\t\tcurrent response.

", "smithy.api#required": {} } } @@ -6341,7 +7092,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, \n\t\t\t\tthere's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For \n\t\t\t\tmore information, see the State response element.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the \n\t\t\tMaxItems parameter to list them in groups of up to 100.

", + "smithy.api#documentation": "

Gets information about the traffic policy instances that you created by using a\n\t\t\tspecify traffic policy version.

\n\t\t \n\t\t\t

After you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.

\n\t\t \n\t\t

Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicyinstances/trafficpolicy", @@ -6355,7 +7106,7 @@ "TrafficPolicyId": { "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

The ID of the traffic policy for which you want to list traffic policy instances.

", + "smithy.api#documentation": "

The ID of the traffic policy for which you want to list traffic policy\n\t\t\tinstances.

", "smithy.api#httpQuery": "id", "smithy.api#required": {} } @@ -6363,7 +7114,7 @@ "TrafficPolicyVersion": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the \n\t\t\ttraffic policy that is specified by TrafficPolicyId.

", + "smithy.api#documentation": "

The version of the traffic policy for which you want to list traffic policy instances.\n\t\t\tThe version must be associated with the traffic policy that is specified by\n\t\t\t\tTrafficPolicyId.

", "smithy.api#httpQuery": "version", "smithy.api#required": {} } @@ -6371,34 +7122,34 @@ "HostedZoneIdMarker": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

\n\t\t

For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, \n\t\t\twhich is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n\t\t

For the value of hostedzoneid, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance that Amazon Route 53 will return if you submit\n\t\t\tanother request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", "smithy.api#httpQuery": "hostedzoneid" } }, "TrafficPolicyInstanceNameMarker": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

\n\t\t

For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker \n\t\t\tfrom the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n\t\t

For the value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", "smithy.api#httpQuery": "trafficpolicyinstancename" } }, "TrafficPolicyInstanceTypeMarker": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

\n\t\t

For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker \n\t\t\tfrom the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.

\n\t\t

For the value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", "smithy.api#httpQuery": "trafficpolicyinstancetype" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than \n\t\t\tMaxItems traffic policy instances, the value of the IsTruncated element in the response is true, \n\t\t\tand the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker \n\t\t\trepresent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

", + "smithy.api#documentation": "

The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the information about the request to list your traffic policy instances.

" + "smithy.api#documentation": "

A complex type that contains the information about the request to list your traffic\n\t\t\tpolicy instances.

" } }, "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse": { @@ -6407,39 +7158,39 @@ "TrafficPolicyInstances": { "target": "com.amazonaws.route53#TrafficPolicyInstances", "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

", + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", "smithy.api#required": {} } }, "HostedZoneIdMarker": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first \n\t\t\ttraffic policy instance in the next group of traffic policy instances.

" + "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance in the next group of\n\t\t\ttraffic policy instances.

" } }, "TrafficPolicyInstanceNameMarker": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance \n\t\t\tin the next group of MaxItems traffic policy instances.

" + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

" } }, "TrafficPolicyInstanceTypeMarker": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets \n\t\t\tthat are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

" + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance in the next group of\n\t\t\t\tMaxItems traffic policy instances.

" } }, "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of \n\t\t\ttraffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, \n\t\t\tTrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

", + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tcalling ListTrafficPolicyInstancesByPolicy again and specifying the values\n\t\t\tof the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker elements in the corresponding request\n\t\t\tparameters.

", "smithy.api#required": {} } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced \n\t\t\tthe current response.

", + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstancesByPolicy that produced the current\n\t\t\tresponse.

", "smithy.api#required": {} } } @@ -6454,34 +7205,34 @@ "HostedZoneIdMarker": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, \n\t\t\tspecify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of HostedZoneId, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", "smithy.api#httpQuery": "hostedzoneid" } }, "TrafficPolicyInstanceNameMarker": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, \n\t\t\tspecify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", "smithy.api#httpQuery": "trafficpolicyinstancename" } }, "TrafficPolicyInstanceTypeMarker": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. \n\t\t\tTo get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, \n\t\t\tspecify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance \n\t\t\tin the next group of traffic policy instances.

\n\t\t

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", + "smithy.api#documentation": "

If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.

\n\t\t

If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.

", "smithy.api#httpQuery": "trafficpolicyinstancetype" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. \n\t\t\tIf you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is \n\t\t\ttrue, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and \n\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems \n\t\t\ttraffic policy instances.

", + "smithy.api#documentation": "

The maximum number of traffic policy instances that you want Amazon Route 53 to return\n\t\t\tin response to a ListTrafficPolicyInstances request. If you have more than\n\t\t\t\tMaxItems traffic policy instances, the value of the\n\t\t\t\tIsTruncated element in the response is true, and the\n\t\t\tvalues of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.

", "smithy.api#httpQuery": "maxitems" } } }, "traits": { - "smithy.api#documentation": "

A request to get information about the traffic policy instances that you created by using the current Amazon Web Services account.

" + "smithy.api#documentation": "

A request to get information about the traffic policy instances that you created by\n\t\t\tusing the current Amazon Web Services account.

" } }, "com.amazonaws.route53#ListTrafficPolicyInstancesResponse": { @@ -6490,39 +7241,39 @@ "TrafficPolicyInstances": { "target": "com.amazonaws.route53#TrafficPolicyInstances", "traits": { - "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements \n\t\t\tin the request.

", + "smithy.api#documentation": "

A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.

", "smithy.api#required": {} } }, "HostedZoneIdMarker": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first \n\t\t\ttraffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

" + "smithy.api#documentation": "

If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance that Route 53 will return\n\t\t\tif you submit another ListTrafficPolicyInstances request.

" } }, "TrafficPolicyInstanceNameMarker": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy \n\t\t\tinstance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

" + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance that Route 53 will return if you submit another\n\t\t\t\tListTrafficPolicyInstances request.

" } }, "TrafficPolicyInstanceTypeMarker": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets \n\t\t\tthat are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

" + "smithy.api#documentation": "

If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance that Amazon Route 53\n\t\t\twill return if you submit another ListTrafficPolicyInstances request.\n\t\t

" } }, "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more \n\t\t\ttraffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the \n\t\t\tHostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker \n\t\t\tin the corresponding request parameters.

", + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get more traffic policy instances by calling\n\t\t\t\tListTrafficPolicyInstances again and specifying the values of the\n\t\t\t\tHostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.

", "smithy.api#required": {} } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances \n\t\t\tthat produced the current response.

", + "smithy.api#documentation": "

The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstances that produced the current response.

", "smithy.api#required": {} } } @@ -6548,7 +7299,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about all of the versions for a specified traffic policy.

\n\t\t

Traffic policy versions are listed in numerical order by VersionNumber.

", + "smithy.api#documentation": "

Gets information about all of the versions for a specified traffic policy.

\n\t\t

Traffic policy versions are listed in numerical order by\n\t\t\tVersionNumber.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/trafficpolicies/{Id}/versions", @@ -6562,7 +7313,7 @@ "Id": { "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

Specify the value of Id of the traffic policy for which you want to list all versions.

", + "smithy.api#documentation": "

Specify the value of Id of the traffic policy for which you want to list\n\t\t\tall versions.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6570,14 +7321,14 @@ "TrafficPolicyVersionMarker": { "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", "traits": { - "smithy.api#documentation": "

For your first request to ListTrafficPolicyVersions, don't include the TrafficPolicyVersionMarker parameter.

\n\t\t

If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only \n\t\t\tthe first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions \n\t\t\trequest. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous \n\t\t\tresponse.

", + "smithy.api#documentation": "

For your first request to ListTrafficPolicyVersions, don't include the\n\t\t\t\tTrafficPolicyVersionMarker parameter.

\n\t\t

If you have more traffic policy versions than the value of MaxItems,\n\t\t\t\tListTrafficPolicyVersions returns only the first group of\n\t\t\t\tMaxItems versions. To get more traffic policy versions, submit another\n\t\t\t\tListTrafficPolicyVersions request. For the value of\n\t\t\t\tTrafficPolicyVersionMarker, specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the previous response.

", "smithy.api#httpQuery": "trafficpolicyversion" } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified \n\t\t\ttraffic policy has more than MaxItems versions, the value of IsTruncated in the response is true, \n\t\t\tand the value of the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you submit \n\t\t\tanother request.

", + "smithy.api#documentation": "

The maximum number of traffic policy versions that you want Amazon Route 53 to include\n\t\t\tin the response body for this request. If the specified traffic policy has more than\n\t\t\t\tMaxItems versions, the value of IsTruncated in the\n\t\t\tresponse is true, and the value of the\n\t\t\t\tTrafficPolicyVersionMarker element is the ID of the first version that\n\t\t\tRoute 53 will return if you submit another request.

", "smithy.api#httpQuery": "maxitems" } } @@ -6599,21 +7350,21 @@ "IsTruncated": { "target": "com.amazonaws.route53#PageTruncated", "traits": { - "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of \n\t\t\ttraffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker \n\t\t\tin the marker parameter.

", + "smithy.api#documentation": "

A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicyVersions request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.

", "smithy.api#required": {} } }, "TrafficPolicyVersionMarker": { "target": "com.amazonaws.route53#TrafficPolicyVersionMarker", "traits": { - "smithy.api#documentation": "

If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy \n\t\t\tthat Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of \n\t\t\tTrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

\n\t\t

This element is present only if IsTruncated is true.

", + "smithy.api#documentation": "

If IsTruncated is true, the value of\n\t\t\t\tTrafficPolicyVersionMarker identifies the first traffic policy that\n\t\t\tAmazon Route 53 will return if you submit another request. Call\n\t\t\t\tListTrafficPolicyVersions again and specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the\n\t\t\t\tTrafficPolicyVersionMarker request parameter.

\n\t\t

This element is present only if IsTruncated is true.

", "smithy.api#required": {} } }, "MaxItems": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced \n\t\t\tthe current response.

", + "smithy.api#documentation": "

The value that you specified for the maxitems parameter in the\n\t\t\t\tListTrafficPolicyVersions request that produced the current\n\t\t\tresponse.

", "smithy.api#required": {} } } @@ -6642,7 +7393,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of the VPCs that were created by other accounts and that can be associated with a \n\t\t\tspecified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests.

\n\t\t

The response includes a VPCs element with a VPC child element for each VPC \n\t\t\tthat can be associated with the hosted zone.

", + "smithy.api#documentation": "

Gets a list of the VPCs that were created by other accounts and that can be associated\n\t\t\twith a specified hosted zone because you've submitted one or more\n\t\t\t\tCreateVPCAssociationAuthorization requests.

\n\t\t

The response includes a VPCs element with a VPC child\n\t\t\telement for each VPC that can be associated with the hosted zone.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/hostedzone/{HostedZoneId}/authorizevpcassociation", @@ -6656,7 +7407,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.

", + "smithy.api#documentation": "

The ID of the hosted zone for which you want a list of VPCs that can be associated\n\t\t\twith the hosted zone.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6664,20 +7415,20 @@ "NextToken": { "target": "com.amazonaws.route53#PaginationToken", "traits": { - "smithy.api#documentation": "

\n Optional: If a response includes a NextToken element, there are more VPCs \n\t\t\tthat can be associated with the specified hosted zone. To get the next page of results, submit another request, \n\t\t\tand include the value of NextToken from the response in the nexttoken parameter \n\t\t\tin another ListVPCAssociationAuthorizations request.

", + "smithy.api#documentation": "

\n Optional: If a response includes a NextToken\n\t\t\telement, there are more VPCs that can be associated with the specified hosted zone. To\n\t\t\tget the next page of results, submit another request, and include the value of\n\t\t\t\tNextToken from the response in the nexttoken parameter in\n\t\t\tanother ListVPCAssociationAuthorizations request.

", "smithy.api#httpQuery": "nexttoken" } }, "MaxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

\n Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. \n\t\t\tIf you don't specify a value for MaxResults, Route 53 returns up to 50 VPCs per page.

", + "smithy.api#documentation": "

\n Optional: An integer that specifies the maximum number of VPCs\n\t\t\tthat you want Amazon Route 53 to return. If you don't specify a value for\n\t\t\t\tMaxResults, Route 53 returns up to 50 VPCs per page.

", "smithy.api#httpQuery": "maxresults" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about that can be associated with your hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about that can be associated with your hosted\n\t\t\tzone.

" } }, "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse": { @@ -6693,13 +7444,13 @@ "NextToken": { "target": "com.amazonaws.route53#PaginationToken", "traits": { - "smithy.api#documentation": "

When the response includes a NextToken element, there are more VPCs that can be associated \n\t\t\twith the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, \n\t\t\tand include the value of the NextToken element from the response in the nexttoken request parameter.

" + "smithy.api#documentation": "

When the response includes a NextToken element, there are more VPCs that\n\t\t\tcan be associated with the specified hosted zone. To get the next page of VPCs, submit\n\t\t\tanother ListVPCAssociationAuthorizations request, and include the value of\n\t\t\tthe NextToken element from the response in the nexttoken\n\t\t\trequest parameter.

" } }, "VPCs": { "target": "com.amazonaws.route53#VPCs", "traits": { - "smithy.api#documentation": "

The list of VPCs that are authorized to be associated with the specified hosted zone.

", + "smithy.api#documentation": "

The list of VPCs that are authorized to be associated with the specified hosted\n\t\t\tzone.

", "smithy.api#required": {} } } @@ -6708,6 +7459,26 @@ "smithy.api#documentation": "

A complex type that contains the response information for the request.

" } }, + "com.amazonaws.route53#LocationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#LocationSummary" + } + }, + "com.amazonaws.route53#LocationSummary": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", + "traits": { + "smithy.api#documentation": "

A string that specifies a location name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the CIDR location.

" + } + }, "com.amazonaws.route53#MeasureLatency": { "type": "boolean", "traits": { @@ -6763,6 +7534,32 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.route53#NoSuchCidrCollectionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection you specified, doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCidrLocationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The CIDR collection location doesn't match any locations in your account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup": { "type": "structure", "members": { @@ -6802,7 +7599,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon Route 53 doesn't support the specified geographic location. For a list of supported geolocation codes, see the \n\t\t\tGeoLocation data type.

", + "smithy.api#documentation": "

Amazon Route 53 doesn't support the specified geographic location. For a list of\n\t\t\tsupported geolocation codes, see the GeoLocation data\n\t\t\ttype.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -6917,7 +7714,7 @@ } }, "traits": { - "smithy.api#documentation": "

Associating the specified VPC with the specified hosted zone has not been authorized.

", + "smithy.api#documentation": "

Associating the specified VPC with the specified hosted zone has not been\n\t\t\tauthorized.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } @@ -6970,7 +7767,7 @@ } }, "traits": { - "smithy.api#documentation": "

If Amazon Route 53 can't process a request before the next request arrives, it will reject\n\t\t\tsubsequent requests for the same hosted zone and return an HTTP 400 error\n\t\t\t(Bad request). If Route 53 returns this error repeatedly for the same request, we\n\t\t\trecommend that you wait, in intervals of increasing duration, before you try the request\n\t\t\tagain.

", + "smithy.api#documentation": "

If Amazon Route 53 can't process a request before the next request arrives, it will\n\t\t\treject subsequent requests for the same hosted zone and return an HTTP 400\n\t\t\t\terror (Bad request). If Route 53 returns this error repeatedly\n\t\t\tfor the same request, we recommend that you wait, in intervals of increasing duration,\n\t\t\tbefore you try the request again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6986,7 +7783,7 @@ } }, "traits": { - "smithy.api#documentation": "

You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't support associating a \n\t\t\tVPC with a public hosted zone.

", + "smithy.api#documentation": "

You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't\n\t\t\tsupport associating a VPC with a public hosted zone.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7011,13 +7808,13 @@ "CloudWatchLogsLogGroupArn": { "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53\n\t\t\tis publishing logs to.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about a configuration for DNS query logging.

" + "smithy.api#documentation": "

A complex type that contains information about a configuration for DNS query\n\t\t\tlogging.

" } }, "com.amazonaws.route53#QueryLoggingConfigAlreadyExists": { @@ -7028,7 +7825,7 @@ } }, "traits": { - "smithy.api#documentation": "

You can create only one query logging configuration for a hosted zone, and a query logging configuration already exists \n\t\t\tfor this hosted zone.

", + "smithy.api#documentation": "

You can create only one query logging configuration for a hosted zone, and a query\n\t\t\tlogging configuration already exists for this hosted zone.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -7131,7 +7928,7 @@ "com.amazonaws.route53#RecordDataEntry": { "type": "string", "traits": { - "smithy.api#documentation": "

A value that Amazon Route 53 returned for this resource record set. A RecordDataEntry element is one of the following:

\n\t\t
    \n
  • \n

    For non-alias resource record sets, a RecordDataEntry element contains one value \n\t\t\t\tin the resource record set. If the resource record set contains multiple values, the response includes one \n\t\t\t\tRecordDataEntry element for each value.

    \n
    • \n
  • \n

    For multiple resource record sets that have the same name and type, which includes \n\t\t\t\tweighted, latency, geolocation, and failover, a RecordDataEntry element contains the value from \n\t\t\t\tthe appropriate resource record set based on the request.

    \n
    • \n
  • \n

    For alias resource record sets that refer to Amazon Web Services resources other than another resource record set, \n\t\t\t\tthe RecordDataEntry element contains an IP address or a domain name for the Amazon Web Services resource, \n\t\t\t\tdepending on the type of resource.

    \n
    • \n
  • \n

    For alias resource record sets that refer to other resource record sets, a RecordDataEntry element \n\t\t\t\tcontains one value from the referenced resource record set. If the referenced resource record set contains multiple values, \n\t\t\t\tthe response includes one RecordDataEntry element for each value.

    \n
    • \n
", + "smithy.api#documentation": "

A value that Amazon Route 53 returned for this resource record set. A\n\t\t\t\tRecordDataEntry element is one of the following:

\n\t\t
    \n
  • \n\t\t\t\t

    For non-alias resource record sets, a RecordDataEntry element\n\t\t\t\t\tcontains one value in the resource record set. If the resource record set\n\t\t\t\t\tcontains multiple values, the response includes one RecordDataEntry\n\t\t\t\t\telement for each value.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For multiple resource record sets that have the same name and type, which\n\t\t\t\t\tincludes weighted, latency, geolocation, and failover, a\n\t\t\t\t\t\tRecordDataEntry element contains the value from the appropriate\n\t\t\t\t\tresource record set based on the request.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For alias resource record sets that refer to Amazon Web Services resources\n\t\t\t\t\tother than another resource record set, the RecordDataEntry element\n\t\t\t\t\tcontains an IP address or a domain name for the Amazon Web Services resource,\n\t\t\t\t\tdepending on the type of resource.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For alias resource record sets that refer to other resource record sets, a\n\t\t\t\t\t\tRecordDataEntry element contains one value from the referenced\n\t\t\t\t\tresource record set. If the referenced resource record set contains multiple\n\t\t\t\t\tvalues, the response includes one RecordDataEntry element for each\n\t\t\t\t\tvalue.

    \n\t\t\t
    • \n
", "smithy.api#length": { "min": 0, "max": 512 @@ -7223,13 +8020,13 @@ "Value": { "target": "com.amazonaws.route53#RData", "traits": { - "smithy.api#documentation": "

The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, \n\t\t\tif the current value does not match the actual value, an error is returned. For descriptions about how to format \n\t\t\tValue for different record types, see \n\t\t\tSupported DNS Resource Record Types \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

You can specify more than one value for all record types except CNAME and SOA.

\n\t\t \n\t\t\t

If you're creating an alias resource record set, omit Value.

\n\t\t ", + "smithy.api#documentation": "

The current or new DNS record value, not to exceed 4,000 characters. In the case of a\n\t\t\t\tDELETE action, if the current value does not match the actual value, an\n\t\t\terror is returned. For descriptions about how to format Value for different\n\t\t\trecord types, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n\t\t

You can specify more than one value for all record types except CNAME and\n\t\t\t\tSOA.

\n\t\t \n\t\t\t

If you're creating an alias resource record set, omit Value.

\n\t\t ", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Information specific to the resource record.

\n\t\t \n

If you're creating an alias resource record set, omit ResourceRecord.

\n " + "smithy.api#documentation": "

Information specific to the resource record.

\n\t\t \n\t\t\t

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecord.

\n\t\t " } }, "com.amazonaws.route53#ResourceRecordSet": { @@ -7238,82 +8035,85 @@ "Name": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. \n\t\t\tFor ListResourceRecordSets responses, the name of a record in the specified hosted zone.

\n\t\t\n\t\t

\n ChangeResourceRecordSets Only\n

\n\t\t

Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. \n\t\t\tIf you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats\n\t\t\twww.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

\n\t\t

For information about how to specify characters other than a-z, 0-9, and - (hyphen) \n\t\t\tand how to specify internationalized domain names, see DNS Domain Name Format in\n\t\t\tthe Amazon Route 53 Developer Guide.

\n\t\t

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. \n\t\t\tNote the following:

\n\t\t
    \n
  • \n\t\t\t\t

    The * must replace the entire label. For example, you can't specify *prod.example.com or \n\t\t\t\t\tprod*.example.com.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The * can't replace any of the middle labels, for example, marketing.*.example.com.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), \n\t\t\t\t\tnot as a wildcard.

    \n\t\t\t\t \n\t\t\t\t\t

    You can't use the * wildcard for resource records sets that have a type of NS.

    \n\t\t\t\t     \n\t\t\t
    • \n
\n\t\t

You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * \n\t\t\tfor one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for \n\t\t\texample, you can't specify prod*.example.com.

", + "smithy.api#documentation": "

For ChangeResourceRecordSets requests, the name of the record that you\n\t\t\twant to create, update, or delete. For ListResourceRecordSets responses,\n\t\t\tthe name of a record in the specified hosted zone.

\n\t\t

\n ChangeResourceRecordSets Only\n

\n\t\t

Enter a fully qualified domain name, for example, www.example.com. You\n\t\t\tcan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\n\t\t\tassumes that the domain name that you specify is fully qualified. This means that Route\n\t\t\t53 treats www.example.com (without a trailing dot) and\n\t\t\t\twww.example.com. (with a trailing dot) as identical.

\n\t\t

For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see DNS Domain Name\n\t\t\t\tFormat in the Amazon Route 53 Developer Guide.

\n\t\t

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name,\n\t\t\tfor example, *.example.com. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    The * must replace the entire label. For example, you can't specify\n\t\t\t\t\t\t*prod.example.com or prod*.example.com.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The * can't replace any of the middle labels, for example,\n\t\t\t\t\tmarketing.*.example.com.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you include * in any position other than the leftmost label in a domain\n\t\t\t\t\tname, DNS treats it as an * character (ASCII 42), not as a wildcard.

    \n\t\t\t\t \n\t\t\t\t\t

    You can't use the * wildcard for resource records sets that have a type of\n\t\t\t\t\t\tNS.

    \n\t\t\t\t     \n\t\t\t
    • \n
\n\t\t

You can use the * wildcard as the leftmost label in a domain name, for example,\n\t\t\t\t*.example.com. You can't use an * for one of the middle labels, for\n\t\t\texample, marketing.*.example.com. In addition, the * must replace the\n\t\t\tentire label; for example, you can't specify prod*.example.com.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

The DNS record type. For information about different record types and how data is encoded for them, see \n\t\t\tSupported DNS Resource Record Types \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS |MX | \n\t\t\tNAPTR | NS | PTR | SOA | SPF | SRV | TXT\n

\n\t\t

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | \n\t\t\tCNAME | MX | NAPTR | PTR | SPF | SRV | TXT. \n\t\t\tWhen creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the \n\t\t\tresource record sets in the group.

\n\t\t

Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | \n\t\t\tPTR | SPF | SRV | TXT\n

\n\t\t \n\t\t\t

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create \n\t\t\t\tresource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for \n\t\t\t\tAuthorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] \n\t\t\t\thave led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to \n\t\t\t\tuse it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.

\n\t\t \n\t\t

Values for alias resource record sets:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Amazon API Gateway custom regional APIs and edge-optimized APIs: \n A\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n CloudFront distributions: \n A\n

    \n\t\t\t\t

    If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, \n\t\t\t\t\tone with a value of A and one with a value of AAAA.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Amazon API Gateway environment that has a regionalized subdomain: A\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n ELB load balancers: \n A | AAAA\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Amazon S3 buckets: \n A\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Amazon Virtual Private Cloud interface VPC endpoints \n A\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Another resource record set in this hosted zone: Specify the type of the resource record set \n\t\t\t\t\tthat you're creating the alias for. All values are supported except NS and SOA.

    \n\t\t\t\t \n

    If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't \n\t\t\t\t\troute traffic to a record for which the value of Type is CNAME. This is because the alias record \n\t\t\t\t\tmust have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex \n\t\t\t\t\tisn't supported even for an alias record.

    \n     \n\t\t\t
    • \n
", + "smithy.api#documentation": "

The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.

\n\t\t

Valid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\t\tSPF | SRV | TXT\n

\n\t\t

Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT. When creating a group of weighted, latency,\n\t\t\tgeolocation, or failover resource record sets, specify the same value for all of the\n\t\t\tresource record sets in the group.

\n\t\t

Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\t\tSPF | SRV | TXT\n

\n\t\t \n\t\t\t

SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.

\n\t\t \n\t\t

Values for alias resource record sets:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Amazon API Gateway custom regional APIs and\n\t\t\t\t\t\tedge-optimized APIs:\n\t\t\t\t\t A\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n CloudFront distributions:\n\t\t\t\t\t A\n

    \n\t\t\t\t

    If IPv6 is enabled for the distribution, create two resource record sets to\n\t\t\t\t\troute traffic to your distribution, one with a value of A and one\n\t\t\t\t\twith a value of AAAA.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Amazon API Gateway environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n ELB load balancers:\n\t\t\t\t\t A | AAAA\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Amazon S3 buckets:\n\t\t\t\t\t A\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Amazon Virtual Private Cloud interface VPC\n\t\t\t\t\t\tendpoints\n\t\t\t\t\t A\n

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Another resource record set in this hosted\n\t\t\t\t\t\tzone: Specify the type of the resource record set that you're\n\t\t\t\t\tcreating the alias for. All values are supported except NS and\n\t\t\t\t\t\tSOA.

    \n\t\t\t\t \n\t\t\t\t\t

    If you're creating an alias record that has the same name as the hosted\n\t\t\t\t\t\tzone (known as the zone apex), you can't route traffic to a record for which\n\t\t\t\t\t\tthe value of Type is CNAME. This is because the\n\t\t\t\t\t\talias record must have the same type as the record you're routing traffic\n\t\t\t\t\t\tto, and creating a CNAME record for the zone apex isn't supported even for\n\t\t\t\t\t\tan alias record.

    \n\t\t\t\t     \n\t\t\t
    • \n
", "smithy.api#required": {} } }, "SetIdentifier": { "target": "com.amazonaws.route53#ResourceRecordSetIdentifier", "traits": { - "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than simple: An identifier that differentiates among \n\t\t\tmultiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named \n\t\t\tacme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier \n\t\t\tmust be unique for each resource record set.

\n\t\t

For information about routing policies, see \n\t\t\tChoosing a Routing Policy \n\t\t\tin the Amazon Route 53 Developer Guide.

" + "smithy.api#documentation": "

\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: An identifier that differentiates among multiple resource record\n\t\t\tsets that have the same combination of name and type, such as multiple weighted resource\n\t\t\trecord sets named acme.example.com that have a type of A. In a group of resource record\n\t\t\tsets that have the same name and type, the value of SetIdentifier must be\n\t\t\tunique for each resource record set.

\n\t\t

For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.

" } }, "Weight": { "target": "com.amazonaws.route53#ResourceRecordSetWeight", "traits": { - "smithy.api#documentation": "

\n Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, \n\t\t\ta value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the \n\t\t\tsum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries \n\t\t\tbased on the ratio of a resource's weight to the total. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    You must specify a value for the Weight element for every weighted resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can only specify one ResourceRecord per weighted resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can't create latency, failover, or geolocation resource record sets that have the same values for the \n\t\t\t\t\tName and Type elements as weighted resource record sets.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can create a maximum of 100 weighted resource record sets that have the same values for the Name and \n\t\t\t\t\tType elements.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a \n\t\t\t\t\tresource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set \n\t\t\t\t\t\tWeight to 0 for all resource record sets that have the same combination of DNS name and type, \n\t\t\t\t\ttraffic is routed to all resources with equal probability.

    \n\t\t\t\t

    The effect of setting Weight to 0 is different when you associate health checks with weighted \n\t\t\t\t\tresource record sets. For more information, see \n\t\t\t\t\tOptions for Configuring Route 53 Active-Active and Active-Passive Failover \n\t\t\t\t\tin the Amazon Route 53 Developer Guide.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

\n Weighted resource record sets only: Among resource record sets\n\t\t\tthat have the same combination of DNS name and type, a value that determines the\n\t\t\tproportion of DNS queries that Amazon Route 53 responds to using the current resource\n\t\t\trecord set. Route 53 calculates the sum of the weights for the resource record sets that\n\t\t\thave the same combination of DNS name and type. Route 53 then responds to queries based\n\t\t\ton the ratio of a resource's weight to the total. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    You must specify a value for the Weight element for every\n\t\t\t\t\tweighted resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can only specify one ResourceRecord per weighted resource\n\t\t\t\t\trecord set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can't create latency, failover, or geolocation resource record sets that\n\t\t\t\t\thave the same values for the Name and Type elements as\n\t\t\t\t\tweighted resource record sets.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can create a maximum of 100 weighted resource record sets that have the\n\t\t\t\t\tsame values for the Name and Type elements.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For weighted (but not weighted alias) resource record sets, if you set\n\t\t\t\t\t\tWeight to 0 for a resource record set, Route 53\n\t\t\t\t\tnever responds to queries with the applicable value for that resource record\n\t\t\t\t\tset. However, if you set Weight to 0 for all resource\n\t\t\t\t\trecord sets that have the same combination of DNS name and type, traffic is\n\t\t\t\t\trouted to all resources with equal probability.

    \n\t\t\t\t

    The effect of setting Weight to 0 is different when\n\t\t\t\t\tyou associate health checks with weighted resource record sets. For more\n\t\t\t\t\tinformation, see Options for Configuring Route 53 Active-Active and Active-Passive\n\t\t\t\t\t\tFailover in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.

    \n\t\t\t
    • \n
" } }, "Region": { "target": "com.amazonaws.route53#ResourceRecordSetRegion", "traits": { - "smithy.api#documentation": "

\n Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this \n\t\t\tresource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is \n\t\t\treferred to by an IP address or a DNS domain name, depending on the record type.

\n\t\t \n\t\t\t

Although creating latency and latency alias resource record sets in a private hosted zone is allowed, \n\t\t\t\tit's not supported.

\n\t\t \n\t\t

When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 \n\t\t\tselects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then \n\t\t\treturns the value that is associated with the selected resource record set.

\n\t\t

Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    You can only specify one ResourceRecord per latency resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can only create one latency resource record set for each Amazon EC2 Region.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the \n\t\t\t\t\tbest latency from among the regions that you create latency resource record sets for.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can't create non-latency resource record sets that have the same values for the Name and Type \n\t\t\t\t\telements as latency resource record sets.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

\n Latency-based resource record sets only: The Amazon EC2 Region\n\t\t\twhere you created the resource that this resource record set refers to. The resource\n\t\t\ttypically is an Amazon Web Services resource, such as an EC2 instance or an ELB load\n\t\t\tbalancer, and is referred to by an IP address or a DNS domain name, depending on the\n\t\t\trecord type.

\n\t\t \n\t\t\t

Although creating latency and latency alias resource record sets in a private\n\t\t\t\thosted zone is allowed, it's not supported.

\n\t\t \n\t\t

When Amazon Route 53 receives a DNS query for a domain name and type for which you\n\t\t\thave created latency resource record sets, Route 53 selects the latency resource record\n\t\t\tset that has the lowest latency between the end user and the associated Amazon EC2\n\t\t\tRegion. Route 53 then returns the value that is associated with the selected resource\n\t\t\trecord set.

\n\t\t

Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    You can only specify one ResourceRecord per latency resource\n\t\t\t\t\trecord set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can only create one latency resource record set for each Amazon EC2\n\t\t\t\t\tRegion.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You aren't required to create latency resource record sets for all Amazon EC2\n\t\t\t\t\tRegions. Route 53 will choose the region with the best latency from among the\n\t\t\t\t\tregions that you create latency resource record sets for.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    You can't create non-latency resource record sets that have the same values\n\t\t\t\t\tfor the Name and Type elements as latency resource\n\t\t\t\t\trecord sets.

    \n\t\t\t
    • \n
" } }, "GeoLocation": { "target": "com.amazonaws.route53#GeoLocation", "traits": { - "smithy.api#documentation": "

\n Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries \n\t\t\tbased on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address \n\t\t\tof 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of \n\t\t\tAF.

\n\t\t \n\t\t\t

Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, \n\t\t\t\tit's not supported.

\n\t\t \n\t\t

If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and \n\t\t\tone for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a \n\t\t\tcontinent to one resource and to route queries for a country on that continent to a different resource.

\n\t\t

You can't create two geolocation resource record sets that specify the same geographic location.

\n\t\t

The value * in the CountryCode element matches all geographic locations that aren't specified in other \n\t\t\tgeolocation resource record sets that have the same values for the Name and Type elements.

\n\t\t \n\t\t\t

Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, \n\t\t\t\tso even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations \n\t\t\t\tthat it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. \n\t\t\t\tTwo groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't \n\t\t\t\tcreated geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a \n\t\t\t\t* resource record set, Route 53 returns a \"no answer\" response for queries from those locations.

\n\t\t \n\t\t

You can't create non-geolocation resource record sets that have the same values for the Name and Type elements \n\t\t\tas geolocation resource record sets.

" + "smithy.api#documentation": "

\n Geolocation resource record sets only: A complex type that lets\n\t\t\tyou control how Amazon Route 53 responds to DNS queries based on the geographic origin\n\t\t\tof the query. For example, if you want all queries from Africa to be routed to a web\n\t\t\tserver with an IP address of 192.0.2.111, create a resource record set with\n\t\t\ta Type of A and a ContinentCode of\n\t\t\t\tAF.

\n\t\t \n\t\t\t

Although creating geolocation and geolocation alias resource record sets in a\n\t\t\t\tprivate hosted zone is allowed, it's not supported.

\n\t\t \n\t\t

If you create separate resource record sets for overlapping geographic regions (for\n\t\t\texample, one resource record set for a continent and one for a country on the same\n\t\t\tcontinent), priority goes to the smallest geographic region. This allows you to route\n\t\t\tmost queries for a continent to one resource and to route queries for a country on that\n\t\t\tcontinent to a different resource.

\n\t\t

You can't create two geolocation resource record sets that specify the same geographic\n\t\t\tlocation.

\n\t\t

The value * in the CountryCode element matches all\n\t\t\tgeographic locations that aren't specified in other geolocation resource record sets\n\t\t\tthat have the same values for the Name and Type\n\t\t\telements.

\n\t\t \n\t\t\t

Geolocation works by mapping IP addresses to locations. However, some IP addresses\n\t\t\t\taren't mapped to geographic locations, so even if you create geolocation resource\n\t\t\t\trecord sets that cover all seven continents, Route 53 will receive some DNS queries\n\t\t\t\tfrom locations that it can't identify. We recommend that you create a resource\n\t\t\t\trecord set for which the value of CountryCode is *. Two\n\t\t\t\tgroups of queries are routed to the resource that you specify in this record:\n\t\t\t\tqueries that come from locations for which you haven't created geolocation resource\n\t\t\t\trecord sets and queries from IP addresses that aren't mapped to a location. If you\n\t\t\t\tdon't create a * resource record set, Route 53 returns a \"no answer\"\n\t\t\t\tresponse for queries from those locations.

\n\t\t \n\t\t

You can't create non-geolocation resource record sets that have the same values for\n\t\t\tthe Name and Type elements as geolocation resource record\n\t\t\tsets.

" } }, "Failover": { "target": "com.amazonaws.route53#ResourceRecordSetFailover", "traits": { - "smithy.api#documentation": "

\n Failover resource record sets only: To configure failover, you add the Failover element to \n\t\t\ttwo resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other\n\t\t\tresource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the \n\t\t\thealth check that you want Amazon Route 53 to perform for each resource record set.

\n\t\t

Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both \n\t\t\tresource record sets:

\n\t\t
    \n
  • \n\t\t\t\t

    When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the \n\t\t\t\t\tprimary resource record set regardless of the health of the secondary resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to \n\t\t\t\t\tDNS queries with the applicable value from the secondary resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the \n\t\t\t\t\tprimary resource record set regardless of the health of the primary resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set \n\t\t\t\t\tis unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true \n\t\t\t\t\tregardless of the health of the associated endpoint.

    \n\t\t\t
    • \n
\n\t\t

You can't create non-failover resource record sets that have the same values for the Name and Type elements \n\t\t\tas failover resource record sets.

\n\t\t

For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

\n\t\t

For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

\n\t\t " + "smithy.api#documentation": "

\n Failover resource record sets only: To configure failover, you\n\t\t\tadd the Failover element to two resource record sets. For one resource\n\t\t\trecord set, you specify PRIMARY as the value for Failover; for\n\t\t\tthe other resource record set, you specify SECONDARY. In addition, you\n\t\t\tinclude the HealthCheckId element and specify the health check that you\n\t\t\twant Amazon Route 53 to perform for each resource record set.

\n\t\t

Except where noted, the following failover behaviors assume that you have included the\n\t\t\t\tHealthCheckId element in both resource record sets:

\n\t\t
    \n
  • \n\t\t\t\t

    When the primary resource record set is healthy, Route 53 responds to DNS\n\t\t\t\t\tqueries with the applicable value from the primary resource record set\n\t\t\t\t\tregardless of the health of the secondary resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    When the primary resource record set is unhealthy and the secondary resource\n\t\t\t\t\trecord set is healthy, Route 53 responds to DNS queries with the applicable\n\t\t\t\t\tvalue from the secondary resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    When the secondary resource record set is unhealthy, Route 53 responds to DNS\n\t\t\t\t\tqueries with the applicable value from the primary resource record set\n\t\t\t\t\tregardless of the health of the primary resource record set.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you omit the HealthCheckId element for the secondary resource\n\t\t\t\t\trecord set, and if the primary resource record set is unhealthy, Route 53 always\n\t\t\t\t\tresponds to DNS queries with the applicable value from the secondary resource\n\t\t\t\t\trecord set. This is true regardless of the health of the associated\n\t\t\t\t\tendpoint.

    \n\t\t\t
    • \n
\n\t\t

You can't create non-failover resource record sets that have the same values for the\n\t\t\t\tName and Type elements as failover resource record\n\t\t\tsets.

\n\t\t

For failover alias resource record sets, you must also include the\n\t\t\t\tEvaluateTargetHealth element and set the value to true.

\n\t\t

For more information about configuring failover for Route 53, see the following topics\n\t\t\tin the Amazon Route 53 Developer Guide:

\n\t\t " } }, "MultiValueAnswer": { "target": "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer", "traits": { - "smithy.api#documentation": "

\n Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, \n\t\t\tsuch as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. \n\t\t\tNote the following:

\n\t\t
    \n
  • \n

    If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries \n\t\t\t\twith the corresponding IP address only when the health check is healthy.

    \n
    • \n
  • \n

    If you don't associate a health check with a multivalue answer record, Route 53 always considers the record \n\t\t\t\tto be healthy.

    \n
    • \n
  • \n

    Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, \n\t\t\t\tRoute 53 responds to all DNS queries with all the healthy records.

    \n
    • \n
  • \n

    If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of \n\t\t\t\thealthy records.

    \n
    • \n
  • \n

    When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

    \n
    • \n
  • \n

    If a resource becomes unavailable after a resolver caches a response, client software typically tries another \n\t\t\t\tof the IP addresses in the response.

    \n
    • \n
\n\t\t

You can't create multivalue answer alias records.

" + "smithy.api#documentation": "

\n Multivalue answer resource record sets only: To route traffic\n\t\t\tapproximately randomly to multiple resources, such as web servers, create one multivalue\n\t\t\tanswer record for each resource and specify true for\n\t\t\t\tMultiValueAnswer. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    If you associate a health check with a multivalue answer resource record set,\n\t\t\t\t\tAmazon Route 53 responds to DNS queries with the corresponding IP address only\n\t\t\t\t\twhen the health check is healthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you don't associate a health check with a multivalue answer record, Route\n\t\t\t\t\t53 always considers the record to be healthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Route 53 responds to DNS queries with up to eight healthy records; if you have\n\t\t\t\t\teight or fewer healthy records, Route 53 responds to all DNS queries with all\n\t\t\t\t\tthe healthy records.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you have more than eight healthy records, Route 53 responds to different\n\t\t\t\t\tDNS resolvers with different combinations of healthy records.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    When all records are unhealthy, Route 53 responds to DNS queries with up to\n\t\t\t\t\teight unhealthy records.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If a resource becomes unavailable after a resolver caches a response, client\n\t\t\t\t\tsoftware typically tries another of the IP addresses in the response.

    \n\t\t\t
    • \n
\n\t\t

You can't create multivalue answer alias records.

" } }, "TTL": { "target": "com.amazonaws.route53#TTL", "traits": { - "smithy.api#documentation": "

The resource record cache time to live (TTL), in seconds. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL \n\t\t\t\t\tfor the alias target.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), \n\t\t\t\t\twe recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the \n\t\t\t\t\talias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the \n\t\t\t\t\tnon-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for \n\t\t\t\t\tload balancers) will change the effect of the values that you specify for Weight.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

The resource record cache time to live (TTL), in seconds. Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    If you're creating or updating an alias resource record set, omit\n\t\t\t\t\t\tTTL. Amazon Route 53 uses the value of TTL for the\n\t\t\t\t\talias target.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you're associating this resource record set with a health check (if you're\n\t\t\t\t\tadding a HealthCheckId element), we recommend that you specify a\n\t\t\t\t\t\tTTL of 60 seconds or less so clients respond quickly to changes\n\t\t\t\t\tin health status.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    All of the resource record sets in a group of weighted resource record sets\n\t\t\t\t\tmust have the same value for TTL.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If a group of weighted resource record sets includes one or more weighted\n\t\t\t\t\talias resource record sets for which the alias target is an ELB load balancer,\n\t\t\t\t\twe recommend that you specify a TTL of 60 seconds for all of the\n\t\t\t\t\tnon-alias weighted resource record sets that have the same name and type. Values\n\t\t\t\t\tother than 60 seconds (the TTL for load balancers) will change the effect of the\n\t\t\t\t\tvalues that you specify for Weight.

    \n\t\t\t
    • \n
" } }, "ResourceRecords": { "target": "com.amazonaws.route53#ResourceRecords", "traits": { - "smithy.api#documentation": "

Information about the resource records to act upon.

\n\t\t \n

If you're creating an alias resource record set, omit ResourceRecords.

\n " + "smithy.api#documentation": "

Information about the resource records to act upon.

\n\t\t \n\t\t\t

If you're creating an alias resource record set, omit\n\t\t\t\tResourceRecords.

\n\t\t " } }, "AliasTarget": { "target": "com.amazonaws.route53#AliasTarget", "traits": { - "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an \n\t\t\tAmazon S3 bucket, that you want to route traffic to.

\n\t\t

If you're creating resource records sets for a private hosted zone, note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For information about creating failover resource record sets in a private hosted zone, see \n\t\t\t\t\tConfiguring Failover in a Private Hosted Zone in the\n\t\t\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.

\n\t\t

If you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:

\n\t\t
    \n
  • \n\t\t\t\t

    You can't create an alias resource record set in a private hosted zone to\n\t\t\t\t\troute traffic to a CloudFront distribution.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    Creating geolocation alias resource record sets or latency alias resource\n\t\t\t\t\trecord sets in a private hosted zone is unsupported.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    For information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see Configuring Failover in a Private Hosted Zone in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.

    \n\t\t\t
    • \n
" } }, "HealthCheckId": { "target": "com.amazonaws.route53#HealthCheckId", "traits": { - "smithy.api#documentation": "

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a \n\t\t\thealth check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

\n\t\t

Route 53 determines whether a resource record set is healthy based on one of the following:

\n\t\t
    \n
  • \n

    By periodically sending a request to the endpoint that is specified in the health check

    \n
    • \n
  • \n

    By aggregating the status of a specified group of health checks (calculated health checks)

    \n
    • \n
  • \n

    By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

    \n
    • \n
\n\n\t\t \n\t\t\t

Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint \n\t\t\t\tspecified by the IP address in the Value element. When you add a HealthCheckId element to a \n\t\t\t\tresource record set, Route 53 checks the health of the endpoint that you specified in the health check.

\n\t\t \n\n\t\t

For more information, see the following topics in the Amazon Route 53 Developer Guide:

\n\t\t \n\t\t\n\t\t

\n When to Specify HealthCheckId\n

\n\t\t

Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets \n\t\t\tto respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks \n\t\t\tmakes sense only in the following configurations:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Non-alias resource record sets: You're checking the health of a group of non-alias \n\t\t\t\t\tresource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com \n\t\t\t\t\twith a type of A) and you specify health check IDs for all the resource record sets.

    \n\t\t\t\t

    If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it \n\t\t\t\t\tresponds to DNS queries with.

    \n\t\t\t\t

    If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value \n\t\t\t\t\tfor that resource record set.

    \n\t\t\t\t

    If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets \n\t\t\t\t\tin the group healthy and responds to DNS queries accordingly.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Alias resource record sets: You specify the following settings:

    \n\t\t\t\t
      \n
    • \n

      You set EvaluateTargetHealth to true for an alias resource record set in a group of \n\t\t\t\t\t\tresource record sets that have the same routing policy, name, and type (such as multiple weighted records named \n\t\t\t\t\t\twww.example.com with a type of A).

      \n
      • \n
    • \n

      You configure the alias resource record set to route traffic to a non-alias resource record set \n\t\t\t\t\t\tin the same hosted zone.

      \n
      • \n
    • \n

      You specify a health check ID for the non-alias resource record set.

      \n
      • \n
    \n\t\t\t\t

    If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the \n\t\t\t\t\talias record among the records that it responds to DNS queries with.

    \n\t\t\t\t

    If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

    \n\t\t\t\t \n\t\t\t\t\t

    The alias resource record set can also route traffic to a group of non-alias resource record sets \n\t\t\t\t\t\tthat have the same routing policy, name, and type. In that configuration, associate health checks with all of the \n\t\t\t\t\t\tresource record sets in the group of non-alias resource record sets.

    \n\t\t\t\t     \n\t\t\t
    • \n
\n\t\t\n\t\t

\n Geolocation Routing\n

\n\t\t

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated \n\t\t\tgeographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, \n\t\t\tfor North America, and a resource record set that has * for CountryCode is *, which applies to \n\t\t\tall locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the \n\t\t\tfollowing order until it finds a resource record set for which the endpoint is healthy:

\n\t\t\t
    \n
  • \n

    The United States

    \n
    • \n
  • \n

    North America

    \n
    • \n
  • \n

    The default resource record set

    \n
    • \n
\n\t\t\n\t\t

\n Specifying the Health Check Endpoint by Domain Name\n

\n\t\t

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. \n\t\t\tFor example, create a health check for each HTTP server that is serving content for www.example.com. For the \n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), \n\t\t\tnot the name of the resource record sets (www.example.com).

\n\t\t \n\t\t\t

Health check results will be unpredictable if you do the following:

\n\t\t\t
    \n
  • \n

    Create a health check that has the same value for FullyQualifiedDomainName as the name of a \n\t\t\t\t\tresource record set.

    \n
    • \n
  • \n

    Associate that health check with the resource record set.

    \n
    • \n
\n\t\t " + "smithy.api#documentation": "

If you want Amazon Route 53 to return this resource record set in response to a DNS\n\t\t\tquery only when the status of a health check is healthy, include the\n\t\t\t\tHealthCheckId element and specify the ID of the applicable health\n\t\t\tcheck.

\n\t\t

Route 53 determines whether a resource record set is healthy based on one of the\n\t\t\tfollowing:

\n\t\t
    \n
  • \n\t\t\t\t

    By periodically sending a request to the endpoint that is specified in the\n\t\t\t\t\thealth check

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By aggregating the status of a specified group of health checks (calculated\n\t\t\t\t\thealth checks)

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    By determining the current state of a CloudWatch alarm (CloudWatch metric\n\t\t\t\t\thealth checks)

    \n\t\t\t
    • \n
\n\t\t \n\t\t\t

Route 53 doesn't check the health of the endpoint that is specified in the\n\t\t\t\tresource record set, for example, the endpoint specified by the IP address in the\n\t\t\t\t\tValue element. When you add a HealthCheckId element to\n\t\t\t\ta resource record set, Route 53 checks the health of the endpoint that you specified\n\t\t\t\tin the health check.

\n\t\t \n\t\t

For more information, see the following topics in the Amazon Route 53\n\t\t\t\tDeveloper Guide:

\n\t\t \n\t\t

\n When to Specify HealthCheckId\n

\n\t\t

Specifying a value for HealthCheckId is useful only when Route 53 is\n\t\t\tchoosing between two or more resource record sets to respond to a DNS query, and you\n\t\t\twant Route 53 to base the choice in part on the status of a health check. Configuring\n\t\t\thealth checks makes sense only in the following configurations:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Non-alias resource record sets: You're\n\t\t\t\t\tchecking the health of a group of non-alias resource record sets that have the\n\t\t\t\t\tsame routing policy, name, and type (such as multiple weighted records named\n\t\t\t\t\twww.example.com with a type of A) and you specify health check IDs for all the\n\t\t\t\t\tresource record sets.

    \n\t\t\t\t

    If the health check status for a resource record set is healthy, Route 53\n\t\t\t\t\tincludes the record among the records that it responds to DNS queries\n\t\t\t\t\twith.

    \n\t\t\t\t

    If the health check status for a resource record set is unhealthy, Route 53\n\t\t\t\t\tstops responding to DNS queries using the value for that resource record\n\t\t\t\t\tset.

    \n\t\t\t\t

    If the health check status for all resource record sets in the group is\n\t\t\t\t\tunhealthy, Route 53 considers all resource record sets in the group healthy and\n\t\t\t\t\tresponds to DNS queries accordingly.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Alias resource record sets: You specify the\n\t\t\t\t\tfollowing settings:

    \n\t\t\t\t
      \n
    • \n\t\t\t\t\t\t

      You set EvaluateTargetHealth to true for an alias\n\t\t\t\t\t\t\tresource record set in a group of resource record sets that have the\n\t\t\t\t\t\t\tsame routing policy, name, and type (such as multiple weighted records\n\t\t\t\t\t\t\tnamed www.example.com with a type of A).

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      You configure the alias resource record set to route traffic to a\n\t\t\t\t\t\t\tnon-alias resource record set in the same hosted zone.

      \n\t\t\t\t\t
      • \n
    • \n\t\t\t\t\t\t

      You specify a health check ID for the non-alias resource record set.\n\t\t\t\t\t\t

      \n\t\t\t\t\t
      • \n
    \n\t\t\t\t

    If the health check status is healthy, Route 53 considers the alias resource\n\t\t\t\t\trecord set to be healthy and includes the alias record among the records that it\n\t\t\t\t\tresponds to DNS queries with.

    \n\t\t\t\t

    If the health check status is unhealthy, Route 53 stops responding to DNS\n\t\t\t\t\tqueries using the alias resource record set.

    \n\t\t\t\t \n\t\t\t\t\t

    The alias resource record set can also route traffic to a\n\t\t\t\t\t\t\tgroup of non-alias resource record sets that have\n\t\t\t\t\t\tthe same routing policy, name, and type. In that configuration, associate\n\t\t\t\t\t\thealth checks with all of the resource record sets in the group of non-alias\n\t\t\t\t\t\tresource record sets.

    \n\t\t\t\t     \n\t\t\t
    • \n
\n\t\t

\n Geolocation Routing\n

\n\t\t

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\n\t\t\ta resource record set for the larger, associated geographic region. For example, suppose\n\t\t\tyou have resource record sets for a state in the United States, for the entire United\n\t\t\tStates, for North America, and a resource record set that has * for\n\t\t\t\tCountryCode is *, which applies to all locations. If the\n\t\t\tendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\n\t\t\tresource record sets in the following order until it finds a resource record set for\n\t\t\twhich the endpoint is healthy:

\n\t\t
    \n
  • \n\t\t\t\t

    The United States

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    North America

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The default resource record set

    \n\t\t\t
    • \n
\n\t\t

\n Specifying the Health Check Endpoint by Domain\n\t\t\tName\n

\n\t\t

If your health checks specify the endpoint only by domain name, we recommend that you\n\t\t\tcreate a separate health check for each endpoint. For example, create a health check for\n\t\t\teach HTTP server that is serving content for www.example.com.\n\t\t\tFor the value of FullyQualifiedDomainName, specify the domain name of the\n\t\t\tserver (such as us-east-2-www.example.com), not the name of the resource\n\t\t\trecord sets (www.example.com).

\n\t\t \n\t\t\t

Health check results will be unpredictable if you do the following:

\n\t\t\t
    \n
  • \n\t\t\t\t\t

    Create a health check that has the same value for\n\t\t\t\t\t\t\tFullyQualifiedDomainName as the name of a resource record\n\t\t\t\t\t\tset.

    \n\t\t\t\t
    • \n
  • \n\t\t\t\t\t

    Associate that health check with the resource record set.

    \n\t\t\t\t
    • \n
\n\t\t " } }, "TrafficPolicyInstanceId": { "target": "com.amazonaws.route53#TrafficPolicyInstanceId", "traits": { - "smithy.api#documentation": "

When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID \n\t\t\tof the traffic policy instance that Route 53 created this resource record set for.

\n\t\t \n

To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. \n\t\t\tRoute 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, \n\t\t\tRoute 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

\n\t\t " + "smithy.api#documentation": "

When you create a traffic policy instance, Amazon Route 53 automatically creates a\n\t\t\tresource record set. TrafficPolicyInstanceId is the ID of the traffic\n\t\t\tpolicy instance that Route 53 created this resource record set for.

\n\t\t \n\t\t\t

To delete the resource record set that is associated with a traffic policy\n\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Route 53 will delete the\n\t\t\t\tresource record set automatically. If you delete the resource record set by using\n\t\t\t\t\tChangeResourceRecordSets, Route 53 doesn't automatically delete the\n\t\t\t\ttraffic policy instance, and you'll continue to be charged for it even though it's\n\t\t\t\tno longer in use.

\n\t\t " } + }, + "CidrRoutingConfig": { + "target": "com.amazonaws.route53#CidrRoutingConfig" } }, "traits": { @@ -7496,7 +8296,7 @@ "ResourceType": { "target": "com.amazonaws.route53#TagResourceType", "traits": { - "smithy.api#documentation": "

The type of the resource.

\n\t\t
    \n
  • \n

    The resource type for health checks is healthcheck.

    \n
    • \n
  • \n

    The resource type for hosted zones is hostedzone.

    \n
    • \n
" + "smithy.api#documentation": "

The type of the resource.

\n\t\t
    \n
  • \n\t\t\t\t

    The resource type for health checks is healthcheck.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    The resource type for hosted zones is hostedzone.

    \n\t\t\t
    • \n
" } }, "ResourceId": { @@ -7540,20 +8340,20 @@ "Type": { "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", "traits": { - "smithy.api#documentation": "

The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the maximum number of hosted zones that you can associate \n\t\t\twith the specified reusable delegation set.

", + "smithy.api#documentation": "

The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the\n\t\t\tmaximum number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.route53#LimitValue", "traits": { - "smithy.api#documentation": "

The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET limit.

", + "smithy.api#documentation": "

The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET\n\t\t\tlimit.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and the current value for that limit.

" + "smithy.api#documentation": "

A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.

" } }, "com.amazonaws.route53#ReusableDelegationSetLimitType": { @@ -7681,18 +8481,18 @@ "Status": { "target": "com.amazonaws.route53#Status", "traits": { - "smithy.api#documentation": "

A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.

" + "smithy.api#documentation": "

A description of the status of the health check endpoint as reported by one of the\n\t\t\tAmazon Route 53 health checkers.

" } }, "CheckedTime": { "target": "com.amazonaws.route53#TimeStamp", "traits": { - "smithy.api#documentation": "

The date and time that the health checker performed the health check in \n\t\t\tISO 8601 format and Coordinated Universal Time (UTC). \n\t\t\tFor example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

" + "smithy.api#documentation": "

The date and time that the health checker performed the health check in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.

" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the status that one Amazon Route 53 health checker reports and the time of the health check.

" + "smithy.api#documentation": "

A complex type that contains the status that one Amazon Route 53 health checker\n\t\t\treports and the time of the health check.

" } }, "com.amazonaws.route53#SubnetMask": { @@ -7720,18 +8520,18 @@ "Key": { "target": "com.amazonaws.route53#TagKey", "traits": { - "smithy.api#documentation": "

The value of Key depends on the operation that you want to perform:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Edit a tag: Key is the name of the tag that you want to change the Value for.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Delete a key: Key is the name of the tag you want to remove.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, \n\t\t\t\t\tthe list of your health checks includes a Name column that lets you see the name that you've \n\t\t\t\t\tgiven to each health check.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

The value of Key depends on the operation that you want to\n\t\t\tperform:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Add a tag to a health check or hosted zone:\n\t\t\t\t\t\tKey is the name that you want to give the new tag.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Edit a tag: Key is the name of\n\t\t\t\t\tthe tag that you want to change the Value for.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Delete a key: Key is the name\n\t\t\t\t\tof the tag you want to remove.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Give a name to a health check: Edit the\n\t\t\t\t\tdefault Name tag. In the Amazon Route 53 console, the list of your\n\t\t\t\t\thealth checks includes a Name column that lets\n\t\t\t\t\tyou see the name that you've given to each health check.

    \n\t\t\t
    • \n
" } }, "Value": { "target": "com.amazonaws.route53#TagValue", "traits": { - "smithy.api#documentation": "

The value of Value depends on the operation that you want to perform:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Add a tag to a health check or hosted zone: Value is the value that you want to give \n\t\t\t\t\tthe new tag.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Edit a tag: Value is the new value that you want to assign the tag.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

The value of Value depends on the operation that you want to\n\t\t\tperform:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Add a tag to a health check or hosted zone:\n\t\t\t\t\t\tValue is the value that you want to give the new tag.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Edit a tag: Value is the new\n\t\t\t\t\tvalue that you want to assign the tag.

    \n\t\t\t
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.

" + "smithy.api#documentation": "

A complex type that contains information about a tag that you want to add or edit for\n\t\t\tthe specified health check or hosted zone.

" } }, "com.amazonaws.route53#TagKey": { @@ -7838,7 +8638,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify \n\t\t\tthe IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

\n\t\t

This call only supports querying public hosted zones.

", + "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

\n\t\t

This call only supports querying public hosted zones.

", "smithy.api#http": { "method": "GET", "uri": "/2013-04-01/testdnsanswer", @@ -7852,7 +8652,7 @@ "HostedZoneId": { "target": "com.amazonaws.route53#ResourceId", "traits": { - "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.

", + "smithy.api#documentation": "

The ID of the hosted zone that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", "smithy.api#httpQuery": "hostedzoneid", "smithy.api#required": {} } @@ -7860,7 +8660,7 @@ "RecordName": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

The name of the resource record set that you want Amazon Route 53 to simulate a query for.

", + "smithy.api#documentation": "

The name of the resource record set that you want Amazon Route 53 to simulate a query\n\t\t\tfor.

", "smithy.api#httpQuery": "recordname", "smithy.api#required": {} } @@ -7876,27 +8676,27 @@ "ResolverIP": { "target": "com.amazonaws.route53#IPAddress", "traits": { - "smithy.api#documentation": "

If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. \n\t\t\tIf you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region \n\t\t\t(us-east-1).

", + "smithy.api#documentation": "

If you want to simulate a request from a specific DNS resolver, specify the IP address\n\t\t\tfor that resolver. If you omit this value, TestDnsAnswer uses the IP\n\t\t\taddress of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region\n\t\t\t\t(us-east-1).

", "smithy.api#httpQuery": "resolverip" } }, "EDNS0ClientSubnetIP": { "target": "com.amazonaws.route53#IPAddress", "traits": { - "smithy.api#documentation": "

If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client \n\t\t\tin the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

", + "smithy.api#documentation": "

If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or\n\t\t\tIPv6 address of a client in the applicable location, for example,\n\t\t\t\t192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

", "smithy.api#httpQuery": "edns0clientsubnetip" } }, "EDNS0ClientSubnetMask": { "target": "com.amazonaws.route53#SubnetMask", "traits": { - "smithy.api#documentation": "

If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address \n\t\t\tthat you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for \n\t\t\tedns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from \n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.

\n\t\t

The range of valid values depends on whether edns0clientsubnetip is an IPv4 or an IPv6 address:

\n\t\t
    \n
  • \n

    \n IPv4: Specify a value between 0 and 32

    \n
    • \n
  • \n

    \n IPv6: Specify a value between 0 and 128

    \n
    • \n
", + "smithy.api#documentation": "

If you specify an IP address for edns0clientsubnetip, you can optionally\n\t\t\tspecify the number of bits of the IP address that you want the checking tool to include\n\t\t\tin the DNS query. For example, if you specify 192.0.2.44 for\n\t\t\t\tedns0clientsubnetip and 24 for\n\t\t\t\tedns0clientsubnetmask, the checking tool will simulate a request from\n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6\n\t\t\taddresses.

\n\t\t

The range of valid values depends on whether edns0clientsubnetip is an\n\t\t\tIPv4 or an IPv6 address:

\n\t\t
    \n
  • \n\t\t\t\t

    \n IPv4: Specify a value between 0 and 32

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n IPv6: Specify a value between 0 and\n\t\t\t\t\t128

    \n\t\t\t
    • \n
", "smithy.api#httpQuery": "edns0clientsubnetmask" } } }, "traits": { - "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify \n\t\t\tthe IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

" + "smithy.api#documentation": "

Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.

" } }, "com.amazonaws.route53#TestDNSAnswerResponse": { @@ -7926,27 +8726,27 @@ "RecordData": { "target": "com.amazonaws.route53#RecordData", "traits": { - "smithy.api#documentation": "

A list that contains values that Amazon Route 53 returned for this resource record set.

", + "smithy.api#documentation": "

A list that contains values that Amazon Route 53 returned for this resource record\n\t\t\tset.

", "smithy.api#required": {} } }, "ResponseCode": { "target": "com.amazonaws.route53#DNSRCode", "traits": { - "smithy.api#documentation": "

A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that \n\t\t\tthe request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. \n\t\t\tFor a list of possible response codes, see \n\t\t\tDNS RCODES on the IANA website.

", + "smithy.api#documentation": "

A code that indicates whether the request is valid or not. The most common response\n\t\t\tcode is NOERROR, meaning that the request is valid. If the response is not\n\t\t\tvalid, Amazon Route 53 returns a response code that describes the error. For a list of\n\t\t\tpossible response codes, see DNS RCODES on the IANA website.

", "smithy.api#required": {} } }, "Protocol": { "target": "com.amazonaws.route53#TransportProtocol", "traits": { - "smithy.api#documentation": "

The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP.

", + "smithy.api#documentation": "

The protocol that Amazon Route 53 used to respond to the request, either\n\t\t\t\tUDP or TCP.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response to a TestDNSAnswer request.

" + "smithy.api#documentation": "

A complex type that contains the response to a TestDNSAnswer request.\n\t\t

" } }, "com.amazonaws.route53#Threshold": { @@ -7979,7 +8779,7 @@ } }, "traits": { - "smithy.api#documentation": "

This health check can't be created because the current account has reached the limit on the number of active health checks.

\n\t\t

For information about default limits, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

For information about how to get the current limit for an account, see \n\t\t\tGetAccountLimit. To request a \n\t\t\thigher limit, create a case with the Amazon Web Services Support Center.

\n\n\t\t

You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, \n\t\t\tcreate a case with the Amazon Web Services Support Center.

", + "smithy.api#documentation": "

This health check can't be created because the current account has reached the limit\n\t\t\ton the number of active health checks.

\n\t\t

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

\n\t\t

You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.

", "smithy.api#error": "client" } }, @@ -7994,7 +8794,7 @@ } }, "traits": { - "smithy.api#documentation": "

This operation can't be completed either because the current account has reached the limit on the number of hosted zones \n\t\t\tor because you've reached the limit on the number of hosted zones that can be associated with a reusable delegation set.

\n\t\t

For information about default limits, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

To get the current limit on hosted zones that can be created by an account, see \n\t\t\tGetAccountLimit.

\n\t\t

To get the current limit on hosted zones that can be associated with a reusable delegation set, see \n\t\t\tGetReusableDelegationSetLimit.

\n\t\t

To request a higher limit, create a case with the Amazon Web Services Support Center.

", + "smithy.api#documentation": "

This operation can't be completed either because the current account has reached the\n\t\t\tlimit on the number of hosted zones or because you've reached the limit on the number of\n\t\t\thosted zones that can be associated with a reusable delegation set.

\n\t\t

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.

\n\t\t

To get the current limit on hosted zones that can be associated with a reusable\n\t\t\tdelegation set, see GetReusableDelegationSetLimit.

\n\t\t

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8007,7 +8807,7 @@ } }, "traits": { - "smithy.api#documentation": "

You've reached the limit for the number of key-signing keys (KSKs). Remove at least one KSK, and then try again.

", + "smithy.api#documentation": "

You've reached the limit for the number of key-signing keys (KSKs). Remove at least\n\t\t\tone KSK, and then try again.

", "smithy.api#error": "client" } }, @@ -8022,7 +8822,7 @@ } }, "traits": { - "smithy.api#documentation": "

This traffic policy can't be created because the current account has reached the limit on the number of traffic policies.

\n\t\t

For information about default limits, see Limits \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

To get the current limit for an account, see \n\t\t\tGetAccountLimit. \n\t\t

\n\t\t

To request a higher limit, create a case with the Amazon Web Services Support Center.

", + "smithy.api#documentation": "

This traffic policy can't be created because the current account has reached the limit\n\t\t\ton the number of traffic policies.

\n\t\t

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

To get the current limit for an account, see GetAccountLimit.

\n\t\t

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8038,7 +8838,7 @@ } }, "traits": { - "smithy.api#documentation": "

This traffic policy instance can't be created because the current account has reached the limit on the number of \n\t\t\ttraffic policy instances.

\n\t\t

For information about default limits, see \n\t\t\tLimits \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

For information about how to get the current limit for an account, see \n\t\t\tGetAccountLimit.

\n\t\t

To request a higher limit, create a case with the Amazon Web Services Support Center.

", + "smithy.api#documentation": "

This traffic policy instance can't be created because the current account has reached\n\t\t\tthe limit on the number of traffic policy instances.

\n\t\t

For information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

For information about how to get the current limit for an account, see GetAccountLimit.

\n\t\t

To request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8054,7 +8854,7 @@ } }, "traits": { - "smithy.api#documentation": "

This traffic policy version can't be created because you've reached the limit of 1000 on the number of versions \n\t\t\tthat you can create for the current traffic policy.

\n\t\t

To create more traffic policy versions, you can use \n\t\t\tGetTrafficPolicy \n\t\t\tto get the traffic policy document for a specified traffic policy version, and then use \n\t\t\tCreateTrafficPolicy \n\t\t\tto create a new traffic policy using the traffic policy document.

", + "smithy.api#documentation": "

This traffic policy version can't be created because you've reached the limit of 1000\n\t\t\ton the number of versions that you can create for the current traffic policy.

\n\t\t

To create more traffic policy versions, you can use GetTrafficPolicy\n\t\t\tto get the traffic policy document for a specified traffic policy version, and then use\n\t\t\t\tCreateTrafficPolicy to create a new traffic policy using the traffic policy\n\t\t\tdocument.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8070,7 +8870,7 @@ } }, "traits": { - "smithy.api#documentation": "

You've created the maximum number of authorizations that can be created for the specified hosted zone. \n\t\t\tTo authorize another VPC to be associated with the hosted zone, submit a DeleteVPCAssociationAuthorization request \n\t\t\tto remove an existing authorization. To get a list of existing authorizations, submit a \n\t\t\tListVPCAssociationAuthorizations request.

", + "smithy.api#documentation": "

You've created the maximum number of authorizations that can be created for the\n\t\t\tspecified hosted zone. To authorize another VPC to be associated with the hosted zone,\n\t\t\tsubmit a DeleteVPCAssociationAuthorization request to remove an existing\n\t\t\tauthorization. To get a list of existing authorizations, submit a\n\t\t\t\tListVPCAssociationAuthorizations request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8097,7 +8897,7 @@ "Version": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, \n\t\t\tthe value of Version is always 1.

", + "smithy.api#documentation": "

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic\n\t\t\tpolicy, the value of Version is always 1.

", "smithy.api#required": {} } }, @@ -8111,21 +8911,21 @@ "Type": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy \n\t\t\tto create a traffic policy instance.

", + "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", "smithy.api#required": {} } }, "Document": { "target": "com.amazonaws.route53#TrafficPolicyDocument", "traits": { - "smithy.api#documentation": "

The definition of a traffic policy in JSON format. You specify the JSON document to use for a new \n\t\t\ttraffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see \n\t\t\tTraffic Policy Document Format.

", + "smithy.api#documentation": "

The definition of a traffic policy in JSON format. You specify the JSON document to\n\t\t\tuse for a new traffic policy in the CreateTrafficPolicy request. For more\n\t\t\tinformation about the JSON format, see Traffic Policy Document Format.

", "smithy.api#required": {} } }, "Comment": { "target": "com.amazonaws.route53#TrafficPolicyComment", "traits": { - "smithy.api#documentation": "

The comment that you specify in the CreateTrafficPolicy request, if any.

" + "smithy.api#documentation": "

The comment that you specify in the CreateTrafficPolicy request, if\n\t\t\tany.

" } } }, @@ -8187,7 +8987,7 @@ } }, "traits": { - "smithy.api#documentation": "

One or more traffic policy instances were created by using the specified traffic policy.

", + "smithy.api#documentation": "

One or more traffic policy instances were created by using the specified traffic\n\t\t\tpolicy.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -8212,49 +9012,49 @@ "Name": { "target": "com.amazonaws.route53#DNSName", "traits": { - "smithy.api#documentation": "

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the \n\t\t\tresource record sets that are associated with this traffic policy instance.

", + "smithy.api#documentation": "

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries\n\t\t\tby using the resource record sets that are associated with this traffic policy instance.\n\t\t

", "smithy.api#required": {} } }, "TTL": { "target": "com.amazonaws.route53#TTL", "traits": { - "smithy.api#documentation": "

The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

", + "smithy.api#documentation": "

The TTL that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated in the specified hosted zone.

", "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.route53#TrafficPolicyInstanceState", "traits": { - "smithy.api#documentation": "

The value of State is one of the following values:

\n\t\t
\n
Applied
\n
\n

Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.

\n
\n
Creating
\n
\n

Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the \n\t\t\t\t\tCreateTrafficPolicyInstance request completed successfully.

\n
\n
Failed
\n
\n

Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, \n\t\t\t\t\tsee Message for an explanation of what caused the request to fail.

\n
\n
", + "smithy.api#documentation": "

The value of State is one of the following values:

\n\t\t
\n
Applied
\n
\n\t\t\t\t\t

Amazon Route 53 has finished creating resource record sets, and changes\n\t\t\t\t\t\thave propagated to all Route 53 edge locations.

\n\t\t\t\t
\n
Creating
\n
\n\t\t\t\t\t

Route 53 is creating the resource record sets. Use\n\t\t\t\t\t\t\tGetTrafficPolicyInstance to confirm that the\n\t\t\t\t\t\t\tCreateTrafficPolicyInstance request completed\n\t\t\t\t\t\tsuccessfully.

\n\t\t\t\t
\n
Failed
\n
\n\t\t\t\t\t

Route 53 wasn't able to create or update the resource record sets. When\n\t\t\t\t\t\tthe value of State is Failed, see\n\t\t\t\t\t\t\tMessage for an explanation of what caused the request to\n\t\t\t\t\t\tfail.

\n\t\t\t\t
\n
", "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.route53#Message", "traits": { - "smithy.api#documentation": "

If State is Failed, an explanation of the reason for the failure. If State is another value, \n\t\t\tMessage is empty.

", + "smithy.api#documentation": "

If State is Failed, an explanation of the reason for the\n\t\t\tfailure. If State is another value, Message is empty.

", "smithy.api#required": {} } }, "TrafficPolicyId": { "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

", + "smithy.api#documentation": "

The ID of the traffic policy that Amazon Route 53 used to create resource record sets\n\t\t\tin the specified hosted zone.

", "smithy.api#required": {} } }, "TrafficPolicyVersion": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

", + "smithy.api#documentation": "

The version of the traffic policy that Amazon Route 53 used to create resource record\n\t\t\tsets in the specified hosted zone.

", "smithy.api#required": {} } }, "TrafficPolicyType": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

", + "smithy.api#documentation": "

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated for this traffic policy instance.

", "smithy.api#required": {} } } @@ -8344,7 +9144,7 @@ "Type": { "target": "com.amazonaws.route53#RRType", "traits": { - "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy \n\t\t\tto create a traffic policy instance.

", + "smithy.api#documentation": "

The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.

", "smithy.api#required": {} } }, @@ -8364,7 +9164,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the latest version of one traffic policy \n\t\t\tthat is associated with the current Amazon Web Services account.

" + "smithy.api#documentation": "

A complex type that contains information about the latest version of one traffic\n\t\t\tpolicy that is associated with the current Amazon Web Services account.

" } }, "com.amazonaws.route53#TrafficPolicyVersion": { @@ -8389,6 +9189,12 @@ "com.amazonaws.route53#TransportProtocol": { "type": "string" }, + "com.amazonaws.route53#UUID": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + } + }, "com.amazonaws.route53#UpdateHealthCheck": { "type": "operation", "input": { @@ -8409,7 +9215,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing health check. Note that some values can't be updated.

\n\t\t

For more information about updating health checks, see \n\t\t\tCreating, Updating, and Deleting Health Checks \n\t\t\tin the Amazon Route 53 Developer Guide.

", + "smithy.api#documentation": "

Updates an existing health check. Note that some values can't be updated.

\n\t\t

For more information about updating health checks, see Creating,\n\t\t\t\tUpdating, and Deleting Health Checks in the Amazon Route 53\n\t\t\t\tDeveloper Guide.

", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/healthcheck/{HealthCheckId}", @@ -8423,7 +9229,7 @@ "HealthCheckId": { "target": "com.amazonaws.route53#HealthCheckId", "traits": { - "smithy.api#documentation": "

The ID for the health check for which you want detailed information. When you created the health check, \n\t\t\tCreateHealthCheck returned the ID in the response, in the HealthCheckId element.

", + "smithy.api#documentation": "

The ID for the health check for which you want detailed information. When you created\n\t\t\tthe health check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8431,102 +9237,102 @@ "HealthCheckVersion": { "target": "com.amazonaws.route53#HealthCheckVersion", "traits": { - "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you \n\t\t\tupdate settings for the health check.

\n\t\t

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of \n\t\t\tHealthCheckVersion for the health check that you want to update, and that you include that value in your \n\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

\n\t\t
    \n
  • \n\t\t\t\t

    If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the \n\t\t\t\t\thealth check, Route 53 updates the health check with the new settings.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If the value of HealthCheckVersion in the health check is greater, the health check was changed after you \n\t\t\t\t\tgot the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\thealth check and increments by 1 each time you update settings for the health\n\t\t\tcheck.

\n\t\t

We recommend that you use GetHealthCheck or ListHealthChecks\n\t\t\tto get the current value of HealthCheckVersion for the health check that\n\t\t\tyou want to update, and that you include that value in your\n\t\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an\n\t\t\tintervening update:

\n\t\t
    \n
  • \n\t\t\t\t

    If the value in the UpdateHealthCheck request matches the value\n\t\t\t\t\tof HealthCheckVersion in the health check, Route 53 updates the\n\t\t\t\t\thealth check with the new settings.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If the value of HealthCheckVersion in the health check is\n\t\t\t\t\tgreater, the health check was changed after you got the version number. Route 53\n\t\t\t\t\tdoes not update the health check, and it returns a\n\t\t\t\t\t\tHealthCheckVersionMismatch error.

    \n\t\t\t
    • \n
" } }, "IPAddress": { "target": "com.amazonaws.route53#IPAddress", "traits": { - "smithy.api#documentation": "

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for \n\t\t\tIPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName \n\t\t\tat the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then \n\t\t\tchecks the health of the endpoint.

\n\t\t

Use one of the following formats for the value of IPAddress:

\n\t\t
    \n
  • \n

    \n IPv4 address: four values between 0 and 255, separated by periods (.), \n\t\t\t\tfor example, 192.0.2.44.

    \n
    • \n
  • \n

    \n IPv6 address: eight groups of four hexadecimal values, separated by colons (:), \n\t\t\t\tfor example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, \n\t\t\t\tfor example, 2001:db8:85a3::abcd:1:2345.

    \n
    • \n
\n\t\t

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and \n\t\t\tspecify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, \n\t\t\tsee the applicable documentation:

\n\t\t \n\t\t \n

If a health check already has a value for IPAddress, you can change the value. However, you can't update an \n\t\t\texisting health check to add or remove the value of IPAddress.

\n\t\t \n\t\t

For more information, see \n\t\t\tFullyQualifiedDomainName.\n\t\t

\n\t\t

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or \n\t\t\tmulticast ranges. For more information about IP addresses for which you can't create health checks, see the following \n\t\t\tdocuments:

\n\t\t " + "smithy.api#documentation": "

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address that is returned by DNS, Route 53\n\t\t\tthen checks the health of the endpoint.

\n\t\t

Use one of the following formats for the value of IPAddress:

\n\t\t
    \n
  • \n\t\t\t\t

    \n IPv4 address: four values between 0 and 255,\n\t\t\t\t\tseparated by periods (.), for example, 192.0.2.44.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n IPv6 address: eight groups of four\n\t\t\t\t\thexadecimal values, separated by colons (:), for example,\n\t\t\t\t\t\t2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten\n\t\t\t\t\tIPv6 addresses as described in RFC 5952, for example,\n\t\t\t\t\t\t2001:db8:85a3::abcd:1:2345.

    \n\t\t\t
    • \n
\n\t\t

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance never\n\t\t\tchanges. For more information, see the applicable documentation:

\n\t\t \n\t\t \n\t\t\t

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n\t\t \n\t\t

For more information, see FullyQualifiedDomainName.

\n\t\t

Constraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:

\n\t\t " } }, "Port": { "target": "com.amazonaws.route53#Port", "traits": { - "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

\n\t\t \n\t\t\t

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or \n\t\t\t\tCALCULATED.

\n\t\t " + "smithy.api#documentation": "

The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.

\n\t\t \n\t\t\t

Don't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.

\n\t\t " } }, "ResourcePath": { "target": "com.amazonaws.route53#ResourcePath", "traits": { - "smithy.api#documentation": "

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint \n\t\t\twill return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. \n\t\t\tYou can also include query string parameters, for example, /welcome.html?language=jp&login=y.

\n\t\t

Specify this value only if you want to change it.

" + "smithy.api#documentation": "

The path that you want Amazon Route 53 to request when performing health checks. The\n\t\t\tpath can be any value for which your endpoint will return an HTTP status code of 2xx or\n\t\t\t3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.\n\t\t\tYou can also include query string parameters, for example,\n\t\t\t\t/welcome.html?language=jp&login=y.

\n\t\t

Specify this value only if you want to change it.

" } }, "FullyQualifiedDomainName": { "target": "com.amazonaws.route53#FullyQualifiedDomainName", "traits": { - "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

\n\t\t\n\t\t \n

If a health check already has a value for IPAddress, you can change the value. However, you can't update an \n\t\t\texisting health check to add or remove the value of IPAddress.

\n \n\t\t\n\t\t

\n If you specify a value for \n IPAddress:

\n\t\t

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName \n\t\t\tin the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint \n\t\t\ton which you want Route 53 to perform health checks.

\n\t\t

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for \n\t\t\t\t\tType, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify another value for Port and any value except TCP for Type, Route 53 passes \n\t\t\t\t\t\n FullyQualifiedDomainName:Port\n to the endpoint in the Host header.

    \n\t\t\t
    • \n
\n\t\t

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress \n\t\t\tin the Host header in each of the above cases.

\n\t\t\n\t\t

\n If you don't specify a value for \n IPAddress:

\n\t\t

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in \n\t\t\tFullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is \n\t\t\treturned by DNS, Route 53 then checks the health of the endpoint.

\n\t\t \n

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. \n\t\t\tIf there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, \n\t\t\tthe health check fails with a \"DNS resolution failed\" error.

\n \n\t\t

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by \n\t\t\tFullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a \n\t\t\thealth check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, \n\t\t\tspecify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

\n\t\t \n\t\t\t

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and \n\t\t\t\tyou then associate the health check with those resource record sets, health check results will be unpredictable.

\n\t\t \n\t\t

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or \n\t\t\tHTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does \n\t\t\twhen you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a \n\t\t\tHost header.

" + "smithy.api#documentation": "

Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.

\n\t\t \n\t\t\t

If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.

\n\t\t \n\t\t

\n If you specify a value for\n\t\t\t IPAddress:

\n\t\t

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes\n\t\t\tthe value of FullyQualifiedDomainName in the Host header for\n\t\t\tall health checks except TCP health checks. This is typically the fully qualified DNS\n\t\t\tname of the endpoint on which you want Route 53 to perform health checks.

\n\t\t

When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a value of 80 for Port and\n\t\t\t\t\t\tHTTP or HTTP_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify a value of 443 for Port and\n\t\t\t\t\t\tHTTPS or HTTPS_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify another value for Port and any value except\n\t\t\t\t\t\tTCP for Type, Route 53 passes\n\t\t\t\t\t\t\t\n FullyQualifiedDomainName:Port\n \n\t\t\t\t\tto the endpoint in the Host header.

    \n\t\t\t
    • \n
\n\t\t

If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the above cases.

\n\t\t

\n If you don't specify a value for\n\t\t\t IPAddress:

\n\t\t

If you don't specify a value for IPAddress, Route 53 sends a DNS request\n\t\t\tto the domain that you specify in FullyQualifiedDomainName at the interval\n\t\t\tyou specify in RequestInterval. Using an IPv4 address that is returned by\n\t\t\tDNS, Route 53 then checks the health of the endpoint.

\n\t\t \n\t\t\t

If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.

\n\t\t \n\t\t

If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record\n\t\t\tsets (www.example.com).

\n\t\t \n\t\t\t

In this configuration, if the value of FullyQualifiedDomainName\n\t\t\t\tmatches the name of the resource record sets and you then associate the health check\n\t\t\t\twith those resource record sets, health check results will be unpredictable.

\n\t\t \n\t\t

In addition, if the value of Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.

" } }, "SearchString": { "target": "com.amazonaws.route53#SearchString", "traits": { - "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want \n\t\t\tAmazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers \n\t\t\tthe resource healthy. (You can't change the value of Type when you update a health check.)

" + "smithy.api#documentation": "

If the value of Type is HTTP_STR_MATCH or\n\t\t\t\tHTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for\n\t\t\tin the response body from the specified resource. If the string appears in the response\n\t\t\tbody, Route 53 considers the resource healthy. (You can't change the value of\n\t\t\t\tType when you update a health check.)

" } }, "FailureThreshold": { "target": "com.amazonaws.route53#FailureThreshold", "traits": { - "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint \n\t\t\tfrom unhealthy to healthy or vice versa. For more information, see \n\t\t\tHow Amazon Route 53 Determines Whether an Endpoint Is Healthy \n\t\t\tin the Amazon Route 53 Developer Guide.

\n\t\t

If you don't specify a value for FailureThreshold, the default value is three health checks.

" + "smithy.api#documentation": "

The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.

\n\t\t

If you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.

" } }, "Inverted": { "target": "com.amazonaws.route53#Inverted", "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it \n\t\t\totherwise would be considered healthy.

" + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.

" } }, "Disabled": { "target": "com.amazonaws.route53#Disabled", "traits": { - "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

\n\t\t
    \n
  • \n

    \n Health checks that check the health of endpoints: \n\t\t\t\tRoute 53 stops submitting requests to your application, server, or other resource.

    \n
    • \n
  • \n

    \n Calculated health checks: \n\t\t\t\tRoute 53 stops aggregating the status of the referenced health checks.

    \n
    • \n
  • \n

    \n Health checks that monitor CloudWatch alarms: \n\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

    \n
    • \n
\n\t\t\t\n\t\t

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, \n\t\t\tRoute 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of \n\t\t\tInverted.\n\t\t

\n\t\t\n\t\t

Charges for a health check still apply when the health check is disabled. For more information, see \n\t\t\tAmazon Route 53 Pricing.

" + "smithy.api#documentation": "

Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Health checks that check the health of\n\t\t\t\t\t\tendpoints: Route 53 stops submitting requests to your\n\t\t\t\t\tapplication, server, or other resource.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Calculated health checks: Route 53 stops\n\t\t\t\t\taggregating the status of the referenced health checks.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Health checks that monitor CloudWatch alarms:\n\t\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.

    \n\t\t\t
    • \n
\n\t\t

After you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.

\n\t\t

Charges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.

" } }, "HealthThreshold": { "target": "com.amazonaws.route53#HealthThreshold", "traits": { - "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the \n\t\t\tCALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a \n\t\t\tCALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

\n\t\t

Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify 0, Route 53 always considers this health check to be healthy.

    \n\t\t\t
    • \n
" + "smithy.api#documentation": "

The number of child health checks that are associated with a CALCULATED\n\t\t\thealth that Amazon Route 53 must consider healthy for the CALCULATED health\n\t\t\tcheck to be considered healthy. To specify the child health checks that you want to\n\t\t\tassociate with a CALCULATED health check, use the\n\t\t\t\tChildHealthChecks and ChildHealthCheck elements.

\n\t\t

Note the following:

\n\t\t
    \n
  • \n\t\t\t\t

    If you specify a number greater than the number of child health checks, Route\n\t\t\t\t\t53 always considers this health check to be unhealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    If you specify 0, Route 53 always considers this health check to\n\t\t\t\t\tbe healthy.

    \n\t\t\t
    • \n
" } }, "ChildHealthChecks": { "target": "com.amazonaws.route53#ChildHealthCheckList", "traits": { - "smithy.api#documentation": "

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a \n\t\t\tCALCULATED health check.

" + "smithy.api#documentation": "

A complex type that contains one ChildHealthCheck element for each health\n\t\t\tcheck that you want to associate with a CALCULATED health check.

" } }, "EnableSNI": { "target": "com.amazonaws.route53#EnableSNI", "traits": { - "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello\n\t\t\tmessage during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable \n\t\t\tSSL/TLS certificate.

\n\t\t

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, \n\t\t\tthe status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. \n\t\t\tIf SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

\n\t\t

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more \n\t\t\tin the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for \n\t\t\tFullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not \n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the \n\t\t\tsecond attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

" + "smithy.api#documentation": "

Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows\n\t\t\tthe endpoint to respond to HTTPS health check requests with the applicable\n\t\t\tSSL/TLS certificate.

\n\t\t

Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.

\n\t\t

The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.

" } }, "Regions": { "target": "com.amazonaws.route53#HealthCheckRegionList", "traits": { - "smithy.api#documentation": "

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check \n\t\t\tthe specified endpoint from.

" + "smithy.api#documentation": "

A complex type that contains one Region element for each region that you\n\t\t\twant Amazon Route 53 health checkers to check the specified endpoint from.

" } }, "AlarmIdentifier": { "target": "com.amazonaws.route53#AlarmIdentifier", "traits": { - "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether \n\t\t\tthe specified health check is healthy.

" + "smithy.api#documentation": "

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.

" } }, "InsufficientDataHealthStatus": { "target": "com.amazonaws.route53#InsufficientDataHealthStatus", "traits": { - "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign \n\t\t\tto the health check:

\n\t\t
    \n
  • \n

    \n Healthy: Route 53 considers the health check to be healthy.

    \n
    • \n
  • \n

    \n Unhealthy: Route 53 considers the health check to be unhealthy.

    \n
    • \n
  • \n

    \n LastKnownStatus: By default, Route 53 uses the status of the health check from the last time CloudWatch had sufficient data \n\t\t\t\tto determine the alarm state. For new health checks that have no last known status, the status for the health check is healthy.

    \n
    • \n
" + "smithy.api#documentation": "

When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:

\n\t\t
    \n
  • \n\t\t\t\t

    \n Healthy: Route 53 considers the health check to be\n\t\t\t\t\thealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Unhealthy: Route 53 considers the health check to be\n\t\t\t\t\tunhealthy.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n LastKnownStatus: By default, Route 53 uses the status of the\n\t\t\t\t\thealth check from the last time CloudWatch had sufficient data to determine the\n\t\t\t\t\talarm state. For new health checks that have no last known status, the status\n\t\t\t\t\tfor the health check is healthy.

    \n\t\t\t
    • \n
" } }, "ResetElements": { "target": "com.amazonaws.route53#ResettableElementNameList", "traits": { - "smithy.api#documentation": "

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. \n\t\t\tValid values for ResettableElementName include the following:

\n\t\t
    \n
  • \n

    \n ChildHealthChecks: Amazon Route 53 resets \n\t\t\t\tChildHealthChecks \n\t\t\t\tto null.

    \n
    • \n
  • \n

    \n FullyQualifiedDomainName: Route 53 resets \n\t\t\t\tFullyQualifiedDomainName.\n\t\t\t\tto null.

    \n
    • \n
  • \n

    \n Regions: Route 53 resets the \n\t\t\t\tRegions \n\t\t\t\tlist to the default set of regions.

    \n
    • \n
  • \n

    \n ResourcePath: Route 53 resets \n\t\t\t\tResourcePath \n\t\t\t\tto null.

    \n
    • \n
" + "smithy.api#documentation": "

A complex type that contains one ResettableElementName element for each\n\t\t\telement that you want to reset to the default value. Valid values for\n\t\t\t\tResettableElementName include the following:

\n\t\t
    \n
  • \n\t\t\t\t

    \n ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n Regions: Route 53 resets the Regions list to the default set of regions.

    \n\t\t\t
    • \n
  • \n\t\t\t\t

    \n ResourcePath: Route 53 resets ResourcePath to null.

    \n\t\t\t
    • \n
" } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about a request to update a health check.

" + "smithy.api#documentation": "

A complex type that contains information about a request to update a health\n\t\t\tcheck.

" } }, "com.amazonaws.route53#UpdateHealthCheckResponse": { @@ -8535,13 +9341,13 @@ "HealthCheck": { "target": "com.amazonaws.route53#HealthCheck", "traits": { - "smithy.api#documentation": "

A complex type that contains the response to an UpdateHealthCheck request.

", + "smithy.api#documentation": "

A complex type that contains the response to an UpdateHealthCheck\n\t\t\trequest.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the UpdateHealthCheck request.

" + "smithy.api#documentation": "

A complex type that contains the response to the UpdateHealthCheck\n\t\t\trequest.

" } }, "com.amazonaws.route53#UpdateHostedZoneComment": { @@ -8586,7 +9392,7 @@ "Comment": { "target": "com.amazonaws.route53#ResourceDescription", "traits": { - "smithy.api#documentation": "

The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the \n\t\t\tComment element, if any.

" + "smithy.api#documentation": "

The new comment for the hosted zone. If you don't specify a value for\n\t\t\t\tComment, Amazon Route 53 deletes the existing value of the\n\t\t\t\tComment element, if any.

" } } }, @@ -8600,13 +9406,13 @@ "HostedZone": { "target": "com.amazonaws.route53#HostedZone", "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment request.

", + "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment request.

" + "smithy.api#documentation": "

A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.

" } }, "com.amazonaws.route53#UpdateTrafficPolicyComment": { @@ -8643,7 +9449,7 @@ "Id": { "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

The value of Id for the traffic policy that you want to update the comment for.

", + "smithy.api#documentation": "

The value of Id for the traffic policy that you want to update the\n\t\t\tcomment for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8651,7 +9457,7 @@ "Version": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

The value of Version for the traffic policy that you want to update the comment for.

", + "smithy.api#documentation": "

The value of Version for the traffic policy that you want to update the\n\t\t\tcomment for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8665,7 +9471,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to update the comment for.

" + "smithy.api#documentation": "

A complex type that contains information about the traffic policy that you want to\n\t\t\tupdate the comment for.

" } }, "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse": { @@ -8709,7 +9515,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.

\n\t\t

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name \n\t\t\t(such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:

\n\t\t
    \n
  1. \n\t\t\t\t

    Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant \n\t\t\t\t\tthe differences are between the existing resource record sets and the new resource record sets.

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name \n\t\t\t\t\t(such as example.com) by using the new resource record sets.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

    \n\t\t\t
    4. \n
", + "smithy.api#documentation": "

Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.

\n\t\t

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:

\n\t\t
    \n
  1. \n\t\t\t\t

    Route 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t

    \n\t\t\t
    2. \n
  2. \n\t\t\t\t

    When all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.

    \n\t\t\t
    3. \n
  3. \n\t\t\t\t

    Route 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.

    \n\t\t\t
    4. \n
", "smithy.api#http": { "method": "POST", "uri": "/2013-04-01/trafficpolicyinstance/{Id}", @@ -8731,27 +9537,27 @@ "TTL": { "target": "com.amazonaws.route53#TTL", "traits": { - "smithy.api#documentation": "

The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.

", + "smithy.api#documentation": "

The TTL that you want Amazon Route 53 to assign to all of the updated resource record\n\t\t\tsets.

", "smithy.api#required": {} } }, "TrafficPolicyId": { "target": "com.amazonaws.route53#TrafficPolicyId", "traits": { - "smithy.api#documentation": "

The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

", + "smithy.api#documentation": "

The ID of the traffic policy that you want Amazon Route 53 to use to update resource\n\t\t\trecord sets for the specified traffic policy instance.

", "smithy.api#required": {} } }, "TrafficPolicyVersion": { "target": "com.amazonaws.route53#TrafficPolicyVersion", "traits": { - "smithy.api#documentation": "

The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

", + "smithy.api#documentation": "

The version of the traffic policy that you want Amazon Route 53 to use to update\n\t\t\tresource record sets for the specified traffic policy instance.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.

" + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that you want\n\t\t\tto update based on a specified traffic policy instance.

" } }, "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse": { @@ -8766,7 +9572,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon Route 53\n\t\t\tcreated based on a specified traffic policy.

" + "smithy.api#documentation": "

A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.

" } }, "com.amazonaws.route53#UsageCount": { @@ -8783,7 +9589,7 @@ "VPCRegion": { "target": "com.amazonaws.route53#VPCRegion", "traits": { - "smithy.api#documentation": "

(Private hosted zones only) The region that an Amazon VPC was created in.

" + "smithy.api#documentation": "

(Private hosted zones only) The region that an Amazon VPC was created\n\t\t\tin.

" } }, "VPCId": { @@ -8791,7 +9597,7 @@ } }, "traits": { - "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

\n\t\t

If you associate a private hosted zone with an Amazon VPC when you make a CreateHostedZone request, the following parameters are also\n\t\t\trequired.

" + "smithy.api#documentation": "

(Private hosted zones only) A complex type that contains information about an Amazon VPC.

\n\t\t

If you associate a private hosted zone with an Amazon VPC when you make a\n\t\t\t\tCreateHostedZone\n\t\t\trequest, the following parameters are also required.

" } }, "com.amazonaws.route53#VPCAssociationAuthorizationNotFound": { @@ -8805,7 +9611,7 @@ } }, "traits": { - "smithy.api#documentation": "

The VPC that you specified is not authorized to be associated with the hosted zone.

", + "smithy.api#documentation": "

The VPC that you specified is not authorized to be associated with the hosted\n\t\t\tzone.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } diff --git a/aws/sdk/aws-models/sagemaker.json b/aws/sdk/aws-models/sagemaker.json index 377290064..d7870bc10 100644 --- a/aws/sdk/aws-models/sagemaker.json +++ b/aws/sdk/aws-models/sagemaker.json @@ -31617,7 +31617,7 @@ "min": 0, "max": 15 }, - "smithy.api#pattern": "^(notebook-al1-v1|notebook-al2-v1)$" + "smithy.api#pattern": "^(notebook-al1-v1|notebook-al2-v1|notebook-al2-v2)$" } }, "com.amazonaws.sagemaker#PolicyString": { diff --git a/aws/sdk/aws-models/secretsmanager.json b/aws/sdk/aws-models/secretsmanager.json index c9bdd76b9..92219ac7d 100644 --- a/aws/sdk/aws-models/secretsmanager.json +++ b/aws/sdk/aws-models/secretsmanager.json @@ -1144,7 +1144,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Find secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", + "smithy.api#documentation": "

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

\n

ListSecrets is eventually consistent, however it might not reflect changes from the last five minutes. \n To get the latest information for a specific secret, use DescribeSecret.

\n

To list the versions of a secret, use ListSecretVersionIds.

\n

To get the secret value from SecretString or SecretBinary, \n call GetSecretValue.

\n

For information about finding secrets in the console, see Find secrets in Secrets Manager.

\n

\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1399,7 +1399,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString value or a new SecretBinary value.

\n

We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

You can specify the staging labels to attach to the new version in VersionStages. \n If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT to it .

\n

If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.

\n

This operation is idempotent. If a version with a VersionId with the same\n value as the ClientRequestToken parameter already exists, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.

\n

\n Required permissions: \n secretsmanager:PutSecretValue. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" + "smithy.api#documentation": "

Creates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString value or a new SecretBinary value.

\n

We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

You can specify the staging labels to attach to the new version in VersionStages. \n If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT to it .

\n

If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.

\n

This operation is idempotent. If you call this operation with a ClientRequestToken \n that matches an existing version's VersionId, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.

\n

\n Required permissions: \n secretsmanager:PutSecretValue. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.

" } }, "com.amazonaws.secretsmanager#PutSecretValueRequest": { @@ -2431,7 +2431,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret instead.

\n \n

We recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.

\n

If you call this operation with a VersionId that matches an existing version's \n ClientRequestToken, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time \n significant delay in returning the result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key.

\n

\n Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.

" + "smithy.api#documentation": "

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

\n

To change the rotation configuration of a secret, use RotateSecret instead.

\n \n

We recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.

\n

If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.

\n

If you call this operation with a ClientRequestToken that matches an existing version's \n VersionId, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.

\n

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time \n significant delay in returning the result.

\n

If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key.

\n

\n Required permissions: \n secretsmanager:UpdateSecret. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager. \n If you use a customer managed key, you must also have kms:GenerateDataKey and \n kms:Decrypt permissions on the key. For more information, see \n Secret encryption and decryption.

" } }, "com.amazonaws.secretsmanager#UpdateSecretRequest": { diff --git a/aws/sdk/aws-models/securityhub.json b/aws/sdk/aws-models/securityhub.json index 7d9e12e38..cf68e5618 100644 --- a/aws/sdk/aws-models/securityhub.json +++ b/aws/sdk/aws-models/securityhub.json @@ -1868,6 +1868,150 @@ "smithy.api#documentation": "

Provides details about the CNAME record that is added to the DNS database for domain\n validation.

" } }, + "com.amazonaws.securityhub#AwsCloudFormationStackDetails": { + "type": "structure", + "members": { + "Capabilities": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The capabilities allowed in the stack.\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time at which the stack was created.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A user-defined description associated with the stack.\n

" + } + }, + "DisableRollback": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Boolean to enable or disable rollback on stack creation failures. \n

" + } + }, + "DriftInformation": { + "target": "com.amazonaws.securityhub#AwsCloudFormationStackDriftInformationDetails", + "traits": { + "smithy.api#documentation": "

Information about whether a stack's actual configuration differs, or has drifted, from its expected \nconfiguration, as defined in the stack template and any values specified as template parameters. \n

" + } + }, + "EnableTerminationProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether termination protection is enabled for the stack.\n

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time the nested stack was last updated. This field will only be returned if the stack has been \nupdated at least once.

" + } + }, + "NotificationArns": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related events are published.\n

" + } + }, + "Outputs": { + "target": "com.amazonaws.securityhub#AwsCloudFormationStackOutputsList", + "traits": { + "smithy.api#documentation": "

A list of output structures.\n

" + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that's associated with the stack. \n

" + } + }, + "StackId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Unique identifier of the stack.\n

" + } + }, + "StackName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name associated with the stack.\n

" + } + }, + "StackStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Current status of the stack.\n

" + } + }, + "StackStatusReason": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Success or failure message associated with the stack status.\n

" + } + }, + "TimeoutInMinutes": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The length of time, in minutes, that CloudFormation waits for the nested stack to reach \nthe CREATE_COMPLETE state.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Nests a stack as a resource in a top-level template. Nested stacks are stacks created as resources for \nanother stack.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFormationStackDriftInformationDetails": { + "type": "structure", + "members": { + "StackDriftStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template configuration.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the stack's conformity to its expected template configuration.\n

" + } + }, + "com.amazonaws.securityhub#AwsCloudFormationStackOutputsDetails": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A user-defined description associated with the output.\n

" + } + }, + "OutputKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The key associated with the output.\n

" + } + }, + "OutputValue": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The value associated with the output.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the CloudFormation stack output.\n

" + } + }, + "com.amazonaws.securityhub#AwsCloudFormationStackOutputsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudFormationStackOutputsDetails" + } + }, "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehavior": { "type": "structure", "members": { @@ -1893,7 +2037,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about caching for the distribution.

" + "smithy.api#documentation": "

Provides information about caching for the CloudFront distribution.

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionCacheBehaviorsItemList": { @@ -1913,7 +2057,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about the default cache configuration for the distribution.

" + "smithy.api#documentation": "

Contains information about the default cache configuration for the CloudFront distribution.

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionDetails": { @@ -1993,7 +2137,7 @@ } }, "traits": { - "smithy.api#documentation": "

A distribution configuration.

" + "smithy.api#documentation": "

A CloudFront distribution configuration.

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionLogging": { @@ -2025,7 +2169,51 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that controls whether access logs are written for the distribution.

" + "smithy.api#documentation": "

A complex type that controls whether access logs are written for the CloudFront distribution.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginCustomOriginConfig": { + "type": "structure", + "members": { + "HttpPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The HTTP port that CloudFront uses to connect to the origin.\n

" + } + }, + "HttpsPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The HTTPS port that CloudFront uses to connect to the origin.\n

" + } + }, + "OriginKeepaliveTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront persists its connection to the origin.\n

" + } + }, + "OriginProtocolPolicy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. \n

" + } + }, + "OriginReadTimeout": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

Specifies how long, in seconds, CloudFront waits for a response from the origin.\n

" + } + }, + "OriginSslProtocols": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginSslProtocols", + "traits": { + "smithy.api#documentation": "

Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with\n static website hosting is a custom origin.

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroup": { @@ -2039,7 +2227,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an origin group for the distribution.

" + "smithy.api#documentation": "

Information about an origin group for the CloudFront distribution.

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupFailover": { @@ -2093,7 +2281,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about origin groups that are associated with the\n distribution.

" + "smithy.api#documentation": "

Provides information about origin groups that are associated with the CloudFront distribution.

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginGroupsItemList": { @@ -2108,7 +2296,7 @@ "DomainName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Amazon S3 origins: The DNS name of the S3 bucket from which you want CloudFront to get objects for this origin.

" + "smithy.api#documentation": "

Amazon S3 origins: The DNS name of the S3 bucket from which you want\n CloudFront to get objects for this origin.

" } }, "Id": { @@ -2120,7 +2308,7 @@ "OriginPath": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.

" + "smithy.api#documentation": "

An optional element that causes CloudFront to request your content from a\n directory in your Amazon S3 bucket or your custom origin.

" } }, "S3OriginConfig": { @@ -2128,10 +2316,16 @@ "traits": { "smithy.api#documentation": "

An origin that is an S3 bucket that is not configured with static website\n hosting.

" } + }, + "CustomOriginConfig": { + "target": "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginCustomOriginConfig", + "traits": { + "smithy.api#documentation": "

An origin that is not an Amazon S3 bucket, with one exception. \nIf the Amazon S3 bucket is configured with static website hosting, use this attribute. \nIf the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.\n

" + } } }, "traits": { - "smithy.api#documentation": "

A complex type that describes the S3 bucket, HTTP server (for example, a web\n server), AWS Elemental MediaStore, or other server from which CloudFront gets your\n files.

" + "smithy.api#documentation": "

A complex type that describes the\n Amazon S3 bucket, HTTP server (for example, a web server), AWS Elemental MediaStore, or other server from which CloudFront gets your files.

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginItemList": { @@ -2151,7 +2345,27 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an origin that is an S3 bucket that is not configured with static\n website hosting.

" + "smithy.api#documentation": "

Information about an origin that is an Amazon S3 bucket that is not configured with static website\n hosting.

" + } + }, + "com.amazonaws.securityhub#AwsCloudFrontDistributionOriginSslProtocols": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list that contains allowed SSL/TLS protocols for this distribution.\n

" + } + }, + "Quantity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing \nan HTTPS connection with this origin.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A complex type that contains information about the SSL/TLS protocols that CloudFront can use \nwhen establishing an HTTPS connection with your origin.\n

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionOrigins": { @@ -2165,7 +2379,7 @@ } }, "traits": { - "smithy.api#documentation": "

A complex type that contains information about origins and origin groups for this distribution.

" + "smithy.api#documentation": "

A complex type that contains information about origins and origin groups for this CloudFront distribution.

" } }, "com.amazonaws.securityhub#AwsCloudFrontDistributionViewerCertificate": { @@ -2215,7 +2429,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information about the TLS/SSL configuration that the distribution uses to communicate with viewers.

" + "smithy.api#documentation": "

Provides information about the TLS/SSL configuration that the CloudFront distribution uses to communicate with viewers.

" } }, "com.amazonaws.securityhub#AwsCloudTrailTrailDetails": { @@ -2316,155 +2530,321 @@ "smithy.api#documentation": "

Provides details about a CloudTrail trail.

" } }, - "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsDetails": { + "com.amazonaws.securityhub#AwsCloudWatchAlarmDetails": { "type": "structure", "members": { - "ArtifactIdentifier": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "ActionsEnabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

An identifier for the artifact definition.

" + "smithy.api#documentation": "

Indicates whether actions should be executed during any changes to the alarm state. \n

" } }, - "EncryptionDisabled": { - "target": "com.amazonaws.securityhub#Boolean", + "AlarmActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

Indicates whether to disable encryption on the artifact. Only valid when Type is S3.

" + "smithy.api#documentation": "

The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other\n state.

" } }, - "Location": { + "AlarmArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The name of the S3 bucket where the artifact is located.

" + "smithy.api#documentation": "

The ARN of the alarm.\n

" } }, - "Name": { + "AlarmConfigurationUpdatedTimestamp": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The name of the artifact. Used with NamepaceType and Path to determine the pattern for storing the artifact.

" + "smithy.api#documentation": "

The time stamp of the last update to the alarm configuration.\n

" } }, - "NamespaceType": { + "AlarmDescription": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The value to use for the namespace. Used with Name and Path to determine the pattern for storing the artifact.

" + "smithy.api#documentation": "

The description of the alarm.\n

" } }, - "OverrideArtifactName": { - "target": "com.amazonaws.securityhub#Boolean", + "AlarmName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Whether the name specified in the buildspec file overrides the artifact name.

" + "smithy.api#documentation": "

The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID \nand uses that ID for the alarm name. \n

" } }, - "Packaging": { + "ComparisonOperator": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The type of output artifact to create.

" + "smithy.api#documentation": "

The arithmetic operation to use when comparing the specified statistic and threshold. The specified \nstatistic value is used as the first operand.\n

" } }, - "Path": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "DatapointsToAlarm": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Only used when Type is S3. The path to the artifact. Used with Name and NamespaceType to determine the pattern for storing the artifact.

" + "smithy.api#documentation": "

The number of datapoints that must be breaching to trigger the alarm. \n

" } }, - "Type": { + "Dimensions": { + "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsList", + "traits": { + "smithy.api#documentation": "

The dimensions for the metric associated with the alarm. \n

" + } + }, + "EvaluateLowSampleCountPercentile": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of build artifact.

" + "smithy.api#documentation": "

Used only for alarms based on percentiles. If ignore, the alarm state does not change during \nperiods with too few data points to be statistically significant. If evaluate or this parameter is not used, \nthe alarm is always evaluated and possibly changes state no matter how many data points are available.\n

" } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the build artifacts for the CodeBuild project.

" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsDetails" - } - }, - "com.amazonaws.securityhub#AwsCodeBuildProjectDetails": { - "type": "structure", - "members": { - "EncryptionKey": { + }, + "EvaluationPeriods": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold.\n

" + } + }, + "ExtendedStatistic": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The KMS key used to encrypt the\n build output artifacts.

\n

You can specify either the ARN of the KMS key or, if available, the\n KMS key alias (using the format alias/alias-name).

" + "smithy.api#documentation": "

The percentile statistic for the metric associated with the alarm. \n

" } }, - "Artifacts": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList", + "InsufficientDataActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

Information about the build artifacts for the CodeBuild project.

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from \nany other state. Each action is specified as an ARN.\n

" } }, - "Environment": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment", + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about the build environment for this build project.

" + "smithy.api#documentation": "

The name of the metric associated with the alarm. This is required for an alarm based on a metric. \nFor an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.\n

" } }, - "Name": { + "Namespace": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the build project.

" + "smithy.api#documentation": "

The namespace of the metric associated with the alarm. This is required for an alarm based on a \nmetric. For an alarm based on a math expression, you can't specify Namespace and you use \nMetrics instead.\n

" } }, - "Source": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectSource", + "OkActions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

Information about the build input source code for this build project.

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the OK state from any other state. \nEach action is specified as an ARN.\n

" } }, - "ServiceRole": { + "Period": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The period, in seconds, over which the statistic is applied. This is required for an alarm based on a \nmetric.\n

" + } + }, + "Statistic": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services\n services on behalf of the Amazon Web Services account.

" + "smithy.api#documentation": "

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

\n

For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

\n

For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.

" } }, - "LogsConfig": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigDetails", + "Threshold": { + "target": "com.amazonaws.securityhub#Double", "traits": { - "smithy.api#documentation": "

Information about logs for the build project.

" + "smithy.api#documentation": "

The value to compare with the specified statistic.\n

" } }, - "VpcConfig": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig", + "ThresholdMetricId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" + "smithy.api#documentation": "

n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.\n

" } }, - "SecondaryArtifacts": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList", + "TreatMissingData": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Information about the secondary artifacts for the CodeBuild project.

" + "smithy.api#documentation": "

Sets how this alarm is to handle missing data points. \n

" + } + }, + "Unit": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unit of the metric associated with the alarm.\n

" } } }, "traits": { - "smithy.api#documentation": "

Information about an CodeBuild project.

" + "smithy.api#documentation": "

Specifies an alarm and associates it with the specified metric or metric math expression.\n

" } }, - "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment": { + "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsDetails": { "type": "structure", "members": { - "Certificate": { + "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The certificate to use with this build project.

" - } - }, - "EnvironmentVariables": { - "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesList", - "traits": { - "smithy.api#documentation": "

A set of environment variables to make available to builds for the build project.

" + "smithy.api#documentation": "

The name of a dimension.\n

" } }, - "PrivilegedMode": { - "target": "com.amazonaws.securityhub#Boolean", + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.

" + "smithy.api#documentation": "

The value of a dimension.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the dimensions for the metric associated with the alarm.\n

" + } + }, + "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDimensionsDetails" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsDetails": { + "type": "structure", + "members": { + "ArtifactIdentifier": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

An identifier for the artifact definition.

" + } + }, + "EncryptionDisabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to disable encryption on the artifact. Only valid when Type is S3.

" + } + }, + "Location": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The name of the S3 bucket where the artifact is located.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The name of the artifact. Used with NamepaceType and Path to determine the pattern for storing the artifact.

" + } + }, + "NamespaceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The value to use for the namespace. Used with Name and Path to determine the pattern for storing the artifact.

" + } + }, + "OverrideArtifactName": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the name specified in the buildspec file overrides the artifact name.

" + } + }, + "Packaging": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The type of output artifact to create.

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Only used when Type is S3. The path to the artifact. Used with Name and NamespaceType to determine the pattern for storing the artifact.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of build artifact.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the build artifacts for the CodeBuild project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsDetails" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectDetails": { + "type": "structure", + "members": { + "EncryptionKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The KMS key used to encrypt the\n build output artifacts.

\n

You can specify either the ARN of the KMS key or, if available, the\n KMS key alias (using the format alias/alias-name).

" + } + }, + "Artifacts": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList", + "traits": { + "smithy.api#documentation": "

Information about the build artifacts for the CodeBuild project.

" + } + }, + "Environment": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment", + "traits": { + "smithy.api#documentation": "

Information about the build environment for this build project.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the build project.

" + } + }, + "Source": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectSource", + "traits": { + "smithy.api#documentation": "

Information about the build input source code for this build project.

" + } + }, + "ServiceRole": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services\n services on behalf of the Amazon Web Services account.

" + } + }, + "LogsConfig": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectLogsConfigDetails", + "traits": { + "smithy.api#documentation": "

Information about logs for the build project.

" + } + }, + "VpcConfig": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectVpcConfig", + "traits": { + "smithy.api#documentation": "

Information about the VPC configuration that CodeBuild accesses.

" + } + }, + "SecondaryArtifacts": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectArtifactsList", + "traits": { + "smithy.api#documentation": "

Information about the secondary artifacts for the CodeBuild project.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an CodeBuild project.

" + } + }, + "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironment": { + "type": "structure", + "members": { + "Certificate": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The certificate to use with this build project.

" + } + }, + "EnvironmentVariables": { + "target": "com.amazonaws.securityhub#AwsCodeBuildProjectEnvironmentEnvironmentVariablesList", + "traits": { + "smithy.api#documentation": "

A set of environment variables to make available to builds for the build project.

" + } + }, + "PrivilegedMode": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.

" } }, "ImagePullCredentialsType": { @@ -3378,10 +3758,60 @@ "traits": { "smithy.api#documentation": "

The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails object.

" } + }, + "VirtualizationType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.\n

" + } + }, + "MetadataOptions": { + "target": "com.amazonaws.securityhub#AwsEc2InstanceMetadataOptions", + "traits": { + "smithy.api#documentation": "

Details about the metadata options for the Amazon EC2 instance.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of an Amazon EC2 instance.

" + } + }, + "com.amazonaws.securityhub#AwsEc2InstanceMetadataOptions": { + "type": "structure", + "members": { + "HttpEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Enables or disables the HTTP metadata endpoint on the instance. \n

" + } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.\n

" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The desired HTTP PUT response hop limit for instance metadata requests. \n The larger the number, the further instance metadata requests can travel.\n

" + } + }, + "HttpTokens": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The state of token usage for your instance metadata requests. \n

" + } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies whether to allow access to instance tags from the instance metadata.\n

" + } } }, "traits": { - "smithy.api#documentation": "

The details of an EC2 instance.

" + "smithy.api#documentation": "

Metadata options that allow you to configure and secure the Amazon EC2 instance.

" } }, "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesDetails": { @@ -3395,7 +3825,7 @@ } }, "traits": { - "smithy.api#documentation": "

Identifies a network interface for the EC2 instance.

" + "smithy.api#documentation": "

Identifies a network interface for the Amazon EC2 instance.

" } }, "com.amazonaws.securityhub#AwsEc2InstanceNetworkInterfacesList": { @@ -3477,7 +3907,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains details about an EC2 network access control list (ACL).

" + "smithy.api#documentation": "

Contains details about an Amazon EC2 network access control list (ACL).

" } }, "com.amazonaws.securityhub#AwsEc2NetworkAclEntry": { @@ -3516,7 +3946,7 @@ "Protocol": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The protocol that the rule applies to. To deny or allow access to all protocols, use the value -1.

" + "smithy.api#documentation": "

The protocol that the rule applies to. To deny or allow access to all protocols, use the\n value -1.

" } }, "RuleAction": { @@ -3761,7 +4191,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about an EC2 security group.

" + "smithy.api#documentation": "

Details about an Amazon EC2 security group.

" } }, "com.amazonaws.securityhub#AwsEc2SecurityGroupIpPermission": { @@ -3770,7 +4200,7 @@ "IpProtocol": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number.

\n

[VPC only] Use -1 to specify all protocols.

\n

When authorizing security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify.

\n

For tcp, udp, and icmp, you must specify a port\n range.

\n

For icmpv6, the port range is optional. If you omit the port range, traffic\n for all types and codes is allowed.

" + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp,\n icmpv6) or number.

\n

[VPC only] Use -1 to specify all protocols.

\n

When authorizing security group rules, specifying -1\n or a protocol number other than tcp, udp, icmp, or\n icmpv6 allows traffic on all ports, regardless of any port range you\n specify.

\n

For tcp, udp, and icmp, you must specify a port\n range.

\n

For icmpv6, the port range is optional. If you omit the port range, traffic\n for all types and codes is allowed.

" } }, "FromPort": { @@ -3782,7 +4212,7 @@ "ToPort": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

\n

A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you\n must specify all codes.

" + "smithy.api#documentation": "

The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

\n

A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all\n codes.

" } }, "UserIdGroupPairs": { @@ -4016,6 +4446,86 @@ "smithy.api#documentation": "

Contains information about a subnet in Amazon EC2.

" } }, + "com.amazonaws.securityhub#AwsEc2TransitGatewayDetails": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the transit gateway.\n

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The description of the transit gateway.\n

" + } + }, + "DefaultRouteTablePropagation": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off automatic propagation of routes to the default propagation route table.\n

" + } + }, + "AutoAcceptSharedAttachments": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off automatic acceptance of attachment requests.\n

" + } + }, + "DefaultRouteTableAssociation": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off automatic association with the default association route table.\n

" + } + }, + "TransitGatewayCidrBlocks": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The transit gateway Classless Inter-Domain Routing (CIDR) blocks.\n

" + } + }, + "AssociationDefaultRouteTableId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the default association route table.\n

" + } + }, + "PropagationDefaultRouteTableId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the default propagation route table.\n

" + } + }, + "VpnEcmpSupport": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off Equal Cost Multipath Protocol (ECMP) support. \n

" + } + }, + "DnsSupport": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Turn on or turn off DNS support. \n

" + } + }, + "MulticastSupport": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether multicast is supported on the transit gateway. \n

" + } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about an Amazon Web Services Amazon EC2 Transit Gateway that interconnects \nvirtual private clouds (VPCs) and on-premises networks.\n

" + } + }, "com.amazonaws.securityhub#AwsEc2VolumeAttachment": { "type": "structure", "members": { @@ -4063,10 +4573,16 @@ "smithy.api#documentation": "

Indicates when the volume was created.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" } }, - "Encrypted": { - "target": "com.amazonaws.securityhub#Boolean", + "DeviceName": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Whether the volume is encrypted.

" + "smithy.api#documentation": "

The device name for the volume that is attached to the instance.\n

" + } + }, + "Encrypted": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the volume is encrypted.

" } }, "Size": { @@ -4098,6 +4614,24 @@ "traits": { "smithy.api#documentation": "

The volume attachments.

" } + }, + "VolumeId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the volume.\n

" + } + }, + "VolumeType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The volume type.\n

" + } + }, + "VolumeScanStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates whether the volume was scanned or skipped.\n

" + } } }, "traits": { @@ -4230,6 +4764,114 @@ "target": "com.amazonaws.securityhub#AwsEc2VpcEndpointServiceServiceTypeDetails" } }, + "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionDetails": { + "type": "structure", + "members": { + "AccepterVpcInfo": { + "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails", + "traits": { + "smithy.api#documentation": "

Information about the accepter VPC.\n

" + } + }, + "ExpirationTime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The time at which an unaccepted VPC peering connection will expire.\n

" + } + }, + "RequesterVpcInfo": { + "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails", + "traits": { + "smithy.api#documentation": "

Information about the requester VPC. \n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionStatusDetails", + "traits": { + "smithy.api#documentation": "

The status of the VPC peering connection.\n

" + } + }, + "VpcPeeringConnectionId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC peering connection.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about a VPC peering connection between two VPCs: a requester VPC that you own and an \naccepter VPC with which to create the connection. \n

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionStatusDetails": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the VPC peering connection.\n

" + } + }, + "Message": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A message that provides more information about the status, if applicable.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the status of the VPC peering connection.\n

" + } + }, + "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionVpcInfoDetails": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.\n

" + } + }, + "CidrBlockSet": { + "target": "com.amazonaws.securityhub#VpcInfoCidrBlockSetList", + "traits": { + "smithy.api#documentation": "

Information about the IPv4 CIDR blocks for the VPC.\n

" + } + }, + "Ipv6CidrBlockSet": { + "target": "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetList", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.\n

" + } + }, + "OwnerId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the VPC.\n

" + } + }, + "PeeringOptions": { + "target": "com.amazonaws.securityhub#VpcInfoPeeringOptionsDetails", + "traits": { + "smithy.api#documentation": "

Information about the VPC peering connection options for the accepter or requester VPC.\n

" + } + }, + "Region": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region in which the VPC is located.\n

" + } + }, + "VpcId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the VPC.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a VPC in a VPC peering connection.\n

" + } + }, "com.amazonaws.securityhub#AwsEc2VpnConnectionDetails": { "type": "structure", "members": { @@ -4771,6 +5413,18 @@ "com.amazonaws.securityhub#AwsEcsClusterDetails": { "type": "structure", "members": { + "ClusterArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the cluster.\n

" + } + }, + "ActiveServicesCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of services that are running on the cluster in an ACTIVE state. You can view these services with the Amazon ECS \n ListServices\n API operation.\n

" + } + }, "CapacityProviders": { "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { @@ -4794,10 +5448,72 @@ "traits": { "smithy.api#documentation": "

The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.

" } + }, + "ClusterName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name that you use to identify your cluster. \n

" + } + }, + "RegisteredContainerInstancesCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.\n

" + } + }, + "RunningTasksCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of tasks in the cluster that are in the RUNNING state.\n

" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the cluster. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Amazon ECS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEcsContainerDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the container.\n

" + } + }, + "Image": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The image used for the container.\n

" + } + }, + "MountPoints": { + "target": "com.amazonaws.securityhub#AwsMountPointList", + "traits": { + "smithy.api#documentation": "

The mount points for data volumes in your container.\n

" + } + }, + "Privileged": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host container instance \n(similar to the root user). \n

" + } } }, "traits": { - "smithy.api#documentation": "

provides details about an ECS cluster.

" + "smithy.api#documentation": "

Provides information about an Amazon ECS container.\n

" + } + }, + "com.amazonaws.securityhub#AwsEcsContainerDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEcsContainerDetails" } }, "com.amazonaws.securityhub#AwsEcsServiceCapacityProviderStrategyDetails": { @@ -6099,7 +6815,7 @@ } }, "traits": { - "smithy.api#documentation": "

details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

" + "smithy.api#documentation": "

Details about a task definition. A task definition describes the container and volume definitions\n of an Amazon Elastic Container Service task.

" } }, "com.amazonaws.securityhub#AwsEcsTaskDefinitionInferenceAcceleratorsDetails": { @@ -6354,182 +7070,400 @@ "target": "com.amazonaws.securityhub#AwsEcsTaskDefinitionVolumesDetails" } }, - "com.amazonaws.securityhub#AwsEksClusterDetails": { + "com.amazonaws.securityhub#AwsEcsTaskDetails": { "type": "structure", "members": { - "Arn": { + "ClusterArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster that hosts the task.\n

" } }, - "CertificateAuthorityData": { + "TaskDefinitionArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The certificate authority data for the cluster.

" + "smithy.api#documentation": "

The ARN of the task definition that creates the task.\n

" } }, - "ClusterStatus": { + "Version": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The status of the cluster.

" + "smithy.api#documentation": "

The version counter for the task.\n

" } }, - "Endpoint": { + "CreatedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The endpoint for the Amazon EKS API server.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task was created. More specifically, it's for the time when \nthe task entered the PENDING state.\n

" } }, - "Name": { + "StartedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the cluster.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task started. More specifically, it's for the time when the \n task transitioned from the PENDING state to the RUNNING state.\n

" } }, - "ResourcesVpcConfig": { - "target": "com.amazonaws.securityhub#AwsEksClusterResourcesVpcConfigDetails", + "StartedBy": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The VPC configuration used by the cluster control plane.

" + "smithy.api#documentation": "

The tag specified when a task is started. If an Amazon ECS service started the task, the \n startedBy parameter contains the deployment ID of that service.\n

" } }, - "RoleArn": { + "Group": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.

" + "smithy.api#documentation": "

The name of the task group that's associated with the task.\n

" } }, - "Version": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Volumes": { + "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeDetailsList", "traits": { - "smithy.api#documentation": "

The Amazon EKS server version for the cluster.

" + "smithy.api#documentation": "

Details about the data volume that is used in a task definition.\n

" } }, - "Logging": { - "target": "com.amazonaws.securityhub#AwsEksClusterLoggingDetails", + "Containers": { + "target": "com.amazonaws.securityhub#AwsEcsContainerDetailsList", "traits": { - "smithy.api#documentation": "

The logging configuration for the cluster.

" + "smithy.api#documentation": "

The containers that are associated with the task.\n

" } } }, "traits": { - "smithy.api#documentation": "

Provides details about an Amazon EKS cluster.

" + "smithy.api#documentation": "

Provides details about a task in a cluster.\n

" } }, - "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingDetails": { + "com.amazonaws.securityhub#AwsEcsTaskVolumeDetails": { "type": "structure", "members": { - "Enabled": { - "target": "com.amazonaws.securityhub#Boolean", + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Whether the logging types that are listed in Types are enabled.

" + "smithy.api#documentation": "

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and \nhyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.\n

" } }, - "Types": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "Host": { + "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeHostDetails", "traits": { - "smithy.api#documentation": "

A list of logging types.

" + "smithy.api#documentation": "

This parameter is specified when you use bind mount host volumes. The contents of the host parameter \ndetermine whether your bind mount host volume persists on the host container instance and where it's stored. \n

" } } }, "traits": { - "smithy.api#documentation": "

Details for a cluster logging configuration.

" + "smithy.api#documentation": "

Provides information about a data volume that's used in a task definition.\n

" } }, - "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingList": { + "com.amazonaws.securityhub#AwsEcsTaskVolumeDetailsList": { "type": "list", "member": { - "target": "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingDetails" + "target": "com.amazonaws.securityhub#AwsEcsTaskVolumeDetails" } }, - "com.amazonaws.securityhub#AwsEksClusterLoggingDetails": { + "com.amazonaws.securityhub#AwsEcsTaskVolumeHostDetails": { "type": "structure", "members": { - "ClusterLogging": { - "target": "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingList", + "SourcePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Cluster logging configurations.

" + "smithy.api#documentation": "

When the host parameter is used, specify a sourcePath to declare the path \non the host container instance that's presented to the container.\n

" } } }, "traits": { - "smithy.api#documentation": "

The logging configuration for an Amazon EKS cluster.

" + "smithy.api#documentation": "

Provides details on a container instance bind mount host volume.\n

" } }, - "com.amazonaws.securityhub#AwsEksClusterResourcesVpcConfigDetails": { + "com.amazonaws.securityhub#AwsEfsAccessPointDetails": { "type": "structure", "members": { - "SecurityGroupIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "AccessPointId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The security groups that are associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Amazon EKS control plane.

" + "smithy.api#documentation": "

The ID of the Amazon EFS access point.\n

" } }, - "SubnetIds": { - "target": "com.amazonaws.securityhub#NonEmptyStringList", + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The subnets that are associated with the cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon EFS access point.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the VPC configuration used by the cluster control plane.

" - } - }, - "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentDetails": { - "type": "structure", - "members": { - "ApplicationName": { + }, + "ClientToken": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the application that is associated with the environment.

" + "smithy.api#documentation": "

The opaque string specified in the request to ensure idempotent creation.\n

" } }, - "Cname": { + "FileSystemId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The URL to the CNAME for this environment.

" + "smithy.api#documentation": "

The ID of the Amazon EFS file system that the access point applies to.\n

" } }, - "DateCreated": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "PosixUser": { + "target": "com.amazonaws.securityhub#AwsEfsAccessPointPosixUserDetails", "traits": { - "smithy.api#documentation": "

The creation date for this environment.

" + "smithy.api#documentation": "

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point, \nthat is used for all file operations by NFS clients using the access point.\n

" } }, - "DateUpdated": { + "RootDirectory": { + "target": "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryDetails", + "traits": { + "smithy.api#documentation": "

The directory on the Amazon EFS file system that the access point exposes as the root \ndirectory to NFS clients using the access point.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon EFS access point.\n

" + } + }, + "com.amazonaws.securityhub#AwsEfsAccessPointPosixUserDetails": { + "type": "structure", + "members": { + "Gid": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The date when this environment was last modified.

" + "smithy.api#documentation": "

The POSIX group ID used for all file system operations using this access point.\n

" } }, - "Description": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "SecondaryGids": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", "traits": { - "smithy.api#documentation": "

A description of the environment.

" + "smithy.api#documentation": "

Secondary POSIX group IDs used for all file system operations using this access point.\n

" } }, - "EndpointUrl": { + "Uid": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

" + "smithy.api#documentation": "

The POSIX user ID used for all file system operations using this access point.\n

" } - }, - "EnvironmentArn": { + } + }, + "traits": { + "smithy.api#documentation": "

Provides details for all file system operations using this Amazon EFS access point.\n

" + } + }, + "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryCreationInfoDetails": { + "type": "structure", + "members": { + "OwnerGid": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the environment.

" + "smithy.api#documentation": "

Specifies the POSIX group ID to apply to the root directory. \n

" } }, - "EnvironmentId": { + "OwnerUid": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The identifier of the environment.

" + "smithy.api#documentation": "

Specifies the POSIX user ID to apply to the root directory.\n

" } }, - "EnvironmentLinks": { - "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks", - "traits": { + "Permissions": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the POSIX permissions to apply to the root directory, in the format of an octal number \nrepresenting the file's mode bits.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the settings that Amazon EFS uses to create the root directory \nwhen a client connects to an access point.\n

" + } + }, + "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryDetails": { + "type": "structure", + "members": { + "CreationInfo": { + "target": "com.amazonaws.securityhub#AwsEfsAccessPointRootDirectoryCreationInfoDetails", + "traits": { + "smithy.api#documentation": "

Specifies the POSIX IDs and permissions to apply to the access point's root directory.\n

" + } + }, + "Path": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the path on the Amazon EFS file system to expose as the root directory to NFS clients \nusing the access point to access the EFS file system. A path can have up to four subdirectories. If the specified \npath does not exist, you are required to provide CreationInfo.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the directory on the Amazon EFS file system that the access point exposes \nas the root directory to NFS clients using the access point.\n

" + } + }, + "com.amazonaws.securityhub#AwsEksClusterDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the cluster.

" + } + }, + "CertificateAuthorityData": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The certificate authority data for the cluster.

" + } + }, + "ClusterStatus": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The status of the cluster.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The endpoint for the Amazon EKS API server.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the cluster.

" + } + }, + "ResourcesVpcConfig": { + "target": "com.amazonaws.securityhub#AwsEksClusterResourcesVpcConfigDetails", + "traits": { + "smithy.api#documentation": "

The VPC configuration used by the cluster control plane.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.

" + } + }, + "Version": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon EKS server version for the cluster.

" + } + }, + "Logging": { + "target": "com.amazonaws.securityhub#AwsEksClusterLoggingDetails", + "traits": { + "smithy.api#documentation": "

The logging configuration for the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about an Amazon EKS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the logging types that are listed in Types are enabled.

" + } + }, + "Types": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

A list of logging types.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for a cluster logging configuration.

" + } + }, + "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingDetails" + } + }, + "com.amazonaws.securityhub#AwsEksClusterLoggingDetails": { + "type": "structure", + "members": { + "ClusterLogging": { + "target": "com.amazonaws.securityhub#AwsEksClusterLoggingClusterLoggingList", + "traits": { + "smithy.api#documentation": "

Cluster logging configurations.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logging configuration for an Amazon EKS cluster.

" + } + }, + "com.amazonaws.securityhub#AwsEksClusterResourcesVpcConfigDetails": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The security groups that are associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Amazon EKS control plane.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "

The subnets that are associated with the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the VPC configuration used by the cluster control plane.

" + } + }, + "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentDetails": { + "type": "structure", + "members": { + "ApplicationName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the application that is associated with the environment.

" + } + }, + "Cname": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The URL to the CNAME for this environment.

" + } + }, + "DateCreated": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The creation date for this environment.

" + } + }, + "DateUpdated": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The date when this environment was last modified.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the environment.

" + } + }, + "EndpointUrl": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

" + } + }, + "EnvironmentArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the environment.

" + } + }, + "EnvironmentId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the environment.

" + } + }, + "EnvironmentLinks": { + "target": "com.amazonaws.securityhub#AwsElasticBeanstalkEnvironmentEnvironmentLinks", + "traits": { "smithy.api#documentation": "

Links to other environments in the same group.

" } }, @@ -6852,7 +7786,7 @@ "KmsKeyId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

" + "smithy.api#documentation": "

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

" } } }, @@ -8244,6 +9178,64 @@ "target": "com.amazonaws.securityhub#AwsIamUserPolicy" } }, + "com.amazonaws.securityhub#AwsKinesisStreamDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the Kinesis stream. If you don't specify a name, CloudFront generates a unique \nphysical ID and uses that ID for the stream name.\n

" + } + }, + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis data stream.\n

" + } + }, + "StreamEncryption": { + "target": "com.amazonaws.securityhub#AwsKinesisStreamStreamEncryptionDetails", + "traits": { + "smithy.api#documentation": "

When specified, enables or updates server-side encryption using an KMS key for a specified stream. \nRemoving this property from your stack template and updating your stack disables encryption.\n

" + } + }, + "ShardCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of shards that the stream uses. \n

" + } + }, + "RetentionPeriodHours": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The number of hours for the data records that are stored in shards to remain accessible. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an Amazon Kinesis data stream.\n

" + } + }, + "com.amazonaws.securityhub#AwsKinesisStreamStreamEncryptionDetails": { + "type": "structure", + "members": { + "EncryptionType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The encryption type to use.\n

" + } + }, + "KeyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The globally unique identifier for the customer-managed KMS key to use for encryption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about stream encryption.\n

" + } + }, "com.amazonaws.securityhub#AwsKmsKeyDetails": { "type": "structure", "members": { @@ -8286,7 +9278,7 @@ "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A description of the key.

" + "smithy.api#documentation": "

A description of the KMS key.

" } }, "KeyRotationStatus": { @@ -8597,27 +9589,53 @@ "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { "type": "long" }, - "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails": { + "com.amazonaws.securityhub#AwsMountPoint": { "type": "structure", "members": { - "DeleteProtection": { - "target": "com.amazonaws.securityhub#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.

" - } - }, - "Description": { + "SourceVolume": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A description of the firewall.

" + "smithy.api#documentation": "

The name of the volume to mount. Must be a volume name referenced in the name parameter \nof task definition volume.\n

" } }, - "FirewallArn": { + "ContainerPath": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the firewall.

" + "smithy.api#documentation": "

The path on the container to mount the host volume at.\n

" } - }, + } + }, + "traits": { + "smithy.api#documentation": "

Details for a volume mount point that's used in a container definition.\n

" + } + }, + "com.amazonaws.securityhub#AwsMountPointList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsMountPoint" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails": { + "type": "structure", + "members": { + "DeleteProtection": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.

" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the firewall.

" + } + }, + "FirewallArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ARN of the firewall.

" + } + }, "FirewallId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -8773,6 +9791,32 @@ "smithy.api#documentation": "

Details about an Network Firewall rule group. Rule groups are used to inspect and control network traffic. Stateless rule groups apply to individual packets. Stateful rule groups apply to packets in the context of their traffic flow.

\n

Rule groups are referenced in firewall policies.\n

" } }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Enables fine-grained access control.\n

" + } + }, + "InternalUserDatabaseEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Enables the internal user database.\n

" + } + }, + "MasterUserOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainMasterUserOptionsDetails", + "traits": { + "smithy.api#documentation": "

Specifies information about the master user of the domain.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about domain access control options.\n

" + } + }, "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails": { "type": "structure", "members": { @@ -8941,6 +9985,12 @@ "traits": { "smithy.api#documentation": "

The domain endpoints. Used if the OpenSearch domain resides in a VPC.

\n

This is a map of key-value pairs. The key is always vpc. The value is the endpoint.

" } + }, + "AdvancedSecurityOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails", + "traits": { + "smithy.api#documentation": "

Specifies options for fine-grained access control.\n

" + } } }, "traits": { @@ -9051,6 +10101,32 @@ "smithy.api#documentation": "

Configures the CloudWatch Logs to publish for the OpenSearch domain.

" } }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainMasterUserOptionsDetails": { + "type": "structure", + "members": { + "MasterUserArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the master user.\n

" + } + }, + "MasterUserName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The username for the master user.\n

" + } + }, + "MasterUserPassword": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The password for the master user.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies information about the master user of the domain.\n

" + } + }, "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails": { "type": "structure", "members": { @@ -10856,7 +11932,7 @@ "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The number of days that manual snapshots are retained in the destination region after\n they are copied from a source region.

\n

If the value is -1, then the manual snapshot is retained indefinitely.

\n

Valid values: Either -1 or an integer between 1 and 3,653

" + "smithy.api#documentation": "

The number of days that manual snapshots are retained in the destination region after\n they are copied from a source region.

\n

If the value is -1,\n then the manual snapshot is retained indefinitely.

\n

Valid values: Either -1\n or an integer between 1 and 3,653

" } }, "RetentionPeriod": { @@ -11082,7 +12158,7 @@ "ManualSnapshotRetentionPeriod": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The default number of days to retain a manual snapshot.

\n

If the value is -1, the snapshot is retained indefinitely.

\n

This setting doesn't change the retention period of existing snapshots.

\n

Valid values: Either -1 or an integer between 1 and 3,653

" + "smithy.api#documentation": "

The default number of days to retain a manual snapshot.

\n

If the value is -1, the snapshot is retained indefinitely.

\n

This setting doesn't change the retention period of existing snapshots.

\n

Valid values: Either -1 or an integer between 1 and 3,653

" } }, "MasterUsername": { @@ -12515,6 +13591,12 @@ "smithy.api#documentation": "

The details of process-related information about a finding.

" } }, + "Threats": { + "target": "com.amazonaws.securityhub#ThreatList", + "traits": { + "smithy.api#documentation": "

Details about the threat detected in a security finding and the file paths that were affected by the threat.\n

" + } + }, "ThreatIntelIndicators": { "target": "com.amazonaws.securityhub#ThreatIntelIndicatorList", "traits": { @@ -13241,13 +14323,13 @@ "Subscription": { "target": "com.amazonaws.securityhub#AwsSnsTopicSubscriptionList", "traits": { - "smithy.api#documentation": "

Subscription is an embedded property that describes the subscription endpoints of an SNS topic.

" + "smithy.api#documentation": "

Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.

" } }, "TopicName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the topic.

" + "smithy.api#documentation": "

The name of the Amazon SNS topic.

" } }, "Owner": { @@ -13255,10 +14337,52 @@ "traits": { "smithy.api#documentation": "

The subscription's owner.

" } + }, + "SqsSuccessFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.\n

" + } + }, + "SqsFailureFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.\n

" + } + }, + "ApplicationSuccessFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.\n

" + } + }, + "FirehoseSuccessFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.\n

" + } + }, + "FirehoseFailureFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.\n

" + } + }, + "HttpSuccessFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.\n

" + } + }, + "HttpFailureFeedbackRoleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.

" + } } }, "traits": { - "smithy.api#documentation": "

A wrapper type for the topic's ARN.

" + "smithy.api#documentation": "

Provides information about an Amazon SNS topic to which notifications can be published.

" } }, "com.amazonaws.securityhub#AwsSnsTopicSubscription": { @@ -13499,120 +14623,526 @@ "MatchPredicates": { "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicateList", "traits": { - "smithy.api#documentation": "

The predicates to include in the rate-based rule.

" + "smithy.api#documentation": "

The predicates to include in the rate-based rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

" + } + }, + "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicate": { + "type": "structure", + "members": { + "DataId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the predicate.

" + } + }, + "Negated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

If set to true, then the rule actions are performed on requests that match the predicate settings.

\n

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of predicate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

" + } + }, + "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicate" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the metrics for the rate-based rule.

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the rate-based rule.

" + } + }, + "RateKey": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

" + } + }, + "RateLimit": { + "target": "com.amazonaws.securityhub#Long", + "traits": { + "smithy.api#documentation": "

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the rate-based rule.

" + } + }, + "MatchPredicates": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicateList", + "traits": { + "smithy.api#documentation": "

The predicates to include in the rate-based rule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

contains details about a rate-based rule for Regional resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate": { + "type": "structure", + "members": { + "DataId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The unique identifier for the predicate.

" + } + }, + "Negated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

If set to true, then the rule actions are performed on requests that match the predicate settings.

\n

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of predicate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details for a match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for the rule. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name for the rule.\n

" + } + }, + "PredicateList": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList", + "traits": { + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet,\n SqlInjectionMatchSet, XssMatchSet, RegexMatchSet,\n GeoMatchSet, and SizeConstraintSet objects that you want to\n add to a rule and, for each object, indicates whether you want to negate the settings.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an WAF Regional rule. This rule identifies the web requests that you want to allow, block, or count.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for this rule group.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The descriptive name of the rule group.\n

" + } + }, + "RuleGroupId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the rule group.\n

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList", + "traits": { + "smithy.api#documentation": "

Provides information about the rule statements used to identify the web requests that you want to allow, block, or \ncount. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about an WAF Regional rule group. The rule group is a collection of rules for inspecting and controlling web\n requests.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, \nGeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the action that AWS WAF should take on a web request when it matches the criteria defined in the rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesActionDetails", + "traits": { + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the criteria defined in the rule.

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in\n order based on the value of Priority.

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID for a rule.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of rule in the rule group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the rules attached to a rule group\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupRulesDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRulePredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalRulePredicateListDetails": { + "type": "structure", + "members": { + "DataId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.\n

" + } + }, + "Negated": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The type of predicate in a rule, such as ByteMatch or IPSet.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclDetails": { + "type": "structure", + "members": { + "DefaultAction": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match. \n

" + } + }, + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A name for the metrics for this web ACL. \n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name for the web ACL. \n

" + } + }, + "RulesList": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList", + "traits": { + "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of \nthe rule.\n

" + } + }, + "WebAclId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the web ACL.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the web access control list (web ACL). The web ACL contains the rules that identify the requests that you\n want to allow, block, or count.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The action that WAF takes when a web request matches all conditions in the\n rule, such as allow, block, or count the request.

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListActionDetails", + "traits": { + "smithy.api#documentation": "

The action that AWS WAF takes when a web request matches all conditions in the rule, such as allow, \n block, or count the request.\n

" + } + }, + "OverrideAction": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails", + "traits": { + "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group. \n

" + } + }, + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

The order in which WAF evaluates the rules in a web ACL.\n

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of an WAF Regional rule to associate with a web ACL.

" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

For actions that are associated with a rule, the action that WAF takes when a web \nrequest matches all conditions in a rule.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet \nobjects that identify the web requests that you want to allow, block, or count. \n

" + } + }, + "com.amazonaws.securityhub#AwsWafRegionalWebAclRulesListOverrideActionDetails": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Overrides the rule evaluation result in the rule group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the action to use in the place of the action that results from the rule group \nevaluation. \n

" + } + }, + "com.amazonaws.securityhub#AwsWafRuleDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the metrics for this rule.\n

" + } + }, + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A descriptive name for the rule. \n

" + } + }, + "PredicateList": { + "target": "com.amazonaws.securityhub#AwsWafRulePredicateList", + "traits": { + "smithy.api#documentation": "

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \n for each object, indicates whether you want to negate the settings.\n

" + } + }, + "RuleId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The ID of the WAF rule. \n

" } } }, "traits": { - "smithy.api#documentation": "

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

" + "smithy.api#documentation": "

Provides information about a WAF rule. This rule specifies the web requests that you want to allow, block, or count.\n

" } }, - "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicate": { + "com.amazonaws.securityhub#AwsWafRuleGroupDetails": { "type": "structure", "members": { - "DataId": { + "MetricName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The unique identifier for the predicate.

" + "smithy.api#documentation": "

The name of the metrics for this rule group. \n

" } }, - "Negated": { - "target": "com.amazonaws.securityhub#Boolean", + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

If set to true, then the rule actions are performed on requests that match the predicate settings.

\n

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.\n

" + "smithy.api#documentation": "

The name of the rule group. \n

" } }, - "Type": { + "RuleGroupId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of predicate.

" + "smithy.api#documentation": "

The ID of the rule group.\n

" + } + }, + "Rules": { + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesList", + "traits": { + "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \nallow, block, or count. \n

" } } }, "traits": { - "smithy.api#documentation": "

A match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

" - } - }, - "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicateList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRateBasedRuleMatchPredicate" + "smithy.api#documentation": "

Provides information about an WAF rule group. A rule group is a collection of rules for inspecting and controlling web requests. \n

" } }, - "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleDetails": { + "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails": { "type": "structure", "members": { - "MetricName": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the metrics for the rate-based rule.

" - } - }, - "Name": { + "Type": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the rate-based rule.

" + "smithy.api#documentation": "

The action that WAF should take on a web request when it matches the rule's\n statement.

" } - }, - "RateKey": { - "target": "com.amazonaws.securityhub#NonEmptyString", + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" + } + }, + "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesActionDetails", "traits": { - "smithy.api#documentation": "

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

" + "smithy.api#documentation": "

Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.\n

" } }, - "RateLimit": { - "target": "com.amazonaws.securityhub#Long", + "Priority": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

" + "smithy.api#documentation": "

If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order\n based on the value of Priority.

" } }, "RuleId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The unique identifier for the rate-based rule.

" + "smithy.api#documentation": "

The rule ID for a rule.\n

" } }, - "MatchPredicates": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicateList", + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The predicates to include in the rate-based rule.

" + "smithy.api#documentation": "

The type of rule.\n

" } } }, "traits": { - "smithy.api#documentation": "

contains details about a rate-based rule for Regional resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

" + "smithy.api#documentation": "

Provides information about the rules attached to the rule group. These rules identify the web requests that you want to \n allow, block, or count. \n

" } }, - "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate": { + "com.amazonaws.securityhub#AwsWafRuleGroupRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRuleGroupRulesDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRulePredicateList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsWafRulePredicateListDetails" + } + }, + "com.amazonaws.securityhub#AwsWafRulePredicateListDetails": { "type": "structure", "members": { "DataId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The unique identifier for the predicate.

" + "smithy.api#documentation": "

A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.\n

" } }, "Negated": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

If set to true, then the rule actions are performed on requests that match the predicate settings.

\n

If set to false, then the rule actions are performed on all requests except those that match the predicate settings.

" + "smithy.api#documentation": "

Specifies if you want WAF to allow, block, or count requests based on the settings in the \n ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, or SizeConstraintSet.\n

" } }, "Type": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The type of predicate.

" + "smithy.api#documentation": "

The type of predicate in a rule, such as ByteMatch or IPSet.\n

" } } }, "traits": { - "smithy.api#documentation": "

Details for a match predicate. A predicate might look for characteristics such as specific IP addresses, geographic locations, or sizes.

" - } - }, - "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicateList": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#AwsWafRegionalRateBasedRuleMatchPredicate" + "smithy.api#documentation": "

Provides details about the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, \n RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, \nfor each object, indicates whether you want to negate the settings.\n

" } }, "com.amazonaws.securityhub#AwsWafWebAclDetails": { @@ -13621,30 +15151,30 @@ "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A friendly name or description of the WebACL. You can't change the name of a WebACL\n after you create it.

" + "smithy.api#documentation": "

A friendly name or description of the web ACL. You can't change the name of a web ACL after you create it.

" } }, "DefaultAction": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The action to perform if none of the rules contained in the WebACL match.

" + "smithy.api#documentation": "

The action to perform if none of the rules contained in the web ACL match.

" } }, "Rules": { "target": "com.amazonaws.securityhub#AwsWafWebAclRuleList", "traits": { - "smithy.api#documentation": "

An array that contains the action for each rule in a WebACL, the priority of the rule,\n and the ID of the rule.

" + "smithy.api#documentation": "

An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.

" } }, "WebAclId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

A unique identifier for a WebACL.

" + "smithy.api#documentation": "

A unique identifier for a web ACL.

" } } }, "traits": { - "smithy.api#documentation": "

Details about an WAF WebACL.

" + "smithy.api#documentation": "

Provides information about an WAF web access control list (web ACL).

" } }, "com.amazonaws.securityhub#AwsWafWebAclRule": { @@ -13665,13 +15195,13 @@ "OverrideAction": { "target": "com.amazonaws.securityhub#WafOverrideAction", "traits": { - "smithy.api#documentation": "

Use the OverrideAction to test your RuleGroup.

\n

Any rule in a RuleGroup can potentially block a request. If you set the\n OverrideAction to None, the RuleGroup blocks a request if any\n individual rule in the RuleGroup matches the request and is configured to block that\n request.

\n

However, if you first want to test the RuleGroup, set the OverrideAction to\n Count. The RuleGroup then overrides any block action specified by\n individual rules contained within the group. Instead of blocking matching requests, those\n requests are counted.

\n

\n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup to a WebACL. In this case you do not use\n ActivatedRule|Action. For all other update requests,\n ActivatedRule|Action is used instead of\n ActivatedRule|OverrideAction.

" + "smithy.api#documentation": "

Use the OverrideAction to test your RuleGroup.

\n

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to\n None, the RuleGroup blocks a request if any individual rule in the RuleGroup\n matches the request and is configured to block that request.

\n

However, if you first want to test the RuleGroup,\n set the OverrideAction to Count. The RuleGroup\n then overrides any block action specified by individual rules contained within the group.\n Instead of blocking matching requests, those requests are counted.

\n

\n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup\n to a web ACL. In this case you do not use ActivatedRule \n Action. For all other update requests,\n ActivatedRule \n Action is used instead of ActivatedRule \n OverrideAction.

" } }, "Priority": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Specifies the order in which the rules in a WebACL are evaluated. Rules with a lower\n value for Priority are evaluated before rules with a higher value. The value\n must be a unique integer. If you add multiple rules to a WebACL, the values do not need to\n be consecutive.

" + "smithy.api#documentation": "

Specifies the order in which the rules in a web\n ACL are evaluated. Rules with a lower value for Priority are\n evaluated before rules with a higher value. The value must be a unique integer. If you add\n multiple rules to a web ACL, the values do not need to be consecutive.

" } }, "RuleId": { @@ -13688,7 +15218,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details for a rule in an WAF WebACL.

" + "smithy.api#documentation": "

Details for a rule in an WAF web ACL.

" } }, "com.amazonaws.securityhub#AwsWafWebAclRuleList": { @@ -14288,6 +15818,12 @@ "com.amazonaws.securityhub#ContainerDetails": { "type": "structure", "members": { + "ContainerRuntime": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The runtime of the container.\n

" + } + }, "Name": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { @@ -14297,13 +15833,13 @@ "ImageId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The identifier of the image related to a finding.

" + "smithy.api#documentation": "

The identifier of the container image related to a finding.

" } }, "ImageName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The name of the image related to a finding.

" + "smithy.api#documentation": "

The name of the container image related to a finding.

" } }, "LaunchedAt": { @@ -14311,6 +15847,18 @@ "traits": { "smithy.api#documentation": "

Indicates when the container started.

\n

Uses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.

" } + }, + "VolumeMounts": { + "target": "com.amazonaws.securityhub#VolumeMountList", + "traits": { + "smithy.api#documentation": "

Provides information about the mounting of a volume in a container.\n

" + } + }, + "Privileged": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host \ncontainer instance (similar to the root user). \n

" + } } }, "traits": { @@ -16073,6 +17621,44 @@ "target": "com.amazonaws.securityhub#NonEmptyString" } }, + "com.amazonaws.securityhub#FilePathList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FilePaths" + } + }, + "com.amazonaws.securityhub#FilePaths": { + "type": "structure", + "members": { + "FilePath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Path to the infected or suspicious file on the resource it was detected on.\n\t\t

" + } + }, + "FileName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the infected or suspicious file corresponding to the hash.\n\t\t

" + } + }, + "ResourceId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource on which the threat was detected.\n\t\t

" + } + }, + "Hash": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hash value for the infected or suspicious file.\n\t\t

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the file paths that were affected by the threat.\n\t\t

" + } + }, "com.amazonaws.securityhub#FindingAggregator": { "type": "structure", "members": { @@ -16874,13 +18460,13 @@ "Code": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The ICMP code for which to deny or allow access. To deny or allow all codes, use the value -1.

" + "smithy.api#documentation": "

The ICMP code for which to deny or allow access. To deny or allow all codes, use the\n value -1.

" } }, "Type": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

The ICMP type for which to deny or allow access. To deny or allow all types, use the value -1.

" + "smithy.api#documentation": "

The ICMP type for which to deny or allow access. To deny or allow all types, use the\n value -1.

" } } }, @@ -18980,13 +20566,13 @@ "AwsEc2Volume": { "target": "com.amazonaws.securityhub#AwsEc2VolumeDetails", "traits": { - "smithy.api#documentation": "

Details for an EC2 volume.

" + "smithy.api#documentation": "

Details for an Amazon EC2 volume.

" } }, "AwsEc2Vpc": { "target": "com.amazonaws.securityhub#AwsEc2VpcDetails", "traits": { - "smithy.api#documentation": "

Details for an EC2 VPC.

" + "smithy.api#documentation": "

Details for an Amazon EC2 VPC.

" } }, "AwsEc2Eip": { @@ -19178,7 +20764,7 @@ "AwsWafWebAcl": { "target": "com.amazonaws.securityhub#AwsWafWebAclDetails", "traits": { - "smithy.api#documentation": "

Details for an WAF WebACL.

" + "smithy.api#documentation": "

Details for an WAF web ACL.

" } }, "AwsRdsDbSnapshot": { @@ -19202,7 +20788,13 @@ "AwsEcsCluster": { "target": "com.amazonaws.securityhub#AwsEcsClusterDetails", "traits": { - "smithy.api#documentation": "

Details about an ECS cluster.

" + "smithy.api#documentation": "

Details about an Amazon ECS cluster.

" + } + }, + "AwsEcsContainer": { + "target": "com.amazonaws.securityhub#AwsEcsContainerDetails", + "traits": { + "smithy.api#documentation": "

Provides information about a Docker container that's part of a task.\n

" } }, "AwsEcsTaskDefinition": { @@ -19244,7 +20836,7 @@ "AwsEc2VpnConnection": { "target": "com.amazonaws.securityhub#AwsEc2VpnConnectionDetails", "traits": { - "smithy.api#documentation": "

Details about an EC2 VPN connection.

" + "smithy.api#documentation": "

Details about an Amazon EC2 VPN connection.

" } }, "AwsEcrContainerImage": { @@ -19318,6 +20910,78 @@ "traits": { "smithy.api#documentation": "

Details about an Amazon RDS DB security group.

" } + }, + "AwsKinesisStream": { + "target": "com.amazonaws.securityhub#AwsKinesisStreamDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon Kinesis data stream.

" + } + }, + "AwsEc2TransitGateway": { + "target": "com.amazonaws.securityhub#AwsEc2TransitGatewayDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon EC2 transit gateway that interconnects your virtual private clouds (VPC) and on-premises networks.

" + } + }, + "AwsEfsAccessPoint": { + "target": "com.amazonaws.securityhub#AwsEfsAccessPointDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon EFS access point. An access point is an application-specific view into an EFS file system that \napplies an operating system user and group, and a file system path, to any file system request made through the access point. \n

" + } + }, + "AwsCloudFormationStack": { + "target": "com.amazonaws.securityhub#AwsCloudFormationStackDetails", + "traits": { + "smithy.api#documentation": "

Details about an CloudFormation stack. A stack is a collection of Amazon Web Services resources that you can manage as a single unit.

" + } + }, + "AwsCloudWatchAlarm": { + "target": "com.amazonaws.securityhub#AwsCloudWatchAlarmDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon CloudWatch alarm. An alarm allows you to monitor and receive alerts about your Amazon Web Services resources and applications across multiple Regions.

" + } + }, + "AwsEc2VpcPeeringConnection": { + "target": "com.amazonaws.securityhub#AwsEc2VpcPeeringConnectionDetails", + "traits": { + "smithy.api#documentation": "

Details about an Amazon EC2 VPC peering connection. A VPC peering connection is\n a networking connection between two VPCs that enables you to route traffic between them\n privately.\n

" + } + }, + "AwsWafRegionalRuleGroup": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleGroupDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF rule group for Regional resources.\n

" + } + }, + "AwsWafRegionalRule": { + "target": "com.amazonaws.securityhub#AwsWafRegionalRuleDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF rule for Regional resources.\n

" + } + }, + "AwsWafRegionalWebAcl": { + "target": "com.amazonaws.securityhub#AwsWafRegionalWebAclDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF web access control list (web ACL) for Regional resources.

" + } + }, + "AwsWafRule": { + "target": "com.amazonaws.securityhub#AwsWafRuleDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF rule for global resources.\n

" + } + }, + "AwsWafRuleGroup": { + "target": "com.amazonaws.securityhub#AwsWafRuleGroupDetails", + "traits": { + "smithy.api#documentation": "

Details about an WAF rule group for global resources.\n

" + } + }, + "AwsEcsTask": { + "target": "com.amazonaws.securityhub#AwsEcsTaskDetails", + "traits": { + "smithy.api#documentation": "

Details about a task in a cluster.

" + } } }, "traits": { @@ -20832,6 +22496,38 @@ } } }, + "com.amazonaws.securityhub#Threat": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the threat.\n\t\t

" + } + }, + "Severity": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The severity of the threat. \n\t\t

" + } + }, + "ItemCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "

This total number of items in which the threat has been detected.\n\t\t

" + } + }, + "FilePaths": { + "target": "com.amazonaws.securityhub#FilePathList", + "traits": { + "smithy.api#documentation": "

Provides information about the file paths that were affected by the threat.\n\t\t

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the threat detected in a security finding and the file paths that were affected by the threat.\n\t\t

" + } + }, "com.amazonaws.securityhub#ThreatIntelIndicator": { "type": "structure", "members": { @@ -20964,6 +22660,12 @@ ] } }, + "com.amazonaws.securityhub#ThreatList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Threat" + } + }, "com.amazonaws.securityhub#Timestamp": { "type": "timestamp", "traits": { @@ -21496,6 +23198,98 @@ ] } }, + "com.amazonaws.securityhub#VolumeMount": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the volume.\n

" + } + }, + "MountPath": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The path in the container at which the volume should be mounted.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the mounting of a volume in a container.\n

" + } + }, + "com.amazonaws.securityhub#VolumeMountList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#VolumeMount" + } + }, + "com.amazonaws.securityhub#VpcInfoCidrBlockSetDetails": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv4 CIDR block for the VPC.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the IPv4 CIDR blocks for the VPC.\n

" + } + }, + "com.amazonaws.securityhub#VpcInfoCidrBlockSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#VpcInfoCidrBlockSetDetails" + } + }, + "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetDetails": { + "type": "structure", + "members": { + "Ipv6CidrBlock": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The IPv6 CIDR block for the VPC.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides details about the IPv6 CIDR blocks for the VPC.\n

" + } + }, + "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#VpcInfoIpv6CidrBlockSetDetails" + } + }, + "com.amazonaws.securityhub#VpcInfoPeeringOptionsDetails": { + "type": "structure", + "members": { + "AllowDnsResolutionFromRemoteVpc": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.\n

" + } + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.\n

" + } + }, + "AllowEgressFromLocalVpcToRemoteClassicLink": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information about the VPC peering connection options for the accepter or requester VPC.\n

" + } + }, "com.amazonaws.securityhub#Vulnerability": { "type": "structure", "members": { @@ -21592,7 +23386,7 @@ "Type": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

Specifies how you want WAF to respond to requests that match the settings in a\n rule.

\n

Valid settings include the following:

\n
    \n
  • \n

    \n ALLOW - WAF allows requests

    \n
    • \n
  • \n

    \n BLOCK - WAF blocks requests

    \n
    • \n
  • \n

    \n COUNT - WAF increments a counter of the requests that match all\n of the conditions in the rule. WAF then continues to inspect the web request\n based on the remaining rules in the web ACL. You can't specify COUNT for\n the default action for a WebACL.

    \n
    • \n
" + "smithy.api#documentation": "

Specifies how you want WAF to respond to requests that match the settings in a\n rule.

\n

Valid settings include the following:

\n
    \n
  • \n

    \n ALLOW - WAF allows requests

    \n
    • \n
  • \n

    \n BLOCK - WAF blocks requests

    \n
    • \n
  • \n

    \n COUNT - WAF increments a counter of the requests that\n match all of the conditions in the rule. WAF then continues to inspect\n the web request based on the remaining rules in the web ACL. You can't specify\n COUNT for the default action for a web ACL.

    \n
    • \n
" } } }, diff --git a/aws/sdk/aws-models/servicecatalog-appregistry.json b/aws/sdk/aws-models/servicecatalog-appregistry.json index 9cae82b88..773e3ac12 100644 --- a/aws/sdk/aws-models/servicecatalog-appregistry.json +++ b/aws/sdk/aws-models/servicecatalog-appregistry.json @@ -93,6 +93,9 @@ { "target": "com.amazonaws.servicecatalogappregistry#ListAttributeGroups" }, + { + "target": "com.amazonaws.servicecatalogappregistry#ListAttributeGroupsForApplication" + }, { "target": "com.amazonaws.servicecatalogappregistry#ListTagsForResource" }, @@ -258,6 +261,9 @@ "target": "com.amazonaws.servicecatalogappregistry#AssociateAttributeGroupResponse" }, "errors": [ + { + "target": "com.amazonaws.servicecatalogappregistry#ConflictException" + }, { "target": "com.amazonaws.servicecatalogappregistry#InternalServerException" }, @@ -338,6 +344,9 @@ }, { "target": "com.amazonaws.servicecatalogappregistry#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.servicecatalogappregistry#ValidationException" } ], "traits": { @@ -459,6 +468,38 @@ "smithy.api#pattern": "^arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[a-z0-9]+$" } }, + "com.amazonaws.servicecatalogappregistry#AttributeGroupDetails": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.servicecatalogappregistry#AttributeGroupId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the attribute group.

" + } + }, + "arn": { + "target": "com.amazonaws.servicecatalogappregistry#AttributeGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) that specifies the attribute group.

" + } + }, + "name": { + "target": "com.amazonaws.servicecatalogappregistry#Name", + "traits": { + "smithy.api#documentation": "

The name of the attribute group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details related to a specific AttributeGroup.

" + } + }, + "com.amazonaws.servicecatalogappregistry#AttributeGroupDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.servicecatalogappregistry#AttributeGroupDetails" + } + }, "com.amazonaws.servicecatalogappregistry#AttributeGroupId": { "type": "string", "traits": { @@ -585,6 +626,9 @@ }, { "target": "com.amazonaws.servicecatalogappregistry#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.servicecatalogappregistry#ValidationException" } ], "traits": { @@ -913,6 +957,9 @@ }, { "target": "com.amazonaws.servicecatalogappregistry#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.servicecatalogappregistry#ValidationException" } ], "traits": { @@ -979,6 +1026,9 @@ "target": "com.amazonaws.servicecatalogappregistry#GetApplicationResponse" }, "errors": [ + { + "target": "com.amazonaws.servicecatalogappregistry#ConflictException" + }, { "target": "com.amazonaws.servicecatalogappregistry#InternalServerException" }, @@ -1148,6 +1198,9 @@ "target": "com.amazonaws.servicecatalogappregistry#GetAttributeGroupResponse" }, "errors": [ + { + "target": "com.amazonaws.servicecatalogappregistry#ConflictException" + }, { "target": "com.amazonaws.servicecatalogappregistry#InternalServerException" }, @@ -1287,6 +1340,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "applications", "pageSize": "maxResults" } } @@ -1358,6 +1412,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "attributeGroups", "pageSize": "maxResults" } } @@ -1437,6 +1492,7 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "resources", "pageSize": "maxResults" } } @@ -1513,10 +1569,91 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", + "items": "attributeGroups", "pageSize": "maxResults" } } }, + "com.amazonaws.servicecatalogappregistry#ListAttributeGroupsForApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.servicecatalogappregistry#ListAttributeGroupsForApplicationRequest" + }, + "output": { + "target": "com.amazonaws.servicecatalogappregistry#ListAttributeGroupsForApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.servicecatalogappregistry#InternalServerException" + }, + { + "target": "com.amazonaws.servicecatalogappregistry#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.servicecatalogappregistry#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the details of all attribute groups associated with a specific application. The results display in pages.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{application}/attribute-group-details", + "code": 200 + }, + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "attributeGroupsDetails", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.servicecatalogappregistry#ListAttributeGroupsForApplicationRequest": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.servicecatalogappregistry#ApplicationSpecifier", + "traits": { + "smithy.api#documentation": "

The name or ID of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.servicecatalogappregistry#NextToken", + "traits": { + "smithy.api#documentation": "

This token retrieves the next page of results after a previous API call.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.servicecatalogappregistry#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The upper bound of the number of results to return. The value cannot exceed 25. If you omit this parameter, it defaults to 25. This value is optional.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.servicecatalogappregistry#ListAttributeGroupsForApplicationResponse": { + "type": "structure", + "members": { + "attributeGroupsDetails": { + "target": "com.amazonaws.servicecatalogappregistry#AttributeGroupDetailsList", + "traits": { + "smithy.api#documentation": "

The details related to a specific AttributeGroup.

" + } + }, + "nextToken": { + "target": "com.amazonaws.servicecatalogappregistry#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next page of results after a previous API call.

" + } + } + } + }, "com.amazonaws.servicecatalogappregistry#ListAttributeGroupsRequest": { "type": "structure", "members": { @@ -2082,6 +2219,9 @@ }, { "target": "com.amazonaws.servicecatalogappregistry#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.servicecatalogappregistry#ValidationException" } ], "traits": { @@ -2110,7 +2250,7 @@ "smithy.api#deprecated": { "message": "Name update for application is deprecated." }, - "smithy.api#documentation": "

The new name of the application. The name must be unique in the region in which you are updating the application.

" + "smithy.api#documentation": "

Deprecated: The new name of the application. The name must be unique in the region in which you are\n updating the application. Please do not use this field as we have stopped supporting name updates.

" } }, "description": { @@ -2180,7 +2320,7 @@ "smithy.api#deprecated": { "message": "Name update for attribute group is deprecated." }, - "smithy.api#documentation": "

The new name of the attribute group. The name must be unique in the region in which you are\n updating the attribute group.

" + "smithy.api#documentation": "

Deprecated: The new name of the attribute group. The name must be unique in the region in which you are\n updating the attribute group. Please do not use this field as we have stopped supporting name updates.

" } }, "description": { diff --git a/aws/sdk/aws-models/streams.dynamodb.json b/aws/sdk/aws-models/streams.dynamodb.json index 0f4802625..4c3515c20 100644 --- a/aws/sdk/aws-models/streams.dynamodb.json +++ b/aws/sdk/aws-models/streams.dynamodb.json @@ -95,7 +95,7 @@ "L": { "target": "com.amazonaws.dynamodbstreams#ListAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]\n

" + "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\": \"3.14159\"}]\n

" } }, "NULL": { @@ -196,21 +196,6 @@ }, "com.amazonaws.dynamodbstreams#DynamoDBStreams_20120810": { "type": "service", - "version": "2012-08-10", - "operations": [ - { - "target": "com.amazonaws.dynamodbstreams#DescribeStream" - }, - { - "target": "com.amazonaws.dynamodbstreams#GetRecords" - }, - { - "target": "com.amazonaws.dynamodbstreams#GetShardIterator" - }, - { - "target": "com.amazonaws.dynamodbstreams#ListStreams" - } - ], "traits": { "aws.api#service": { "sdkId": "DynamoDB Streams", @@ -228,7 +213,22 @@ "smithy.api#xmlNamespace": { "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" } - } + }, + "version": "2012-08-10", + "operations": [ + { + "target": "com.amazonaws.dynamodbstreams#DescribeStream" + }, + { + "target": "com.amazonaws.dynamodbstreams#GetRecords" + }, + { + "target": "com.amazonaws.dynamodbstreams#GetShardIterator" + }, + { + "target": "com.amazonaws.dynamodbstreams#ListStreams" + } + ] }, "com.amazonaws.dynamodbstreams#ErrorMessage": { "type": "string" @@ -494,7 +494,7 @@ } }, "traits": { - "smithy.api#documentation": "

There is no limit to the number of daily on-demand backups that can be\n taken.

\n

Up to 50 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and\n RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary\n indexes. You can have up to 25 such requests running at a time; however, if the table or\n index specifications are complex, DynamoDB might temporarily reduce the number of\n concurrent operations.

\n

There is a soft account quota of 256 tables.

", + "smithy.api#documentation": "

There is no limit to the number of daily on-demand backups that can be taken.

\n

Up to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary\n indexes. You can have up to 250 such requests running at a time; however, if the table or\n index specifications are complex, DynamoDB might temporarily reduce the number\n of concurrent operations.

\n

There is a soft account quota of 2,500 tables.

", "smithy.api#error": "client" } }, @@ -1022,7 +1022,7 @@ "min": 3, "max": 255 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.dynamodbstreams#TrimmedDataAccessException": { diff --git a/aws/sdk/aws-models/transcribe.json b/aws/sdk/aws-models/transcribe.json index bed80bf6d..f06a4db76 100644 --- a/aws/sdk/aws-models/transcribe.json +++ b/aws/sdk/aws-models/transcribe.json @@ -35,30 +35,30 @@ "StartTime": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

A value that indicates the beginning of the time range in seconds. To set absolute time\n range, you must specify a start time and an end time. For example, if you specify the following\n values:

\n
    \n
  • \n

    StartTime - 10000

    \n
    • \n
  • \n

    Endtime - 50000

    \n
    • \n
\n

The time range is set between 10,000 milliseconds and 50,000 milliseconds into the\n call.

" + "smithy.api#documentation": "

The time, in milliseconds, when Amazon Transcribe starts searching for the specified \n criteria in your audio. If you include StartTime in your request, you must also \n include EndTime.

" } }, "EndTime": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

A value that indicates the end of the time range in milliseconds. To set absolute time \n range, you must specify a start time and an end time. For example, if you specify the following\n values:

\n
    \n
  • \n

    StartTime - 10000

    \n
    • \n
  • \n

    Endtime - 50000

    \n
    • \n
\n

The time range is set between 10,000 milliseconds and 50,000 milliseconds into the \n call.

" + "smithy.api#documentation": "

The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria\n in your audio. If you include EndTime in your request, you must also include\n StartTime.

" } }, "First": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

A time range from the beginning of the call to the value that you've specified. For example, \n if you specify 100000, the time range is set to the first 100,000 milliseconds\n of the call.

" + "smithy.api#documentation": "

The time, in milliseconds, from the start of your media file until the value you specify in\n which Amazon Transcribe searches for your specified criteria.

" } }, "Last": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

A time range from the value that you've specified to the end of the call. For example, if you\n specify 100000, the time range is set to the last 100,000 milliseconds of the\n call.

" + "smithy.api#documentation": "

The time, in milliseconds, from the value you specify until the end of your media file in\n which Amazon Transcribe searches for your specified criteria.

" } } }, "traits": { - "smithy.api#documentation": "

A time range, set in seconds, between two points in the call.

" + "smithy.api#documentation": "

A time range, in milliseconds, between two points in your media file.

\n

You can use StartTime and EndTime to search a custom\n segment. For example, setting StartTime to 10000 and EndTime\n to 50000 only searches for your specified criteria in the audio contained between the 10,000 \n millisecond mark and the 50,000 millisecond mark of your media file. You must use \n StartTime and EndTime as a set; that is, if you include one, \n you must include both.

\n

You can use also First to search from the start of the audio until the time\n you specify, or Last to search from the time you specify until the end of the \n audio. For example, setting First to 50000 only searches for your specified \n criteria in the audio contained between the start of the media file to the 50,000 millisecond\n mark. You can use First and Last independently of each \n other.

\n

If you prefer to use percentage instead of milliseconds, see \n .

" } }, "com.amazonaws.transcribe#BadRequestException": { @@ -69,7 +69,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your request didn't pass one or more validation tests. For example, if the entity that \n you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's \n \"in progress\"). See the exception Message field for more information.

", + "smithy.api#documentation": "

Your request didn't pass one or more validation tests. This can occur when the entity you're \n trying to delete doesn't exist or if it's in a non-terminal state (such as \n IN PROGRESS). See the exception message field for more information.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -128,31 +128,31 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

The name of the call analytics job.

" + "smithy.api#documentation": "

The name of the Call Analytics job. Job names are case sensitive and must be unique \n within an Amazon Web Services account.

" } }, "CallAnalyticsJobStatus": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "

The status of the analytics job.

" + "smithy.api#documentation": "

Provides the status of the specified Call Analytics job.

\n

If the status is COMPLETED, the job is finished and you can find the results\n at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If the status is \n FAILED, FailureReason provides details on why your transcription\n job failed.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

If you know the language spoken between the customer and the agent, specify a \n language code for this field.

\n

If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine \n learning to automatically identify the language. To improve the accuracy of language \n identification, you can provide an array containing the possible language codes for the \n language spoken in your audio. Refer to Supported languages for\n additional information.

" + "smithy.api#documentation": "

The language code used to create your Call Analytics job. For a list of supported languages\n and their associated language codes, refer to the \n Supported\n languages table.

\n

If you don't know the language spoken in your media file, you can omit this field and let\n Amazon Transcribe automatically identify the language of your media. To improve the accuracy \n of language identification, you can include several language codes and Amazon Transcribe\n chooses the closest match for your transcription.

" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz, of the input audio.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in your input media file.

" } }, "MediaFormat": { "target": "com.amazonaws.transcribe#MediaFormat", "traits": { - "smithy.api#documentation": "

The format of the input audio file. Note: for call analytics jobs, only the following media \n formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.

" + "smithy.api#documentation": "

The format of the input media file.

" } }, "Media": { @@ -164,54 +164,54 @@ "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the analytics job started processing.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the analytics job was created.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the analytics job was completed.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the AnalyticsJobStatus is FAILED, this field contains \n information about why the job failed.

\n

The FailureReason field can contain one of the following values:

\n
    \n
  • \n

    \n Unsupported media format: The media format specified in the\n MediaFormat field of the request isn't valid. See the description of the\n MediaFormat field for a list of valid values.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media \n format: The media format of the audio file doesn't match the format specified \n in the MediaFormat field in the request. Check the media format of your\n media file and make sure the two values match.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file: The sample rate specified in the\n MediaSampleRateHertz of the request isn't valid. The sample rate must be\n between 8,000 and 48,000 Hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample\n rate: The sample rate in the audio file doesn't match the sample rate specified in \n the MediaSampleRateHertz field in the request. Check the sample rate of \n your media file and make sure that the two values match.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large: The size of your audio file is larger\n than what Amazon Transcribe Medical can process. For more information, see Guidelines and\n Quotas in the Amazon Transcribe Medical Guide.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large: Your \n audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional\n channels, see Amazon Transcribe Medical Endpoints and Quotas in the\n Amazon Web \n Services General Reference.

    \n
    • \n
" + "smithy.api#documentation": "

If CallAnalyticsJobStatus is FAILED, \n FailureReason contains information about why the Call Analytics job request\n failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media \n format.

    \n

    The media format specified in MediaFormat doesn't match the \n format of the input file. Check the media format of your media file and correct the \n specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 Hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample \n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't \n match the sample rate detected in your input media file. Check the sample rate of \n your media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can process. \n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process. \n For more information, refer to Guidelines and \n quotas.

    \n
    • \n
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) that you use to access the analytics job. ARNs \n have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t \n have the appropriate permissions to access the specified Amazon S3 location, your request \n fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM ARNs.

" } }, "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language that it identified in \n the source audio. This value appears only when you don't provide a single language code. \n Larger values indicate that Amazon Transcribe has higher confidence in the language that it\n identified.

" + "smithy.api#documentation": "

The confidence score associated with the language identified in your media file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher \n probability that the identified language correctly matches the language spoken in your\n media.

" } }, "Settings": { "target": "com.amazonaws.transcribe#CallAnalyticsJobSettings", "traits": { - "smithy.api#documentation": "

Provides information about the settings used to run a transcription job.

" + "smithy.api#documentation": "

Allows additional optional settings in your \n request, including content redaction; allows you to apply custom language models, vocabulary\n filters, and custom vocabularies to your Call Analytics job.

" } }, "ChannelDefinitions": { "target": "com.amazonaws.transcribe#ChannelDefinitions", "traits": { - "smithy.api#documentation": "

Shows numeric values to indicate the channel assigned to the agent's audio and the\n channel assigned to the customer's audio.

" + "smithy.api#documentation": "

Allows you to specify which speaker is on which channel in your Call Analytics job request.\n For example, if your agent is the first participant to speak, you would set \n ChannelId to 0 (to indicate the first channel) and \n ParticipantRole to AGENT (to indicate that it's the agent \n speaking).

" } } }, "traits": { - "smithy.api#documentation": "

Describes an asynchronous analytics job that was created with the\n StartAnalyticsJob operation.

" + "smithy.api#documentation": "

Provides detailed information about a Call Analytics job.

\n

To view the job's status, refer to CallAnalyticsJobStatus. If the status is\n COMPLETED, the job is finished. You can find your completed transcript at \n the URI specified in TranscriptFileUri. If the status is FAILED, \n FailureReason provides details on why your transcription job failed.

\n

If you enabled personally identifiable information (PII) redaction, the redacted transcript\n appears at the location specified in RedactedTranscriptFileUri.

\n

If you chose to redact the audio in your media file, you can find your redacted media file \n at the location specified in the RedactedMediaFileUri field of your \n response.

" } }, "com.amazonaws.transcribe#CallAnalyticsJobName": { @@ -230,25 +230,25 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of a vocabulary to use when processing the call analytics job.

" + "smithy.api#documentation": "

The name of the custom vocabulary you want to include in your Call Analytics \n transcription request. Vocabulary names are case sensitive.

" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter to use when running a call analytics job. The filter that\n you specify must have the same language code as the analytics job.

" + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to include in your Call Analytics \n transcription request. Vocabulary filter names are case sensitive.

\n

Note that if you include VocabularyFilterName in your request, you must \n also include VocabularyFilterMethod.

" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribe#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "

Set to mask to remove filtered text from the transcript and replace it with three \n asterisks (\"***\") as placeholder text. Set to remove to remove filtered text \n from the transcript without using placeholder text. Set to tag to mark the word \n in the transcription output that matches the vocabulary filter. When you set the filter method\n to tag, the words matching your vocabulary filter are not masked or \n removed.

" + "smithy.api#documentation": "

Specify how you want your vocabulary filter applied to your transcript.

\n

To replace words with ***, choose mask.

\n

To delete words, choose remove.

\n

To flag words without changing them, choose tag.

" } }, "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The structure used to describe a custom language model.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your \n Call Analytics job. Note that language model names are case sensitive.

\n

The language of the specified language model must match the language code you specify\n in your transcription request. If the languages don't match, the language model isn't applied. \n There are no errors or warnings associated with a language mismatch.

" } }, "ContentRedaction": { @@ -257,18 +257,18 @@ "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

When you run a call analytics job, you can specify the language spoken in the audio, or\n you can have Amazon Transcribe identify the language for you.

\n

To specify a language, specify an array with one language code. If you don't know the \n language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the \n language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can \n provide an array of the languages that can be present in the audio. Refer to \n Supported languages for\n additional information.

" + "smithy.api#documentation": "

You can specify two or more language codes that represent the languages you think may \n be present in your media; including more than five is not recommended. If you're unsure what\n languages are present, do not include this parameter.

\n

Including language options can improve the accuracy of language identification.

\n

For a list of languages supported with Call Analytics, refer to the Supported languages table.

" } }, "LanguageIdSettings": { "target": "com.amazonaws.transcribe#LanguageIdSettingsMap", "traits": { - "smithy.api#documentation": "

The language identification settings associated with your call analytics job. These settings \n include VocabularyName, VocabularyFilterName, and\n LanguageModelName.

" + "smithy.api#documentation": "

If using automatic language identification (IdentifyLanguage) in your request \n and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary\n filter, include LanguageIdSettings with the relevant sub-parameters \n (VocabularyName, LanguageModelName, and \n VocabularyFilterName).

\n

You can specify two or more language codes that represent the languages you think may \n be present in your media; including more than five is not recommended. Each language code you\n include can have an associated custom language model, custom vocabulary, and custom \n vocabulary filter. The languages you specify must match the languages of the specified custom\n language models, custom vocabularies, and custom vocabulary filters.

\n

To include language options using IdentifyLanguage \n without including a custom language model, a custom \n vocabulary, or a custom vocabulary filter, use LanguageOptions instead of\n LanguageIdSettings. Including language options can improve the accuracy of \n automatic language identification.

\n

If you want to include a custom language model with your request but \n do not want to use automatic language identification,\n use instead the parameter with the\n LanguageModelName sub-parameter.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with\n your request but do not want to use automatic \n language identification, use instead the \n parameter with the VocabularyName or \n VocabularyFilterName (or both) sub-parameter.

" } } }, "traits": { - "smithy.api#documentation": "

Provides optional settings for the CallAnalyticsJob operation.

" + "smithy.api#documentation": "

Provides additional optional settings for your \n request, including content redaction, automatic language identification; allows you to apply\n custom language models, vocabulary filters, and custom vocabularies.

" } }, "com.amazonaws.transcribe#CallAnalyticsJobStatus": { @@ -306,48 +306,48 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

The name of the call analytics job.

" + "smithy.api#documentation": "

The name of the Call Analytics job. Job names are case sensitive and must be unique \n within an Amazon Web Services account.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the call analytics job was created.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job began processing.

" + "smithy.api#documentation": "

The date and time your Call Analytics job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job was completed.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language of the transcript in the source audio file.

" + "smithy.api#documentation": "

The language code used to create your Call Analytics transcription.

" } }, "CallAnalyticsJobStatus": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "

The status of the call analytics job.

" + "smithy.api#documentation": "

Provides the status of your Call Analytics job.

\n

If the status is COMPLETED, the job is finished and you can find the results\n at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If the status is \n FAILED, FailureReason provides details on why your transcription\n job failed.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the CallAnalyticsJobStatus is FAILED, a description of \n the error.

" + "smithy.api#documentation": "

If CallAnalyticsJobStatus is FAILED, \n FailureReason contains information about why the Call Analytics job \n failed. See also: Common Errors.

" } } }, "traits": { - "smithy.api#documentation": "

Provides summary information about a call analytics job.

" + "smithy.api#documentation": "

Provides detailed information about a specific Call Analytics job.

" } }, "com.amazonaws.transcribe#CategoryName": { @@ -366,30 +366,30 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

The name of the call analytics category.

" + "smithy.api#documentation": "

The name of the Call Analytics category. Category names are case sensitive and must be \n unique within an Amazon Web Services account.

" } }, "Rules": { "target": "com.amazonaws.transcribe#RuleList", "traits": { - "smithy.api#documentation": "

The rules used to create a call analytics category.

" + "smithy.api#documentation": "

The rules used to define a Call Analytics category. Each category can have between 1 and 20 \n rules.

" } }, "CreateTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the call analytics category was created.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics category was created.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "LastUpdateTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the call analytics category was most recently \n updated.

" + "smithy.api#documentation": "

The date and time the specified Call Analytics category was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 \n on May 5, 2022.

" } } }, "traits": { - "smithy.api#documentation": "

An object that contains the rules and additional information about a call analytics \n category.

" + "smithy.api#documentation": "

Provides you with the properties of the Call Analytics category you specified in your\n request. This includes the list of rules that define the specified category.

" } }, "com.amazonaws.transcribe#CategoryPropertiesList": { @@ -404,18 +404,18 @@ "ChannelId": { "target": "com.amazonaws.transcribe#ChannelId", "traits": { - "smithy.api#documentation": "

A value that indicates the audio channel.

" + "smithy.api#documentation": "

Specify the audio channel you want to define.

" } }, "ParticipantRole": { "target": "com.amazonaws.transcribe#ParticipantRole", "traits": { - "smithy.api#documentation": "

Indicates whether the person speaking on the audio channel is the agent or \n customer.

" + "smithy.api#documentation": "

Specify the speaker you want to define. Omitting this parameter is equivalent to specifying\n both participants.

" } } }, "traits": { - "smithy.api#documentation": "

For a call analytics job, an object that indicates the audio channel that belongs to the\n agent and the audio channel that belongs to the customer.

" + "smithy.api#documentation": "

Allows you to specify which speaker is on which channel. For example, if your agent is the \n first participant to speak, you would set ChannelId to 0 (to\n indicate the first channel) and ParticipantRole to AGENT (to \n indicate that it's the agent speaking).

" } }, "com.amazonaws.transcribe#ChannelDefinitions": { @@ -447,7 +447,7 @@ } }, "traits": { - "smithy.api#documentation": "

There is already a resource with that name.

", + "smithy.api#documentation": "

A resource already exists with this name. Resource names must be unique within an \n Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -458,26 +458,26 @@ "RedactionType": { "target": "com.amazonaws.transcribe#RedactionType", "traits": { - "smithy.api#documentation": "

Request parameter that defines the entities to be redacted. The only accepted value is\n PII.

", + "smithy.api#documentation": "

Specify the category of information you want to redact; PII (personally \n identifiable information) is the only valid value. You can use PiiEntityTypes to \n choose which types of PII you want to redact.

", "smithy.api#required": {} } }, "RedactionOutput": { "target": "com.amazonaws.transcribe#RedactionOutput", "traits": { - "smithy.api#documentation": "

The output transcript file stored in either the default S3 bucket or in a bucket you\n specify.

\n

When you choose redacted Amazon Transcribe outputs only the redacted \n transcript.

\n

When you choose redacted_and_unredacted Amazon Transcribe outputs both the \n redacted and unredacted transcripts.

", + "smithy.api#documentation": "

Specify if you want only a redacted transcript, or if you want a redacted and an unredacted\n transcript.

\n

When you choose redacted Amazon Transcribe creates only a redacted \n transcript.

\n

When you choose redacted_and_unredacted Amazon Transcribe creates \n a redacted and an unredacted transcript (as two separate files).

", "smithy.api#required": {} } }, "PiiEntityTypes": { "target": "com.amazonaws.transcribe#PiiEntityTypes", "traits": { - "smithy.api#documentation": "

The types of personally identifiable information (PII) you want to redact in your\n transcript.

" + "smithy.api#documentation": "

Specify which types of personally identifiable information (PII) you want to redact in your\n transcript. You can include as many types as you'd like, or you can select \n ALL.

" } } }, "traits": { - "smithy.api#documentation": "

Settings for content redaction within a transcription job.

" + "smithy.api#documentation": "

Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If \n you use ContentRedaction, you must also include the sub-parameters:\n PiiEntityTypes, RedactionOutput, and \n RedactionType.

" } }, "com.amazonaws.transcribe#CreateCallAnalyticsCategory": { @@ -503,7 +503,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a call analytics category. Amazon Transcribe applies the conditions specified by your\n call analytics categories to your call analytics jobs. For each analytics category, you \n must create between 1 and 20 rules. For example, you can create a 'greeting' \n category with a rule that flags calls in which your agent does not use a specified \n phrase (for example: \"Please note this call may be recorded.\") in the first 15 seconds\n of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call\n analytics categories to that job.

", + "smithy.api#documentation": "

Creates a new Call Analytics category.

\n

All categories are automatically applied to your Call Analytics jobs. Note that in order to apply \n your categories to your jobs, you must create them before submitting your job request, as \n categories cannot be applied retroactively.

\n

Call Analytics categories are composed of rules. For each category, you must create\n between 1 and 20 rules. Rules can include these parameters: , \n , , and \n .

\n

To update an existing category, see .

\n

To learn more about:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/callanalyticscategories/{CategoryName}", @@ -517,7 +517,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

A unique name, chosen by you, for your call analytics category. For example, \n sentiment-positive-last30seconds.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed\n naming system that will make sense to you in the future. For example, it's better to use \n sentiment-positive-last30seconds for a category over a generic name like \n test-category.

\n

Category names are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -525,7 +525,7 @@ "Rules": { "target": "com.amazonaws.transcribe#RuleList", "traits": { - "smithy.api#documentation": "

Rules make up a call analytics category. When creating a call analytics category,\n you must create between 1 and 20 rules for your category. For each rule, you \n specify a filter you want applied to the attributes of a call. For example, you can choose\n a sentiment filter that detects if a customer's sentiment was positive during the last\n 30 seconds of the call.

", + "smithy.api#documentation": "

Rules define a Call Analytics category. When creating a new Call Analytics category, you must \n create between 1 and 20 rules for that category. For each rule, you specify a filter you want \n applied to the attributes of a call. For example, you can choose a sentiment filter that detects if a\n customer's sentiment was positive during the last 30 seconds of the call.

", "smithy.api#required": {} } } @@ -537,7 +537,7 @@ "CategoryProperties": { "target": "com.amazonaws.transcribe#CategoryProperties", "traits": { - "smithy.api#documentation": "

If your audio matches one of your categories, this field contains data on that \n category and its associated rules. This parameter shows which category is flagged\n (CategoryName) along with metadata for the rules that match your \n audio. Metadata includes the rule filter (such as InterruptionFilter,\n NonTalkTimeFilter, SentimentFilter, and \n TranscriptFilter) and where in your audio (StartTime\n and EndTime) the rule has a match.

" + "smithy.api#documentation": "

Provides you with the properties of your new category, including its associated rules.

" } } } @@ -565,7 +565,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom language model. When creating a new language model, \n you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or\n Narrowband (audio sample rates under 16,000 Hz) base model. You then include the \n S3 URI location of your training and tuning files, the language for the model, a \n unique name, and any tags you want associated with your model.

", + "smithy.api#documentation": "

Creates a new custom language model.

\n

When creating a new language model, you must specify:

\n
    \n
  • \n

    If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample\n rates under 16,000 Hz) base model

    \n
    • \n
  • \n

    The location of your training and tuning files (this must be an Amazon S3 URI)

    \n
    • \n
  • \n

    The language of your model

    \n
    • \n
  • \n

    A unique name for your model

    \n
    • \n
\n

For more information, see Custom language models.

", "smithy.api#http": { "method": "PUT", "uri": "/languagemodels/{ModelName}", @@ -579,21 +579,21 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

The language of your custom language model; note that the language code you\n select must match the language of your training and tuning data.

", + "smithy.api#documentation": "

The language code that represents the language of your model. Each language model must\n contain terms in only one language, and the language you select for your model must match the \n language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the \n Supported\n languages table. Note that U.S. English (en-US) is the only language \n supported with Amazon Transcribe Medical.

\n

A custom language model can only be used to transcribe files in the same language as the \n model. For example, if you create a language model using US English (en-US), you\n can only apply this model to files that contain English audio.

", "smithy.api#required": {} } }, "BaseModelName": { "target": "com.amazonaws.transcribe#BaseModelName", "traits": { - "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model, used to create your \n custom language model. Amazon Transcribe offers two options for base models: Wideband and\n Narrowband.

\n

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, \n choose WideBand. To transcribe audio with a sample rate less than\n 16,000 Hz, choose NarrowBand.

", + "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model, used to create your custom\n language model. Amazon Transcribe offers two options for base models: Wideband and \n Narrowband.

\n

If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose \n WideBand. To transcribe audio with a sample rate less than 16,000 Hz, choose\n NarrowBand.

", "smithy.api#required": {} } }, "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of your new custom language model.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a language model with the same name as a\n previous language model, you get a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your custom language model.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a new language model with the same name \n as an existing language model, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -601,14 +601,14 @@ "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

Contains your data access role ARN (Amazon Resource Name) and the Amazon S3 \n locations of your training (S3Uri) and tuning \n (TuningDataS3Uri) data.

", + "smithy.api#documentation": "

Contains the Amazon S3 location of the training data you want to use to create a new \n custom language model, and permissions to access this location.

\n

When using InputDataConfig, you must include these sub-parameters:\n S3Uri, which is the Amazon S3 location of your training data, and \n DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role that \n has permission to access your specified Amazon S3 location. You can optionally include \n TuningDataS3Uri, which is the Amazon S3 location of your tuning data. If \n you specify different Amazon S3 locations for training and tuning data, the ARN you use \n must have permissions to access both locations.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Optionally add tags, each in the form of a key:value pair, to your new language\n model. See also: .

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom language\n model at the time you create this new model.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" } } } @@ -625,25 +625,25 @@ "BaseModelName": { "target": "com.amazonaws.transcribe#BaseModelName", "traits": { - "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model, you used when creating your\n custom language model.

\n

If your audio has a sample rate of 16,000 Hz or greater, this value should be\n WideBand. If your audio has a sample rate of less than\n 16,000 Hz, this value should be NarrowBand.

" + "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model, you specified when creating \n your custom language model.

" } }, "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The unique name you chose for your custom language model.

" + "smithy.api#documentation": "

The name of your custom language model.

" } }, "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 \n locations your provided for your training (S3Uri) and tuning \n (TuningDataS3Uri) data.

" + "smithy.api#documentation": "

Lists your data access role ARN (Amazon Resource Name) and the Amazon S3 \n locations you provided for your training (S3Uri) and tuning \n (TuningDataS3Uri) data.

" } }, "ModelStatus": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

The status of your custom language model. When the status shows as \n COMPLETED, your model is ready to use.

" + "smithy.api#documentation": "

The status of your custom language model. When the status displays as \n COMPLETED, your model is ready to use.

" } } } @@ -671,7 +671,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom medical vocabulary.

\n

When creating a new medical vocabulary, you must upload a text file that contains\n your new entries, phrases, and terms into an S3 bucket. Note that this differs from \n , where you can include a list of terms within\n your request using the Phrases flag, as\n CreateMedicalVocabulary does not support the Phrases\n flag.

\n

For more information on creating a custom vocabulary text file, see \n Creating a custom \n vocabulary.

", + "smithy.api#documentation": "

Creates a new custom medical vocabulary.

\n

Prior to creating a new medical vocabulary, you must first upload a text file that contains\n your new entries, phrases, and terms into an Amazon S3 bucket. Note that this differs from \n , where you can include a list of terms within\n your request using the Phrases flag; CreateMedicalVocabulary \n does not support the Phrases flag.

\n

Each language has a character set that contains all allowed characters for that specific \n language. If you use unsupported characters, your vocabulary request fails. Refer to \n Character Sets for \n Custom Vocabularies to get the character set for your language.

\n

For more information, see Creating a custom\n vocabulary.

", "smithy.api#http": { "method": "PUT", "uri": "/medicalvocabularies/{VocabularyName}", @@ -685,7 +685,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of your new vocabulary.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a vocabulary with the same name as a\n previous vocabulary, you get a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your new custom medical vocabulary.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a new medical vocabulary with the same name\n as an existing medical vocabulary, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -693,21 +693,21 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language of the entries in your custom\n vocabulary. Note that U.S. English (en-US) is the only language \n supported with Amazon Transcribe Medical.

", + "smithy.api#documentation": "

The language code that represents the language of the entries in your custom\n vocabulary. US English (en-US) is the only language supported with \n Amazon Transcribe Medical.

", "smithy.api#required": {} } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location (URI) of the text file that contains your custom vocabulary. \n The URI must be in the same Amazon Web Services Region as the resource that you're \n calling.

\n

Here's an example URI path:

\n

\n https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt\n

", + "smithy.api#documentation": "

The Amazon S3 location (URI) of the text file that contains your custom medical \n vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're\n calling.

\n

Here's an example URI path: \n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new medical \n vocabulary at the time you create the new vocabulary.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new medical \n vocabulary at the time you create this new vocabulary.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" } } } @@ -718,31 +718,31 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name you chose for your vocabulary.

" + "smithy.api#documentation": "

The name you chose for your custom medical vocabulary.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code you selected for your medical vocabulary. Note that U.S. English\n (en-US) is the only language supported with Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The language code you selected for your medical vocabulary. US English \n (en-US) is the only language supported with Amazon Transcribe Medical.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of your custom medical vocabulary. If the state is \n READY, you can use the vocabulary in a \n StartMedicalTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of your custom medical vocabulary. If the state is \n READY, you can use the vocabulary in a \n StartMedicalTranscriptionJob request.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time you created your custom medical vocabulary.

" + "smithy.api#documentation": "

The date and time you created your custom medical vocabulary.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState field is FAILED,\n FailureReason contains information about why the job failed.

" + "smithy.api#documentation": "

If VocabularyState is FAILED, \n FailureReason contains information about why the medical transcription job\n request failed. See also: Common Errors.

" } } } @@ -770,7 +770,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new custom vocabulary.

\n

When creating a new medical vocabulary, you can either upload a text file that\n contains your new entries, phrases, and terms into an S3 bucket or include a list of \n terms directly in your request using the Phrases flag.

\n

For more information on creating a custom vocabulary, see \n Creating a custom \n vocabulary.

", + "smithy.api#documentation": "

Creates a new custom vocabulary.

\n

When creating a new vocabulary, you can either upload a text file that contains your new \n entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request, or \n you can include a list of terms directly in your request using the Phrases flag.

\n

Each language has a character set that contains all allowed characters for that specific \n language. If you use unsupported characters, your vocabulary request fails. Refer to \n Character Sets for \n Custom Vocabularies to get the character set for your language.

\n

For more information, see Creating a custom \n vocabulary.

", "smithy.api#http": { "method": "PUT", "uri": "/vocabularies/{VocabularyName}", @@ -801,7 +801,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new vocabulary filter that you can use to filter words from your transcription\n output. For example, you can use this operation to remove profanity from your\n transcript.

", + "smithy.api#documentation": "

Creates a new custom vocabulary filter.

\n

You can use vocabulary filters to mask, delete, or flag specific words from your transcript. \n Vocabulary filters are commonly used to mask profanity in transcripts.

\n

Each language has a character set that contains all allowed characters for that specific \n language. If you use unsupported characters, your vocabulary filter request fails. Refer to \n Character Sets for \n Custom Vocabularies to get the character set for your language.

\n

For more information, see Using vocabulary filtering with unwanted\n words.

", "smithy.api#http": { "method": "POST", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -815,7 +815,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of your new vocabulary filter.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a vocabulary filter with the same name \n as a previous vocabulary filter, you get a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your new custom vocabulary filter.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a new vocabulary filter with the same name\n as an existing vocabulary filter, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -823,26 +823,26 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the words in the vocabulary filter. All words in the filter must be\n in the same language. The vocabulary filter can only be used with transcription jobs in the \n specified language.

", + "smithy.api#documentation": "

The language code that represents the language of the entries in your vocabulary \n filter. Each vocabulary filter must contain terms in only one language.

\n

A vocabulary filter can only be used to transcribe files in the same language as the \n filter. For example, if you create a vocabulary filter using US English (en-US), you\n can only apply this filter to files that contain English audio.

\n

For a list of supported languages and their associated language codes, refer to the \n Supported\n languages table.

", "smithy.api#required": {} } }, "Words": { "target": "com.amazonaws.transcribe#Words", "traits": { - "smithy.api#documentation": "

The words you want in your vocabulary filter. Only use characters specified in the\n Character\n sets for the language you're transcribing.

\n

Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.

" + "smithy.api#documentation": "

Use this parameter if you want to create your vocabulary filter by including all desired terms, \n as comma-separated values, within your request. The other option for creating your vocabulary \n filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then\n specify the location of your file using the VocabularyFilterFileUri \n parameter.

\n

Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that specific \n language. If you use unsupported characters, your vocabulary filter request fails. Refer to \n Character Sets for \n Custom Vocabularies to get the character set for your language.

" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only \n use characters from the character set defined for custom vocabularies. For a list of \n character sets, see Character Sets for Custom\n Vocabularies.

\n

Your vocabulary filter file must be less than 50 KB in size.

\n

Note that if you include VocabularyFilterFileUri in your request, you \n cannot use Words; you must choose one or the other.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary filter \n terms. The URI must be located in the same Amazon Web Services Region as the resource you're \n calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n

\n

Note that if you include VocabularyFilterFileUri in your request, you \n cannot use Words; you must choose one or the other.

" } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new vocabulary\n filter at the time you create this new vocabulary filter.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom \n vocabulary filter at the time you create this new filter.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" } } } @@ -853,19 +853,19 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter.

" + "smithy.api#documentation": "

The name you chose for your custom vocabulary filter.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code associated with your vocabulary filter.

" + "smithy.api#documentation": "

The language code you selected for your vocabulary filter.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time the vocabulary filter was modified.

" + "smithy.api#documentation": "

The date and time you created your vocabulary filter.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } } } @@ -876,7 +876,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of your new vocabulary.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a vocabulary with the same name as a\n previous vocabulary, you get a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your new custom vocabulary.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a new vocabulary with the same name as an\n existing vocabulary, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -884,26 +884,26 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code that represents the language of the entries in your custom\n vocabulary. Each vocabulary must contain terms in only one language. For a list of \n languages and their corresponding language codes, see Supported \n languages.

", + "smithy.api#documentation": "

The language code that represents the language of the entries in your custom\n vocabulary. Each vocabulary must contain terms in only one language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the \n vocabulary. For example, if you create a vocabulary using US English (en-US), \n you can only apply this vocabulary to files that contain English audio.

\n

For a list of supported languages and their associated language codes, refer to the \n Supported\n languages table.

", "smithy.api#required": {} } }, "Phrases": { "target": "com.amazonaws.transcribe#Phrases", "traits": { - "smithy.api#documentation": "

Use this flag to include a list of terms within your request.

\n

Note that if you include Phrases in your request, you cannot\n use VocabularyFileUri; you must choose one or the other.

" + "smithy.api#documentation": "

Use this parameter if you want to create your vocabulary by including all desired terms, as\n comma-separated values, within your request. The other option for creating your vocabulary is to\n save your entries in a text file and upload them to an Amazon S3 bucket, then specify \n the location of your file using the VocabularyFileUri parameter.

\n

Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that specific \n language. If you use unsupported characters, your vocabulary filter request fails. Refer to \n Character Sets for \n Custom Vocabularies to get the character set for your language.

" } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the text file that contains your custom vocabulary. The\n URI must be located in the same region as the API endpoint you're calling.

\n

Here's an example URI path:

\n

\n https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt\n

\n

Note that if you include VocabularyFileUri in your request, you \n cannot use the Phrases flag; you must choose one or the other.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary. The\n URI must be located in the same Amazon Web Services Region as the resource you're \n calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

\n

Note that if you include VocabularyFileUri in your request, you \n cannot use the Phrases flag; you must choose one or the other.

" } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new \n custom vocabulary at the time you create this new vocabulary.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new custom \n vocabulary at the time you create this new vocabulary.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" } } } @@ -914,31 +914,31 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name you chose for your vocabulary.

" + "smithy.api#documentation": "

The name you chose for your custom vocabulary.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code you selected for your vocabulary.

" + "smithy.api#documentation": "

The language code you selected for your custom vocabulary.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of your vocabulary. If the state is READY, you can\n use the vocabulary in a StartTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of your custom vocabulary. If the state is READY, you\n can use the vocabulary in a StartTranscriptionJob request.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time you created your custom vocabulary.

" + "smithy.api#documentation": "

The date and time you created your custom vocabulary.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState field is FAILED,\n FailureReason contains information about why the job failed.

" + "smithy.api#documentation": "

If VocabularyState is FAILED,\n FailureReason contains information about why the vocabulary request\n failed. See also: Common Errors.

" } } } @@ -979,7 +979,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a call analytics category. To use this operation, specify the name of the \n category you want to delete using CategoryName.

", + "smithy.api#documentation": "

Deletes a Call Analytics category. To use this operation, specify the name of the category \n you want to delete using CategoryName. Category names are case\n sensitive.

", "smithy.api#http": { "method": "DELETE", "uri": "/callanalyticscategories/{CategoryName}", @@ -993,7 +993,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

The name of the call analytics category you want to delete. Category names are\n case-sensitive.

", + "smithy.api#documentation": "

The name of the Call Analytics category you want to delete. Category names are\n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1024,7 +1024,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a call analytics job. To use this operation, specify the name of the \n job you want to delete using CallAnalyticsJobName.

", + "smithy.api#documentation": "

Deletes a Call Analytics job. To use this operation, specify the name of the job you want to \n delete using CallAnalyticsJobName. Job names are case sensitive.

", "smithy.api#http": { "method": "DELETE", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -1038,7 +1038,7 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

The name of the call analytics job you want to delete. Job names are\n case-sensitive.

", + "smithy.api#documentation": "

The name of the Call Analytics job you want to delete. Job names are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1054,6 +1054,9 @@ "input": { "target": "com.amazonaws.transcribe#DeleteLanguageModelRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transcribe#BadRequestException" @@ -1066,7 +1069,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom language model. To use this operation, specify the name of the \n language model you want to delete using ModelName.

", + "smithy.api#documentation": "

Deletes a custom language model. To use this operation, specify the name of the language \n model you want to delete using ModelName. Language model names are case\n sensitive.

", "smithy.api#http": { "method": "DELETE", "uri": "/languagemodels/{ModelName}", @@ -1080,7 +1083,7 @@ "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the model you want to delete. Model names are case-sensitive.

", + "smithy.api#documentation": "

The name of the custom language model you want to delete. Model names are \n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1092,6 +1095,9 @@ "input": { "target": "com.amazonaws.transcribe#DeleteMedicalTranscriptionJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transcribe#BadRequestException" @@ -1104,7 +1110,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a medical transcription job, along with any related information. To use this \n operation, specify the name of the job you want to delete using\n MedicalTranscriptionJobName.

", + "smithy.api#documentation": "

Deletes a medical transcription job. To use this operation, specify the name of the job you \n want to delete using MedicalTranscriptionJobName. Job names are case\n sensitive.

", "smithy.api#http": { "method": "DELETE", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -1118,7 +1124,7 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the medical transcription job you want to delete. Job names are\n case-sensitive.

", + "smithy.api#documentation": "

The name of the medical transcription job you want to delete. Job names are case \n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1130,6 +1136,9 @@ "input": { "target": "com.amazonaws.transcribe#DeleteMedicalVocabularyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transcribe#BadRequestException" @@ -1145,7 +1154,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom medical vocabulary. To use this operation, specify the name of the\n vocabulary you want to delete using VocabularyName.

", + "smithy.api#documentation": "

Deletes a custom medical vocabulary. To use this operation, specify the name of the\n vocabulary you want to delete using VocabularyName. Vocabulary names are\n case sensitive.

", "smithy.api#http": { "method": "DELETE", "uri": "/medicalvocabularies/{VocabularyName}", @@ -1159,7 +1168,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary that you want to delete. Vocabulary names are\n case-sensitive.

", + "smithy.api#documentation": "

The name of the custom medical vocabulary you want to delete. Vocabulary names are\n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1171,6 +1180,9 @@ "input": { "target": "com.amazonaws.transcribe#DeleteTranscriptionJobRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transcribe#BadRequestException" @@ -1183,7 +1195,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a transcription job, along with any related information. To use this operation,\n specify the name of the job you want to delete using\n TranscriptionJobName.

", + "smithy.api#documentation": "

Deletes a transcription job. To use this operation, specify the name of the job you want to\n delete using TranscriptionJobName. Job names are case sensitive.

", "smithy.api#http": { "method": "DELETE", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -1197,7 +1209,7 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the transcription job you want to delete. Job names are\n case-sensitive.

", + "smithy.api#documentation": "

The name of the transcription job you want to delete. Job names are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1209,6 +1221,9 @@ "input": { "target": "com.amazonaws.transcribe#DeleteVocabularyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transcribe#BadRequestException" @@ -1224,7 +1239,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary \n you want to delete using VocabularyName.

", + "smithy.api#documentation": "

Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you\n want to delete using VocabularyName. Vocabulary names are case\n sensitive.

", "smithy.api#http": { "method": "DELETE", "uri": "/vocabularies/{VocabularyName}", @@ -1237,6 +1252,9 @@ "input": { "target": "com.amazonaws.transcribe#DeleteVocabularyFilterRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.transcribe#BadRequestException" @@ -1252,7 +1270,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary \n filter you want to delete using VocabularyFilterName.

", + "smithy.api#documentation": "

Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter\n you want to delete using VocabularyFilterName. Vocabulary filter names are \n case sensitive.

", "smithy.api#http": { "method": "DELETE", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -1266,7 +1284,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter you want to delete. Vocabulary filter names are\n case-sensitive.

", + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to delete. Vocabulary filter names \n are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1279,7 +1297,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary you want to delete. Vocabulary names are\n case-sensitive.

", + "smithy.api#documentation": "

The name of the custom vocabulary you want to delete. Vocabulary names are\n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1309,7 +1327,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about a specific custom language model in your \n Amazon Web Services account.

\n

This operation also shows if the base language model you used to create your custom\n language model has been updated. If Amazon Transcribe has updated the base model, you can create a\n new custom language model using the updated base model.

\n

If you tried to create a new custom language model and the request wasn't successful,\n you can use this operation to help identify the reason.

", + "smithy.api#documentation": "

Provides information about the specified custom language model.

\n

This operation also shows if the base language model you used to create your custom\n language model has been updated. If Amazon Transcribe has updated the base model, you\n can create a new custom language model using the updated base model.

\n

If you tried to create a new custom language model and the request wasn't successful,\n you can use DescribeLanguageModel to help identify the reason for this \n failure.

\n

To get a list of your custom language models, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/languagemodels/{ModelName}", @@ -1323,7 +1341,7 @@ "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model you want described. Model names are\n case-sensitive.

", + "smithy.api#documentation": "

The name of the custom language model you want information about. Model names are\n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1336,11 +1354,17 @@ "LanguageModel": { "target": "com.amazonaws.transcribe#LanguageModel", "traits": { - "smithy.api#documentation": "

The name of the custom language model you requested more information about.

" + "smithy.api#documentation": "

Provides information about the specified custom language model.

\n

This parameter also shows if the base language model you used to create your custom\n language model has been updated. If Amazon Transcribe has updated the base model, you can \n create a new custom language model using the updated base model.

\n

If you tried to create a new custom language model and the request wasn't successful,\n you can use this DescribeLanguageModel to help identify the reason for this \n failure.

" } } } }, + "com.amazonaws.transcribe#DurationInSeconds": { + "type": "float", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.transcribe#FailureReason": { "type": "string" }, @@ -1367,7 +1391,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a call analytics category.

", + "smithy.api#documentation": "

Provides information about the specified Call Analytics category.

\n

To get a list of your Call Analytics categories, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticscategories/{CategoryName}", @@ -1381,7 +1405,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

The name of the category you want information about. Category names are case\n sensitive.

", + "smithy.api#documentation": "

The name of the Call Analytics category you want information about. Category names are \n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1394,7 +1418,7 @@ "CategoryProperties": { "target": "com.amazonaws.transcribe#CategoryProperties", "traits": { - "smithy.api#documentation": "

Provides you with the rules associated with the category you specified in your\n GetCallAnalyticsCategory request.

" + "smithy.api#documentation": "

Provides you with the properties of the Call Analytics category you specified in your\n GetCallAnalyticsCategory request.

" } } } @@ -1422,7 +1446,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a call analytics job.

\n

To view the job's status, refer to the CallAnalyticsJobStatus field. If the \n status is COMPLETED, the job is finished. You can then find your transcript at \n the URI specified in the TranscriptFileUri field. If you enabled personally \n identifiable information (PII) redaction, the redacted transcript appears in the\n RedactedTranscriptFileUri field.

", + "smithy.api#documentation": "

Provides information about the specified Call Analytics job.

\n

To view the job's status, refer to CallAnalyticsJobStatus. If the status is\n COMPLETED, the job is finished. You can find your completed transcript at \n the URI specified in TranscriptFileUri. If the status is FAILED, \n FailureReason provides details on why your transcription job failed.

\n

If you enabled personally identifiable information (PII) redaction, the redacted transcript\n appears at the location specified in RedactedTranscriptFileUri.

\n

If you chose to redact the audio in your media file, you can find your redacted media file\n at the location specified in RedactedMediaFileUri.

\n

To get a list of your Call Analytics jobs, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -1436,7 +1460,7 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

The name of the analytics job you want information about. This value is case\n sensitive.

", + "smithy.api#documentation": "

The name of the Call Analytics job you want information about. Job names are case \n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1449,7 +1473,7 @@ "CallAnalyticsJob": { "target": "com.amazonaws.transcribe#CallAnalyticsJob", "traits": { - "smithy.api#documentation": "

An object that contains detailed information about your call analytics job. Returned fields\n include: CallAnalyticsJobName, CallAnalyticsJobStatus,\n ChannelDefinitions, CompletionTime,\n CreationTime, DataAccessRoleArn,\n FailureReason, IdentifiedLanguageScore, \n LanguageCode, Media, MediaFormat,\n MediaSampleRateHertz, Settings, StartTime,\n and Transcript.

" + "smithy.api#documentation": "

Provides detailed information about the specified Call Analytics job, including job status\n and, if applicable, failure reason.

" } } } @@ -1477,7 +1501,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a medical transcription job.

\n

To view the job's status, refer to the TranscriptionJobStatus field. If the \n status is COMPLETED, the job is finished. You can then find your transcript at \n the URI specified in the TranscriptFileUri field.

", + "smithy.api#documentation": "

Provides information about the specified medical transcription job.

\n

To view the status of the specified medical transcription job, check the \n TranscriptionJobStatus field. If the status is COMPLETED, the \n job is finished and you can find the results at the location specified in \n TranscriptFileUri. If the status is FAILED, \n FailureReason provides details on why your transcription job failed.

\n

To get a list of your medical transcription jobs, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -1491,7 +1515,7 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the medical transcription job you want information about. This value is case\n sensitive.

", + "smithy.api#documentation": "

The name of the medical transcription job you want information about. Job names are case\n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1504,7 +1528,7 @@ "MedicalTranscriptionJob": { "target": "com.amazonaws.transcribe#MedicalTranscriptionJob", "traits": { - "smithy.api#documentation": "

An object that contains detailed information about your medical transcription job.\n Returned fields include: CompletionTime,\n ContentIdentificationType, CreationTime,\n FailureReason, LanguageCode, Media,\n MediaFormat, MediaSampleRateHertz, \n MedicalTranscriptionJobName, Settings,\n Specialty, StartTime, Tags,\n Transcript, TranscriptionJobStatus, and\n Type.

" + "smithy.api#documentation": "

Provides detailed information about the specified medical transcription job, including job\n status and, if applicable, failure reason.

" } } } @@ -1532,7 +1556,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves information about a medical vocabulary.

", + "smithy.api#documentation": "

Provides information about the specified custom medical vocabulary.

\n

To view the status of the specified medical vocabulary, check the \n VocabularyState field. If the status is READY, your vocabulary\n is available to use. If the status is FAILED, FailureReason provides \n details on why your vocabulary failed.

\n

To get a list of your custom medical vocabularies, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/medicalvocabularies/{VocabularyName}", @@ -1546,7 +1570,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the medical vocabulary you want information about. This value is case \n sensitive.

", + "smithy.api#documentation": "

The name of the custom medical vocabulary you want information about. Vocabulary names\n are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1559,37 +1583,37 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary returned by Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The name of the custom medical vocabulary you requested information about.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The valid language code for your vocabulary entries.

" + "smithy.api#documentation": "

The language code you selected for your medical vocabulary. US English \n (en-US) is the only language supported with Amazon Transcribe Medical.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the vocabulary. If the VocabularyState is READY \n then you can use it in the StartMedicalTranscriptionJob operation.

" + "smithy.api#documentation": "

The processing state of your custom medical vocabulary. If the state is \n READY, you can use the vocabulary in a \n StartMedicalTranscriptionJob request.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary was last modified with a text file different from the one that was \n previously used.

" + "smithy.api#documentation": "

The date and time the specified custom medical vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If your request returns a VocabularyState that is FAILED,\n the FailureReason field contains information about why the request \n failed.

\n

For more information, refer to the Common Errors\n section.

" + "smithy.api#documentation": "

If VocabularyState is FAILED, \n FailureReason contains information about why the medical vocabulary \n request failed. See also: Common Errors.

" } }, "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location where the vocabulary is stored; use this URI to view or download the\n vocabulary.

" + "smithy.api#documentation": "

The S3 location where the specified medical vocabulary is stored; use this URI to view or \n download the vocabulary.

" } } } @@ -1617,7 +1641,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a transcription job. To see the status of the job, check the \n TranscriptionJobStatus field. If the status is COMPLETED, \n the job is finished and you can find the results at the location specified in the\n TranscriptFileUri field. If you enable content redaction, the redacted\n transcript appears in RedactedTranscriptFileUri.

", + "smithy.api#documentation": "

Provides information about the specified transcription job.

\n

To view the status of the specified transcription job, check the \n TranscriptionJobStatus field. If the status is COMPLETED, the \n job is finished and you can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED, \n FailureReason provides details on why your transcription job failed.

\n

If you enabled content redaction, the redacted transcript\n can be found at the location specified in RedactedTranscriptFileUri.

\n

To get a list of your transcription jobs, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -1631,7 +1655,7 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the job.

", + "smithy.api#documentation": "

The name of the transcription job you want information about. Job names are case\n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1644,7 +1668,7 @@ "TranscriptionJob": { "target": "com.amazonaws.transcribe#TranscriptionJob", "traits": { - "smithy.api#documentation": "

An object that contains the results of the transcription job.

" + "smithy.api#documentation": "

Provides detailed information about the specified transcription job, including job status\n and, if applicable, failure reason.

" } } } @@ -1672,7 +1696,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a vocabulary.

", + "smithy.api#documentation": "

Provides information about the specified custom vocabulary.

\n

To view the status of the specified vocabulary, check the VocabularyState \n field. If the status is READY, your vocabulary is available to use. If the status\n is FAILED, FailureReason provides details on why your \n vocabulary failed.

\n

To get a list of your custom vocabularies, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularies/{VocabularyName}", @@ -1703,7 +1727,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a vocabulary filter.

", + "smithy.api#documentation": "

Provides information about the specified custom vocabulary filter.

\n

To view the status of the specified vocabulary filter, check the VocabularyState \n field. If the status is READY, your vocabulary is available to use. If the status is \n FAILED, FailureReason provides details on why your vocabulary\n filter failed.

\n

To get a list of your custom vocabulary filters, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -1717,7 +1741,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter for which to return information.

", + "smithy.api#documentation": "

The name of the custom vocabulary filter you want information about. Vocabulary filter \n names are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1730,25 +1754,25 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter.

" + "smithy.api#documentation": "

The name of the custom vocabulary filter you requested information about.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the words in the vocabulary filter.

" + "smithy.api#documentation": "

The language code you selected for your vocabulary filter.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the contents of the vocabulary filter were updated.

" + "smithy.api#documentation": "

The date and time the specified vocabulary filter was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.

" + "smithy.api#documentation": "

The Amazon S3 location where the vocabulary filter is stored; use this URI to view or \n download the vocabulary filter.

" } } } @@ -1759,7 +1783,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to return information about. The name is case\n sensitive.

", + "smithy.api#documentation": "

The name of the custom vocabulary you want information about. Vocabulary names are\n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1772,37 +1796,37 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to return.

" + "smithy.api#documentation": "

The name of the custom vocabulary you requested information about.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries.

" + "smithy.api#documentation": "

The language code you selected for your custom vocabulary.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the vocabulary.

" + "smithy.api#documentation": "

The processing state of your custom vocabulary. If the state is READY, you\n can use the vocabulary in a StartTranscriptionJob request.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary was last modified.

" + "smithy.api#documentation": "

The date and time the specified vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

" + "smithy.api#documentation": "

If VocabularyState is FAILED, \n FailureReason contains information about why the vocabulary request failed.\n See also: Common Errors.

" } }, "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location where the vocabulary is stored. Use this URI to get the contents of\n the vocabulary. The URI is available for a limited time.

" + "smithy.api#documentation": "

The S3 location where the vocabulary is stored; use this URI to view or download the \n vocabulary.

" } } } @@ -1819,26 +1843,26 @@ "S3Uri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 prefix you specify to access the plain text files that you use to train your \n custom language model.

", + "smithy.api#documentation": "

The Amazon S3 location (URI) of the text files you want to use to train your custom\n language model.

\n

Here's an example URI path: \n s3://DOC-EXAMPLE-BUCKET/my-model-training-data/\n

", "smithy.api#required": {} } }, "TuningDataS3Uri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 prefix you specify to access the plain text files that you use to tune your \n custom language model.

" + "smithy.api#documentation": "

The Amazon S3 location (URI) of the text files you want to use to tune your custom\n language model.

\n

Here's an example URI path: \n s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/\n

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given\n Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data. ARNs have the\n format\n arn:partition:service:region:account-id:resource-type/resource-id.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t \n have the appropriate permissions to access the specified Amazon S3 location, your request\n fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM ARNs.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The object that contains the Amazon S3 object location and access role required to train and \n tune your custom language model.

" + "smithy.api#documentation": "

Contains the Amazon S3 location of the training data you want to use to create a new \n custom language model, and permissions to access this location.

\n

When using InputDataConfig, you must include these sub-parameters:\n S3Uri and DataAccessRoleArn. You can optionally include\n TuningDataS3Uri.

" } }, "com.amazonaws.transcribe#InternalFailureException": { @@ -1849,7 +1873,7 @@ } }, "traits": { - "smithy.api#documentation": "

There was an internal error. Check the error message and try your request again.

", + "smithy.api#documentation": "

There was an internal error. Check the error message, correct the issue, and try your\n request again.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1860,36 +1884,36 @@ "Threshold": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

The duration of the interruption.

" + "smithy.api#documentation": "

Specify the duration of the interruptions in milliseconds. For example, you can flag speech that \n contains more than 10000 milliseconds of interruptions.

" } }, "ParticipantRole": { "target": "com.amazonaws.transcribe#ParticipantRole", "traits": { - "smithy.api#documentation": "

Indicates whether the caller or customer was interrupting.

" + "smithy.api#documentation": "

Specify the interrupter you want to flag. Omitting this parameter is equivalent to specifying \n both participants.

" } }, "AbsoluteTimeRange": { "target": "com.amazonaws.transcribe#AbsoluteTimeRange", "traits": { - "smithy.api#documentation": "

An object you can use to specify a time range (in milliseconds) for when you'd want to \n find the interruption. For example, you could search for an interruption between the 30,000 \n millisecond mark and the 45,000 millisecond mark. You could also specify the time period as \n the first 15,000 milliseconds or the last 15,000 milliseconds.

" + "smithy.api#documentation": "

Allows you to specify a time range (in milliseconds) in your audio, during which you want\n to search for an interruption. See for more \n detail.

" } }, "RelativeTimeRange": { "target": "com.amazonaws.transcribe#RelativeTimeRange", "traits": { - "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where there was\n a interruption. For example, you can specify the first half of the call. You can also specify the\n period of time between halfway through to three-quarters of the way through the call. \n Because the length of conversation can vary between calls, you can apply relative time \n ranges across all calls.

" + "smithy.api#documentation": "

Allows you to specify a time range (in percentage) in your media file, during which you\n want to search for an interruption. See for more \n detail.

" } }, "Negate": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Set to TRUE to look for a time period where there was no interruption.

" + "smithy.api#documentation": "

Set to TRUE to flag speech that does not contain interruptions. Set to \n FALSE to flag speech that contains interruptions.

" } } }, "traits": { - "smithy.api#documentation": "

An object that enables you to configure your category to be applied to call analytics \n jobs where either the customer or agent was interrupted.

" + "smithy.api#documentation": "

Flag the presence or absence of interruptions in your Call Analytics transcription output.

\n

Rules using InterruptionFilter are designed to match:

\n
    \n
  • \n

    Instances where an agent interrupts a customer

    \n
    • \n
  • \n

    Instances where a customer interrupts an agent

    \n
    • \n
  • \n

    Either participant interrupting the other

    \n
    • \n
  • \n

    A lack of interruptions

    \n
    • \n
\n

See Rule\n criteria for usage examples.

" } }, "com.amazonaws.transcribe#JobExecutionSettings": { @@ -1898,18 +1922,18 @@ "AllowDeferredExecution": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit \n is exceeded. When the AllowDeferredExecution field is true, jobs are queued\n and executed when the number of executing jobs falls below the concurrent execution limit. If\n the field is false, Amazon Transcribe returns a LimitExceededException exception.

\n

Note that job queuing is enabled by default for call analytics jobs.

\n

If you specify the AllowDeferredExecution field, you must specify the \n DataAccessRoleArn field.

" + "smithy.api#documentation": "

Allows you to enable job queuing when your concurrent request limit is exceeded. When \n AllowDeferredExecution is set to true, transcription job requests are\n placed in a queue until the number of jobs falls below the concurrent request limit. If\n AllowDeferredExecution is set to false and the number of transcription\n job requests exceed the concurrent request limit, you get a LimitExceededException \n error.

\n

Note that job queuing is enabled by default for Call Analytics jobs.

\n

If you include AllowDeferredExecution in your request, you must also include\n DataAccessRoleArn.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN), in the form\n arn:partition:service:region:account-id:resource-type/resource-id, of a role \n that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to \n read queued media files. If you have specified an output S3 bucket for the transcription \n results, this role should have access to the output bucket as well.

\n

If you specify the AllowDeferredExecution field, you must specify the\n DataAccessRoleArn field.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t \n have the appropriate permissions to access the specified Amazon S3 location, your request \n fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin. For more information, see \n IAM ARNs.

\n

Note that if you include DataAccessRoleArn in your request, you must also include\n AllowDeferredExecution.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about when a transcription job should be executed.

" + "smithy.api#documentation": "

Allows you to control how your transcription job is processed. Currently, the only\n JobExecutionSettings modification you can choose is enabling job queueing using \n the AllowDeferredExecution sub-parameter.

\n

If you include JobExecutionSettings in your request, you must also include\n the sub-parameters: AllowDeferredExecution and \n DataAccessRoleArn.

" } }, "com.amazonaws.transcribe#KMSEncryptionContextMap": { @@ -2104,30 +2128,56 @@ ] } }, + "com.amazonaws.transcribe#LanguageCodeItem": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.transcribe#LanguageCode", + "traits": { + "smithy.api#documentation": "

Provides the language code for each language identified in your media.

" + } + }, + "DurationInSeconds": { + "target": "com.amazonaws.transcribe#DurationInSeconds", + "traits": { + "smithy.api#documentation": "

Provides the total time, in seconds, each identified language is spoken in your media.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides information on the speech contained in a discreet utterance when \n multi-language identification is enabled in your request. This utterance represents a block \n of speech consisting of one language, preceded or followed by a block of speech in a different\n language.

" + } + }, + "com.amazonaws.transcribe#LanguageCodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#LanguageCodeItem" + } + }, "com.amazonaws.transcribe#LanguageIdSettings": { "type": "structure", "members": { "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary you want to use when processing your transcription job. The \n vocabulary you specify must have the same language codes as the transcription job; if the\n languages don't match, the vocabulary isn't applied.

" + "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your transcription job. \n Vocabulary names are case sensitive.

\n

The language of the specified vocabulary must match the language code you specify in\n your transcription request. If the languages don't match, the vocabulary isn't applied. There\n are no errors or warnings associated with a language mismatch.

" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter you want to use when transcribing your audio. The filter\n you specify must have the same language codes as the transcription job; if the languages \n don't match, the vocabulary filter isn't be applied.

" + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to use when processing your \n transcription job. Vocabulary filter names are case sensitive.

\n

The language of the specified vocabulary filter must match the language code you specify\n in your transcription request. If the languages don't match, the vocabulary filter isn't applied. \n There are no errors or warnings associated with a language mismatch.

\n

Note that if you include VocabularyFilterName in your request, you must \n also include VocabularyFilterMethod.

" } }, "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the language model you want to use when transcribing your audio. The \n model you specify must have the same language codes as the transcription job; if the \n languages don't match, the language model isn't be applied.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your \n transcription job. Note that language model names are case sensitive.

\n

The language of the specified language model must match the language code you specify\n in your transcription request. If the languages don't match, the language model isn't applied. \n There are no errors or warnings associated with a language mismatch.

" } } }, "traits": { - "smithy.api#documentation": "

Language-specific settings that can be specified when language identification is \n enabled.

" + "smithy.api#documentation": "

If using automatic language identification (IdentifyLanguage) in your request \n and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary\n filter, include LanguageIdSettings with the relevant sub-parameters \n (VocabularyName, LanguageModelName, and \n VocabularyFilterName).

\n

You can specify two or more language codes that represent the languages you think may be \n present in your media; including more than five is not recommended. Each language code you \n include can have an associated custom language model, custom vocabulary, and custom \n vocabulary filter. The languages you specify must match the languages of the specified custom\n language models, custom vocabularies, and custom vocabulary filters.

\n

To include language options using IdentifyLanguage \n without including a custom language model, a custom \n vocabulary, or a custom vocabulary filter, use LanguageOptions instead of\n LanguageIdSettings. Including language options can improve the accuracy of \n automatic language identification.

\n

If you want to include a custom language model with your request but \n do not want to use automatic language identification,\n use instead the parameter with the\n LanguageModelName sub-parameter.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with\n your request but do not want to use automatic \n language identification, use instead the \n parameter with the VocabularyName or \n VocabularyFilterName (or both) sub-parameter.

" } }, "com.amazonaws.transcribe#LanguageIdSettingsMap": { @@ -2151,60 +2201,60 @@ "ModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of the custom language model.

" + "smithy.api#documentation": "

A unique name, chosen by you, for your custom language model.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account.

" } }, "CreateTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The time the custom language model was created.

" + "smithy.api#documentation": "

The date and time the specified custom language model was created.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The most recent time the custom language model was modified.

" + "smithy.api#documentation": "

The date and time the specified language model was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#CLMLanguageCode", "traits": { - "smithy.api#documentation": "

The language code you used to create your custom language model.

" + "smithy.api#documentation": "

The language code used to create your custom language model. Each language model must\n contain terms in only one language, and the language you select for your model must match \n the language of your training and tuning data.

\n

For a list of supported languages and their associated language codes, refer to the \n Supported\n languages table. Note that U.S. English (en-US) is the only language \n supported with Amazon Transcribe Medical.

" } }, "BaseModelName": { "target": "com.amazonaws.transcribe#BaseModelName", "traits": { - "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model used to create the custom language\n model.

" + "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model, used to create your custom\n language model.

" } }, "ModelStatus": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

The creation status of a custom language model. When the status is \n COMPLETED the model is ready for use.

" + "smithy.api#documentation": "

The status of the specified custom language model. When the status displays as \n COMPLETED the model is ready for use.

" } }, "UpgradeAvailability": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Whether the base model used for the custom language model is up to date. If this field \n is false then you are running the most up-to-date version of the base model \n in your custom language model.

" + "smithy.api#documentation": "

Shows if a more current base model is available for use with the specified custom language \n model.

\n

If false, your language model is using the most up-to-date base model.

\n

If true, there is a newer base model available than the one your language \n model is using.

\n

Note that to update a base model, you must recreate the custom language model using the\n new base model. Base model upgrades for existing custom language models are not \n supported.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

The reason why the custom language model couldn't be created.

" + "smithy.api#documentation": "

If ModelStatus is FAILED, FailureReason\n contains information about why the custom language model request failed. See also: \n Common Errors.

" } }, "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

The data access role and Amazon S3 prefixes for the input files used to train the custom\n language model.

" + "smithy.api#documentation": "

The Amazon S3 location of the input files used to train and tune your custom language \n model, in addition to the data access role ARN (Amazon Resource Name) that has permissions to \n access these data.

" } } }, "traits": { - "smithy.api#documentation": "

The structure used to describe a custom language model.

" + "smithy.api#documentation": "

Provides information about a custom language model, including the base model name, when \n the model was created, the location of the files used to train the model, when the model was last\n modified, the name you chose for the model, its language, its processing state, and if there is an\n upgrade available for the base model.

" } }, "com.amazonaws.transcribe#LanguageOptions": { @@ -2226,7 +2276,7 @@ } }, "traits": { - "smithy.api#documentation": "

Either you have sent too many requests or your input file is too long. Wait before you\n resend your request, or use a smaller file and resend the request.

", + "smithy.api#documentation": "

You've either sent too many requests or your input file is too long. Wait before retrying \n your request, or use a smaller file and try your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2251,7 +2301,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides more information about the call analytics categories that you've created. You \n can use the information in this list to find a specific category. You can then use the\n operation to get more information about \n it.

", + "smithy.api#documentation": "

Provides a list of Call Analytics categories, including all rules that make up each category.

\n

To get detailed information about a specific Call Analytics category, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticscategories", @@ -2270,14 +2320,14 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

When included, NextTokenfetches the next set of categories if the result \n of the previous request was truncated.

", + "smithy.api#documentation": "

If your ListCallAnalyticsCategories request returns more results than can \n be displayed, NextToken is displayed in the response with an associated string.\n To get the next page of results, copy this string and repeat your request, including \n NextToken with the value of the copied string. Repeat as needed to view all your \n results.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of categories to return in each page of results. If there are fewer \n results than the value you specify, only the actual results are returned. If you do not specify a\n value, the default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of Call Analytics categories to return in each page of results. If there\n are fewer results than the value you specify, only the actual results are returned. If you don't \n specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2289,13 +2339,13 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The operation returns a page of jobs at\n a time. The maximum size of the list is set by the MaxResults parameter. If \n there are more categories in the list than the page size, Amazon Transcribe returns the \n NextPage token. Include the token in the next request to the \n operation to return the next page of analytics\n categories.

" + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all results\n are displayed. To view the next set of results, copy the string associated with the \n NextToken parameter in your results output, then run your request again \n including NextToken with the value of the copied string. Repeat as needed to \n view all your results.

" } }, "Categories": { "target": "com.amazonaws.transcribe#CategoryPropertiesList", "traits": { - "smithy.api#documentation": "

A list of objects containing information about analytics categories.

" + "smithy.api#documentation": "

Provides detailed information about your Call Analytics categories, including all the rules \n associated with each category.

" } } } @@ -2320,7 +2370,7 @@ } ], "traits": { - "smithy.api#documentation": "

List call analytics jobs with a specified status or substring that matches their names.

", + "smithy.api#documentation": "

Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are \n specified, all Call Analytics jobs are returned.

\n

To get detailed information about a specific Call Analytics job, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/callanalyticsjobs", @@ -2339,28 +2389,28 @@ "Status": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "

When specified, returns only call analytics jobs with the specified status. Jobs are ordered\n by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe \n returns all analytics jobs ordered by creation date.

", + "smithy.api#documentation": "

Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation \n date, with the newest job first. If you don't include Status, all Call Analytics\n jobs are returned.

", "smithy.api#httpQuery": "Status" } }, "JobNameContains": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

When specified, the jobs returned in the list are limited to jobs whose name contains the\n specified string.

", + "smithy.api#documentation": "

Returns only the Call Analytics jobs that contain the specified string. The search is not\n case sensitive.

", "smithy.api#httpQuery": "JobNameContains" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If you receive a truncated result in the previous request of \n , include NextToken to fetch the \n next set of jobs.

", + "smithy.api#documentation": "

If your ListCallAnalyticsJobs request returns more results than can be \n displayed, NextToken is displayed in the response with an associated string. To \n get the next page of results, copy this string and repeat your request, including \n NextToken with the value of the copied string. Repeat as needed to view all your \n results.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of call analytics jobs to return in each page of results. If there \n are fewer results than the value you specify, only the actual results are returned. If you do \n not specify a value, the default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of Call Analytics jobs to return in each page of results. If there are\n fewer results than the value you specify, only the actual results are returned. If you don't \n specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2372,19 +2422,19 @@ "Status": { "target": "com.amazonaws.transcribe#CallAnalyticsJobStatus", "traits": { - "smithy.api#documentation": "

When specified, returns only call analytics jobs with that status. Jobs are ordered\n by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe\n returns all transcription jobs ordered by creation date.

" + "smithy.api#documentation": "

Lists all Call Analytics jobs that have the status specified in your request. Jobs are\n ordered by creation date, with the newest job first.

" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The operation returns a page of jobs at a time.\n The maximum size of the page is set by the MaxResults parameter. If there are\n more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. \n Include the token in your next request to the \n operation to return next page of jobs.

" + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all results\n are displayed. To view the next set of results, copy the string associated with the \n NextToken parameter in your results output, then run your request again \n including NextToken with the value of the copied string. Repeat as needed to \n view all your results.

" } }, "CallAnalyticsJobSummaries": { "target": "com.amazonaws.transcribe#CallAnalyticsJobSummaries", "traits": { - "smithy.api#documentation": "

A list of objects containing summary information for a transcription job.

" + "smithy.api#documentation": "

Provides a summary of information about each result.

" } } } @@ -2409,7 +2459,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides more information about the custom language models you've created. You can \n use the information in this list to find a specific custom language model. You can then use \n the operation to get more information about \n it.

", + "smithy.api#documentation": "

Provides a list of custom language models that match the specified criteria. If no criteria\n are specified, all language models are returned.

\n

To get detailed information about a specific custom language model, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/languagemodels", @@ -2428,28 +2478,28 @@ "StatusEquals": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

When specified, returns only custom language models with the specified status. Language\n models are ordered by creation date, with the newest models first. If you don't specify a \n status, Amazon Transcribe returns all custom language models ordered by date.

", + "smithy.api#documentation": "

Returns only custom language models with the specified status. Language\n models are ordered by creation date, with the newest model first. If you don't include\n StatusEquals, all custom language models are returned.

", "smithy.api#httpQuery": " StatusEquals" } }, "NameContains": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

When specified, the custom language model names returned contain the substring you've\n specified.

", + "smithy.api#documentation": "

Returns only the custom language models that contain the specified string. The search \n is not case sensitive.

", "smithy.api#httpQuery": "NameContains" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

When included, fetches the next set of jobs if the result of the previous request was\n truncated.

", + "smithy.api#documentation": "

If your ListLanguageModels request returns more results than can be \n displayed, NextToken is displayed in the response with an associated string. To\n get the next page of results, copy this string and repeat your request, including \n NextToken with the value of the copied string. Repeat as needed to view all your \n results.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of language models to return in each page of results. If there are\n fewer results than the value you specify, only the actual results are returned. If you do not \n specify a value, the default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of custom language models to return in each page of results. If there\n are fewer results than the value you specify, only the actual results are returned. If you don't \n specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2461,13 +2511,13 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The operation returns a page of jobs at a \n time. The maximum size of the list is set by the MaxResults parameter. If there are more \n language models in the list than the page size, Amazon Transcribe returns the NextPage \n token. Include the token in the next request to the \n operation to return the next page of language \n models.

" + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all results\n are displayed. To view the next set of results, copy the string associated with the \n NextToken parameter in your results output, then run your request again \n including NextToken with the value of the copied string. Repeat as needed to\n view all your results.

" } }, "Models": { "target": "com.amazonaws.transcribe#Models", "traits": { - "smithy.api#documentation": "

A list of objects containing information about custom language models.

" + "smithy.api#documentation": "

Provides information about the custom language models that match the criteria specified\n in your request.

" } } } @@ -2492,7 +2542,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists medical transcription jobs with a specified status or substring that matches their\n names.

", + "smithy.api#documentation": "

Provides a list of medical transcription jobs that match the specified criteria. If no criteria are \n specified, all medical transcription jobs are returned.

\n

To get detailed information about a specific medical transcription job, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs", @@ -2511,28 +2561,28 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

When specified, returns only medical transcription jobs with the specified status. Jobs \n are ordered by creation date, with the newest jobs returned first. If you don't specify a status,\n Amazon Transcribe Medical returns all transcription jobs ordered by creation date.

", + "smithy.api#documentation": "

Returns only medical transcription jobs with the specified status. Jobs are ordered by \n creation date, with the newest job first. If you don't include Status, all\n medical transcription jobs are returned.

", "smithy.api#httpQuery": "Status" } }, "JobNameContains": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

When specified, the jobs returned in the list are limited to jobs whose name contains the \n specified string.

", + "smithy.api#documentation": "

Returns only the medical transcription jobs that contain the specified string. The search \n is not case sensitive.

", "smithy.api#httpQuery": "JobNameContains" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If you a receive a truncated result in the previous request of\n ListMedicalTranscriptionJobs, include NextToken to fetch the \n next set of jobs.

", + "smithy.api#documentation": "

If your ListMedicalTranscriptionJobs request returns more results than can \n be displayed, NextToken is displayed in the response with an associated string. \n To get the next page of results, copy this string and repeat your request, including \n NextToken with the value of the copied string. Repeat as needed to view all your \n results.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of medical transcription jobs to return in each page of results. If \n there are fewer results than the value you specify, only the actual results are returned. If you \n do not specify a value, the default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of medical transcription jobs to return in each page of results. If there\n are fewer results than the value you specify, only the actual results are returned. If you don't \n specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2544,19 +2594,19 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

The requested status of the medical transcription jobs returned.

" + "smithy.api#documentation": "

Lists all medical transcription jobs that have the status specified in your request. Jobs are\n ordered by creation date, with the newest job first.

" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListMedicalTranscriptionJobs operation returns a page of jobs at a\n time. The maximum size of the page is set by the MaxResults parameter. If\n the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the \n NextPage token. Include the token in the next request to the\n ListMedicalTranscriptionJobs operation to return in the next page of \n jobs.

" + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all results\n are displayed. To view the next set of results, copy the string associated with the \n NextToken parameter in your results output, then run your request again \n including NextToken with the value of the copied string. Repeat as needed to \n view all your results.

" } }, "MedicalTranscriptionJobSummaries": { "target": "com.amazonaws.transcribe#MedicalTranscriptionJobSummaries", "traits": { - "smithy.api#documentation": "

A list of objects containing summary information for a transcription job.

" + "smithy.api#documentation": "

Provides a summary of information about each result.

" } } } @@ -2581,7 +2631,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of vocabularies that match the specified criteria. If you don't enter a value in\n any of the request parameters, returns the entire list of vocabularies.

", + "smithy.api#documentation": "

Provides a list of custom medical vocabularies that match the specified criteria. If no \n criteria are specified, all custom medical vocabularies are returned.

\n

To get detailed information about a specific custom medical vocabulary, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/medicalvocabularies", @@ -2600,28 +2650,28 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of your previous request to ListMedicalVocabularies was\n truncated, include the NextToken to fetch the next set of\n vocabularies.

", + "smithy.api#documentation": "

If your ListMedicalVocabularies request returns more results than can be \n displayed, NextToken is displayed in the response with an associated string. To\n get the next page of results, copy this string and repeat your request, including \n NextToken with the value of the copied string. Repeat as needed to view all your \n results.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of vocabularies to return in each page of results. If there are\n fewer results than the value you specify, only the actual results are returned. If you do not\n specify a value, the default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of custom medical vocabularies to return in each page of results. If \n there are fewer results than the value you specify, only the actual results are returned. If you \n don't specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, "StateEquals": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

When specified, returns only vocabularies with the VocabularyState equal\n to the specified vocabulary state. Use this field to see which vocabularies are ready for your\n medical transcription jobs.

", + "smithy.api#documentation": "

Returns only custom medical vocabularies with the specified state. Vocabularies are \n ordered by creation date, with the newest vocabulary first. If you don't include \n StateEquals, all custom medical vocabularies are returned.

", "smithy.api#httpQuery": "StateEquals" } }, "NameContains": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

Returns vocabularies whose names contain the specified string. The search is not case \n sensitive. ListMedicalVocabularies returns both \n \"vocabularyname\" and \"VocabularyName\".

", + "smithy.api#documentation": "

Returns only the custom medical vocabularies that contain the specified string. The search \n is not case sensitive.

", "smithy.api#httpQuery": "NameContains" } } @@ -2633,19 +2683,19 @@ "Status": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The requested vocabulary state.

" + "smithy.api#documentation": "

Lists all custom medical vocabularies that have the status specified in your request. \n Vocabularies are ordered by creation date, with the newest vocabulary first.

" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListMedicalVocabularies operation returns a page of vocabularies at \n a time. You set the maximum number of vocabularies to return on a page with the\n MaxResults parameter. If there are more jobs in the list will fit on a page, \n Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies,\n include the token in the next request to the ListMedicalVocabularies \n operation.

" + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all results\n are displayed. To view the next set of results, copy the string associated with the \n NextToken parameter in your results output, then run your request again \n including NextToken with the value of the copied string. Repeat as needed to\n view all your results.

" } }, "Vocabularies": { "target": "com.amazonaws.transcribe#Vocabularies", "traits": { - "smithy.api#documentation": "

A list of objects that describe the vocabularies that match your search criteria.

" + "smithy.api#documentation": "

Provides information about the custom medical vocabularies that match the criteria specified\n in your request.

" } } } @@ -2673,7 +2723,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags associated with a given transcription job, vocabulary, or resource.

", + "smithy.api#documentation": "

Lists all tags associated with the specified transcription job, vocabulary, model, or \n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -2687,7 +2737,7 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "

Lists all tags associated with a given Amazon Resource Name (ARN). ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id (for example,\n arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). Valid \n values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary, \n medical-vocabulary, vocabulary-filter, and \n language-model.

", + "smithy.api#documentation": "

Returns a list of all tags associated with the specified Amazon Resource Name (ARN). ARNs \n have the format arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example, \n arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary, \n medical-vocabulary, vocabulary-filter, and \n language-model.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2700,13 +2750,13 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "

Lists all tags associated with the given Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) specified in your request.

" } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Lists all tags associated with the given transcription job, vocabulary, or resource.

" + "smithy.api#documentation": "

Lists all tags associated with the given transcription job, vocabulary, model, or \n resource.

" } } } @@ -2731,7 +2781,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists transcription jobs with the specified status.

", + "smithy.api#documentation": "

Provides a list of transcription jobs that match the specified criteria. If no criteria are \n specified, all transcription jobs are returned.

\n

To get detailed information about a specific transcription job, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/transcriptionjobs", @@ -2750,28 +2800,28 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

When specified, returns only transcription jobs with the specified status. Jobs are ordered\n by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe \n returns all transcription jobs ordered by creation date.

", + "smithy.api#documentation": "

Returns only transcription jobs with the specified status. Jobs are ordered by creation \n date, with the newest job first. If you don't include Status, all transcription \n jobs are returned.

", "smithy.api#httpQuery": "Status" } }, "JobNameContains": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

When specified, the jobs returned in the list are limited to jobs whose name contains the\n specified string.

", + "smithy.api#documentation": "

Returns only the transcription jobs that contain the specified string. The search is not\n case sensitive.

", "smithy.api#httpQuery": "JobNameContains" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of the previous request to ListTranscriptionJobs is truncated, \n include the NextToken to fetch the next set of jobs.

", + "smithy.api#documentation": "

If your ListTranscriptionJobs request returns more results than can be \n displayed, NextToken is displayed in the response with an associated string. To \n get the next page of results, copy this string and repeat your request, including \n NextToken with the value of the copied string. Repeat as needed to view all your \n results.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of jobs to return in each page of results. If there are fewer results\n than the value you specify, only the actual results are returned. If you do not specify a value,\n the default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of transcription jobs to return in each page of results. If there are\n fewer results than the value you specify, only the actual results are returned. If you don't \n specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2783,19 +2833,19 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

The requested status of the jobs returned.

" + "smithy.api#documentation": "

Lists all transcription jobs that have the status specified in your request. Jobs are\n ordered by creation date, with the newest job first.

" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListTranscriptionJobs operation returns a page of jobs at a time. The\n maximum size of the page is set by the MaxResults parameter. If there are\n more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. \n Include the token in the next request to the ListTranscriptionJobs operation to \n return in the next page of jobs.

" + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all results\n are displayed. To view the next set of results, copy the string associated with the \n NextToken parameter in your results output, then run your request again \n including NextToken with the value of the copied string. Repeat as needed to \n view all your results.

" } }, "TranscriptionJobSummaries": { "target": "com.amazonaws.transcribe#TranscriptionJobSummaries", "traits": { - "smithy.api#documentation": "

A list of objects containing summary information for a transcription job.

" + "smithy.api#documentation": "

Provides a summary of information about each result.

" } } } @@ -2820,7 +2870,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, \n returns the entire list of vocabularies.

", + "smithy.api#documentation": "

Provides a list of custom vocabularies that match the specified criteria. If no criteria are\n specified, all custom vocabularies are returned.

\n

To get detailed information about a specific custom vocabulary, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularies", @@ -2839,28 +2889,28 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of the previous request to ListVocabularies was truncated, \n include the NextToken to fetch the next set of jobs.

", + "smithy.api#documentation": "

If your ListVocabularies request returns more results than can be displayed,\n NextToken is displayed in the response with an associated string. To get the \n next page of results, copy this string and repeat your request, including \n NextToken with the value of the copied string. Repeat as needed to view all your \n results.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of vocabularies to return in each page of results. If there are fewer \n results than the value you specify, only the actual results are returned. If you do not specify a \n value, the default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of custom vocabularies to return in each page of results. If there \n are fewer results than the value you specify, only the actual results are returned. If you \n don't specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, "StateEquals": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

When specified, only returns vocabularies with the VocabularyState field \n equal to the specified state.

", + "smithy.api#documentation": "

Returns only custom vocabularies with the specified state. Vocabularies are ordered by\n creation date, with the newest vocabulary first. If you don't include \n StateEquals, all custom medical vocabularies are returned.

", "smithy.api#httpQuery": "StateEquals" } }, "NameContains": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

When specified, the vocabularies returned in the list are limited to vocabularies whose \n name contains the specified string. The search is not case sensitive, \n ListVocabularies returns both \"vocabularyname\" and \"VocabularyName\" in the\n response list.

", + "smithy.api#documentation": "

Returns only the custom vocabularies that contain the specified string. The search is not\n case sensitive.

", "smithy.api#httpQuery": "NameContains" } } @@ -2872,19 +2922,19 @@ "Status": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The requested vocabulary state.

" + "smithy.api#documentation": "

Lists all custom vocabularies that have the status specified in your request. Vocabularies \n are ordered by creation date, with the newest vocabulary first.

" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListVocabularies operation returns a page of vocabularies at a time. \n The maximum size of the page is set in the MaxResults parameter. If there are\n more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token.\n To return in the next page of jobs, include the token in the next request to the\n ListVocabularies operation.

" + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all results\n are displayed. To view the next set of results, copy the string associated with the \n NextToken parameter in your results output, then run your request again \n including NextToken with the value of the copied string. Repeat as needed to \n view all your results.

" } }, "Vocabularies": { "target": "com.amazonaws.transcribe#Vocabularies", "traits": { - "smithy.api#documentation": "

A list of objects that describe the vocabularies that match the search criteria in the\n request.

" + "smithy.api#documentation": "

Provides information about the custom vocabularies that match the criteria specified in your\n request.

" } } } @@ -2909,7 +2959,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about vocabulary filters.

", + "smithy.api#documentation": "

Provides a list of custom vocabulary filters that match the specified criteria. If no\n criteria are specified, all custom vocabularies are returned.

\n

To get detailed information about a specific custom vocabulary filter, use the \n operation.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularyFilters", @@ -2928,21 +2978,21 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of the previous request to ListVocabularyFilters was truncated, \n include the NextToken to fetch the next set of collections.

", + "smithy.api#documentation": "

If your ListVocabularyFilters request returns more results than can \n be displayed, NextToken is displayed in the response with an associated string. \n To get the next page of results, copy this string and repeat your request, including \n NextToken with the value of the copied string. Repeat as needed to view all your \n results.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of filters to return in each page of results. If there are fewer \n results than the value you specify, only the actual results are returned. If you do not specify \n a value, the default of 5 is used.

", + "smithy.api#documentation": "

The maximum number of custom vocabulary filters to return in each page of results. If \n there are fewer results than the value you specify, only the actual results are returned. If you \n don't specify a value, a default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, "NameContains": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

Filters the response so that it only contains vocabulary filters whose name contains the \n specified string.

", + "smithy.api#documentation": "

Returns only the custom vocabulary filters that contain the specified string. The search \n is not case sensitive.

", "smithy.api#httpQuery": "NameContains" } } @@ -2954,13 +3004,13 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListVocabularyFilters operation returns a page of collections at a time.\n The maximum size of the page is set by the MaxResults parameter. If there \n are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token.\n Include the token in the next request to the ListVocabularyFilters operation to \n return in the next page of jobs.

" + "smithy.api#documentation": "

If NextToken is present in your response, it indicates that not all results\n are displayed. To view the next set of results, copy the string associated with the \n NextToken parameter in your results output, then run your request again \n including NextToken with the value of the copied string. Repeat as needed to \n view all your results.

" } }, "VocabularyFilters": { "target": "com.amazonaws.transcribe#VocabularyFilters", "traits": { - "smithy.api#documentation": "

The list of vocabulary filters. It contains at most MaxResults number of \n filters. If there are more filters, call the ListVocabularyFilters operation again \n with the NextToken parameter in the request set to the value of the\n NextToken field in the response.

" + "smithy.api#documentation": "

Provides information about the custom vocabulary filters that match the criteria specified\n in your request.

" } } } @@ -3001,18 +3051,18 @@ "MediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the input media file. The URI must be in the same region as \n the API endpoint that you are calling. The general form is:

\n

\n s3://DOC-EXAMPLE-BUCKET/keyprefix/objectkey\n

\n

For example:

\n

\n s3://DOC-EXAMPLE-BUCKET/example.flac\n

\n

\n s3://DOC-EXAMPLE-BUCKET/mediafiles/example.flac\n

\n

For more information about S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

" + "smithy.api#documentation": "

The Amazon S3 location of the media file you want to transcribe. For\n example:

\n
    \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n

    \n
    • \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n

    \n
    • \n
\n

Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription \n request.

" } }, "RedactedMediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location for your redacted output media file. This is only supported for \n call analytics jobs.

" + "smithy.api#documentation": "

The Amazon S3 location of the media file you want to redact. For\n example:

\n
    \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/my-media-file.flac\n

    \n
    • \n
  • \n

    \n s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac\n

    \n
    • \n
\n

Note that the Amazon S3 bucket that contains your input media must be located\n in the same Amazon Web Services Region where you're making your transcription \n request.

\n \n

\n RedactedMediaFileUri is only supported for Call Analytics\n (StartCallAnalyticsJob) transcription requests.

\n " } } }, "traits": { - "smithy.api#documentation": "

Describes the input media file in a transcription request.

" + "smithy.api#documentation": "

Describes the Amazon S3 location of the media file you want to use in your \n request.

" } }, "com.amazonaws.transcribe#MediaFormat": { @@ -3087,12 +3137,12 @@ "TranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the medical transcript.

\n

Use this URI to access the medical transcript. This URI points to the S3 bucket you created \n to store the medical transcript.

" + "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or \n download your transcript.

\n

If you included OutputBucketName in your transcription job request, this is \n the URI of that bucket. If you also included OutputKey in your request, your \n output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and TranscriptFileUri\n provides you with a temporary URI you can use for secure access to your transcript.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 \n minutes. If you get an AccesDenied error, you can get a new temporary \n URI by running a GetTranscriptionJob or \n ListTranscriptionJob request.

\n " } } }, "traits": { - "smithy.api#documentation": "

Identifies the location of a medical transcript.

" + "smithy.api#documentation": "

Provides you with the Amazon S3 URI you can use to access your transcript.

" } }, "com.amazonaws.transcribe#MedicalTranscriptionJob": { @@ -3101,25 +3151,25 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name for a given medical transcription job.

" + "smithy.api#documentation": "

The name of the medical transcription job. Job names are case sensitive and must be unique \n within an Amazon Web Services account.

" } }, "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

The completion status of a medical transcription job.

" + "smithy.api#documentation": "

Provides the status of the specified medical transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the results\n at the location specified in TranscriptFileUri. If the status is \n FAILED, FailureReason provides details on why your transcription\n job failed.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language spoken in the source audio file. US English (en-US) \n is the only supported language for medical transcriptions. Any other value you enter for \n language code results in a BadRequestException error.

" + "smithy.api#documentation": "

The language code used to create your medical transcription job. US English \n (en-US) is the only supported language for medical transcriptions.

" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MedicalMediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz, of the source audio containing medical information.

\n

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to \n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in your input media file.

" } }, "MediaFormat": { @@ -3134,66 +3184,66 @@ "Transcript": { "target": "com.amazonaws.transcribe#MedicalTranscript", "traits": { - "smithy.api#documentation": "

An object that contains the MedicalTranscript. The\n MedicalTranscript contains the TranscriptFileUri.

" + "smithy.api#documentation": "

Provides you with the Amazon S3 URI you can use to access your transcript.

" } }, "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job started processing.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job was created.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job was completed.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, this field \n contains information about why the job failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format- The media format specified in the\n MediaFormat field of the request isn't valid. See the description of the \n MediaFormat field for a list of valid values.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media \n format- The media format of the audio file doesn't match the format specified \n in the MediaFormat field in the request. Check the media format of \n your media file and make sure the two values match.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file- The sample rate specified in the \n MediaSampleRateHertz of the request isn't valid. The sample rate must\n be between 8,000 and 48,000 Hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample \n rate- The sample rate in the audio file doesn't match the sample rate specified\n in the MediaSampleRateHertz field in the request. Check the sample rate\n of your media file and make sure that the two values match.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large- The size of your audio file is \n larger than what Amazon Transcribe Medical can process. For more information, see \n Guidelines\n and Quotas in the Amazon Transcribe Medical Guide.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large- Your \n audio contains more channels than Amazon Transcribe Medical is configured to process. To request\n additional channels, see Amazon Transcribe Medical Endpoints and \n Quotas in the Amazon Web Services General\n Reference.

    \n
    • \n
" + "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED, \n FailureReason contains information about why the transcription job request\n failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media \n format.

    \n

    The media format specified in MediaFormat doesn't match the \n format of the input file. Check the media format of your media file and correct the \n specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 16,000 and 48,000 Hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample \n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't \n match the sample rate detected in your input media file. Check the sample rate of \n your media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can process. \n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process. \n For more information, refer to Guidelines and \n quotas.

    \n
    • \n
" } }, "Settings": { "target": "com.amazonaws.transcribe#MedicalTranscriptionSetting", "traits": { - "smithy.api#documentation": "

Object that contains object.

" + "smithy.api#documentation": "

Specify additional optional settings in your \n request, including channel identification, alternative transcriptions, and speaker labeling; allows \n you to apply custom vocabularies to your medical transcription job.

" } }, "ContentIdentificationType": { "target": "com.amazonaws.transcribe#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription\n job. If the value is PHI, you've configured the job to identify personal health\n information (PHI) in the transcription output.

" + "smithy.api#documentation": "

Labels all personal health information (PHI) identified in your transcript. For more information, \n see Identifying personal health \n information (PHI) in a transcription.

" } }, "Specialty": { "target": "com.amazonaws.transcribe#Specialty", "traits": { - "smithy.api#documentation": "

The medical specialty of any clinicians providing a dictation or having a conversation. \n Refer to Transcribing a medical\n conversationfor a list of supported specialties.

" + "smithy.api#documentation": "

Describes the medical specialty represented in your media.

" } }, "Type": { "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "

The type of speech in the transcription job. CONVERSATION is generally\n used for patient-physician dialogues. DICTATION is the setting for physicians\n speaking their notes after seeing a patient. For more information, see \n What \n is Amazon Transcribe Medical?.

" + "smithy.api#documentation": "

Indicates whether the input media is a dictation or a conversation, as specified in the \n StartMedicalTranscriptionJob request.

" } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

A key:value pair assigned to a given medical transcription job.

" + "smithy.api#documentation": "

The tags, each in the form of a key:value pair, assigned to the specified medical\n transcription job.

" } } }, "traits": { - "smithy.api#documentation": "

The data structure that contains the information for a medical transcription job.

" + "smithy.api#documentation": "

Provides detailed information about a medical transcription job.

\n

To view the status of the specified medical transcription job, check the \n TranscriptionJobStatus field. If the status is COMPLETED, the \n job is finished and you can find the results at the location specified in \n TranscriptFileUri. If the status is FAILED, \n FailureReason provides details on why your transcription job failed.

" } }, "com.amazonaws.transcribe#MedicalTranscriptionJobSummaries": { @@ -3208,72 +3258,72 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of a medical transcription job.

" + "smithy.api#documentation": "

The name of the medical transcription job. Job names are case sensitive and must be unique \n within an Amazon Web Services account.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the medical transcription job was created.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job began processing.

" + "smithy.api#documentation": "

The date and time your medical transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job was completed.

" + "smithy.api#documentation": "

The date and time the specified medical transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language of the transcript in the source audio file.

" + "smithy.api#documentation": "

The language code used to create your medical transcription. US English \n (en-US) is the only supported language for medical transcriptions.

" } }, "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

The status of the medical transcription job.

" + "smithy.api#documentation": "

Provides the status of your medical transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the results\n at the location specified in TranscriptFileUri. If the status is \n FAILED, FailureReason provides details on why your transcription\n job failed.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, a description \n of the error.

" + "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job \n failed. See also: Common Errors.

" } }, "OutputLocationType": { "target": "com.amazonaws.transcribe#OutputLocationType", "traits": { - "smithy.api#documentation": "

Indicates the location of the transcription job's output. This field must be the path of an\n S3 bucket; if you don't already have an S3 bucket, one is created based on the path you \n add.

" + "smithy.api#documentation": "

Indicates where the specified medical transcription output is stored.

\n

If the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your \n request. If you also included \n OutputKey in your request, your output is located in the path you specified in your\n request.

\n

If the value is SERVICE_BUCKET, the location is a service-managed \n Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use\n the URI shown in the TranscriptFileUri field.

" } }, "Specialty": { "target": "com.amazonaws.transcribe#Specialty", "traits": { - "smithy.api#documentation": "

The medical specialty of the transcription job. Refer to Transcribing a medical\n conversationfor a list of supported specialties.

" + "smithy.api#documentation": "

Provides the medical specialty represented in your media.

" } }, "ContentIdentificationType": { "target": "com.amazonaws.transcribe#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job.\n If the value is PHI, you've configured the transcription job to identify personal\n health information (PHI).

" + "smithy.api#documentation": "

Labels all personal health information (PHI) identified in your transcript. For more information, \n see Identifying personal health \n information (PHI) in a transcription.

" } }, "Type": { "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "

The speech of the clinician in the input audio.

" + "smithy.api#documentation": "

Indicates whether the input media is a dictation or a conversation, as specified in the \n StartMedicalTranscriptionJob request.

" } } }, "traits": { - "smithy.api#documentation": "

Provides summary information about a transcription job.

" + "smithy.api#documentation": "

Provides detailed information about a specific medical transcription job.

" } }, "com.amazonaws.transcribe#MedicalTranscriptionSetting": { @@ -3282,42 +3332,42 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether the transcription job uses speaker recognition to identify different \n speakers in the input audio. Speaker recognition labels individual speakers in the audio file. \n If you set the ShowSpeakerLabels field to true, you must also set the \n maximum number of speaker labels in the MaxSpeakerLabels field.

\n

You can't set both ShowSpeakerLabels and \n ChannelIdentification in the same request. If you set both, your request \n returns a BadRequestException.

" + "smithy.api#documentation": "

Enables speaker identification (diarization) in your transcription output. Speaker identification \n labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

You can't include both ShowSpeakerLabels and \n ChannelIdentification in the same request. Including both parameters \n returns a BadRequestException.

\n

For more information, see Identifying speakers (diarization).

" } }, "MaxSpeakerLabels": { "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "

The maximum number of speakers to identify in the input audio. If there are more \n speakers in the audio than this number, multiple speakers are identified as a single speaker. \n If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" + "smithy.api#documentation": "

Specify the maximum number of speakers you want to identify in your media.

\n

Note that if your media contains more speakers than the specified number, multiple speakers\n will be identified as a single speaker.

\n

If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" } }, "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the \n transcription output of each channel into a single transcription.

\n

Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel,\n including the start time and end time of the item and alternative transcriptions of item. \n The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.

\n

You can't set both ShowSpeakerLabels and \n ChannelIdentification in the same request. If you set both, your request \n returns a BadRequestException.

" + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then appends the \n output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio is \n transcribed in a continuous manner and your transcript does not separate the speech by channel.

\n

You can't include both ShowSpeakerLabels and \n ChannelIdentification in the same request. Including both parameters \n returns a BadRequestException.

\n

For more information, see Transcribing multi-channel audio.

" } }, "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether alternative transcripts are generated along with the transcript that \n has the highest confidence. If you set ShowAlternatives field to true, you must\n also set the maximum number of alternatives to return in the MaxAlternatives\n field.

" + "smithy.api#documentation": "

To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.

\n

If you include ShowAlternatives, you must also include \n MaxAlternatives, which is the maximum number of alternative transcriptions \n you want Amazon Transcribe Medical to generate.

\n

For more information, see Alternative transcriptions.

" } }, "MaxAlternatives": { "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "

The maximum number of alternatives that you tell the service to return. If you specify\n the MaxAlternatives field, you must set the ShowAlternatives \n field to true.

" + "smithy.api#documentation": "

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe \n Medical to include in your transcript.

\n

If you select a number greater than the number of alternative transcriptions generated by \n Amazon Transcribe Medical, only the actual number of alternative transcriptions are\n included.

\n

If you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.

\n

For more information, see Alternative transcriptions.

" } }, "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to use when processing a medical transcription job.

" + "smithy.api#documentation": "

The name of the custom vocabulary you want to use when processing your medical \n transcription job. Vocabulary names are case sensitive.

\n

The language of the specified vocabulary must match the language code you specify in\n your transcription request. If the languages don't match, the vocabulary isn't applied. There\n are no errors or warnings associated with a language mismatch. US English \n (en-US) is the only valid language for Amazon Transcribe Medical.

" } } }, "traits": { - "smithy.api#documentation": "

Optional settings for the StartMedicalTranscriptionJob operation.

" + "smithy.api#documentation": "

Allows additional optional settings in your \n request, including channel identification, alternative transcriptions, and speaker labeling; allows\n you to apply custom vocabularies to your medical transcription job.

" } }, "com.amazonaws.transcribe#ModelName": { @@ -3336,12 +3386,12 @@ "LanguageModelName": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

The name of your custom language model.

" + "smithy.api#documentation": "

The name of the custom language model you want to use when processing your \n transcription job. Note that language model names are case sensitive.

\n

The language of the specified language model must match the language code you specify\n in your transcription request. If the languages don't match, the language model isn't applied. \n There are no errors or warnings associated with a language mismatch.

" } } }, "traits": { - "smithy.api#documentation": "

The object used to call your custom language model to your transcription job.

" + "smithy.api#documentation": "

Provides the name of the custom language model that was included in the specified \n transcription job.

\n

Only use ModelSettings with the LanguageModelName \n sub-parameter if you're not using automatic language \n identification (). \n If using LanguageIdSettings in your request, this parameter contains a\n LanguageModelName sub-parameter.

" } }, "com.amazonaws.transcribe#ModelStatus": { @@ -3395,30 +3445,30 @@ "Threshold": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

The duration of the period when neither the customer nor agent was talking.

" + "smithy.api#documentation": "

Specify the duration, in milliseconds, of the period of silence you want to flag. For \n example, you can flag a silent period that lasts 30000 milliseconds.

" } }, "AbsoluteTimeRange": { "target": "com.amazonaws.transcribe#AbsoluteTimeRange", "traits": { - "smithy.api#documentation": "

An object you can use to specify a time range (in milliseconds) for when no one is\n talking. For example, you could specify a time period between the 30,000 millisecond mark\n and the 45,000 millisecond mark. You could also specify the time period as the first 15,000\n milliseconds or the last 15,000 milliseconds.

" + "smithy.api#documentation": "

Allows you to specify a time range (in milliseconds) in your audio, during which you want \n to search for a period of silence. See for more \n detail.

" } }, "RelativeTimeRange": { "target": "com.amazonaws.transcribe#RelativeTimeRange", "traits": { - "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where there\n was silence. For example, you can specify the first half of the call. You can also specify \n the period of time between halfway through to three-quarters of the way through the call. \n Because the length of conversation can vary between calls, you can apply relative time\n ranges across all calls.

" + "smithy.api#documentation": "

Allows you to specify a time range (in percentage) in your media file, during which you\n want to search for a period of silence. See for more\n detail.

" } }, "Negate": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Set to TRUE to look for a time period when people were talking.

" + "smithy.api#documentation": "

Set to TRUE to flag periods of speech. Set to FALSE to flag \n periods of silence

" } } }, "traits": { - "smithy.api#documentation": "

An object that enables you to configure your category to be applied to call analytics \n jobs where either the customer or agent was interrupted.

" + "smithy.api#documentation": "

Flag the presence or absence of periods of silence in your Call Analytics transcription\n output.

\n

Rules using NonTalkTimeFilter are designed to match:

\n
    \n
  • \n

    The presence of silence at specified periods throughout the call

    \n
    • \n
  • \n

    The presence of speech at specified periods throughout the call

    \n
    • \n
\n

See Rule\n criteria for usage examples.

" } }, "com.amazonaws.transcribe#NotFoundException": { @@ -3429,7 +3479,7 @@ } }, "traits": { - "smithy.api#documentation": "

We can't find the requested resource. Check the name and try your request again.

", + "smithy.api#documentation": "

We can't find the requested resource. Check that the specified name is correct and try your\n request again.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3609,30 +3659,30 @@ "StartPercentage": { "target": "com.amazonaws.transcribe#Percentage", "traits": { - "smithy.api#documentation": "

A value that indicates the percentage of the beginning of the time range. To set a\n relative time range, you must specify a start percentage and an end percentage. For \n example, if you specify the following values:

\n
    \n
  • \n

    StartPercentage - 10

    \n
    • \n
  • \n

    EndPercentage - 50

    \n
    • \n
\n

This looks at the time range starting from 10% of the way into the call to 50% of \n the way through the call. For a call that lasts 100,000 milliseconds, this example range \n would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.

" + "smithy.api#documentation": "

The time, in percentage, when Amazon Transcribe starts searching for the specified \n criteria in your media file. If you include StartPercentage in your request, you\n must also include EndPercentage.

" } }, "EndPercentage": { "target": "com.amazonaws.transcribe#Percentage", "traits": { - "smithy.api#documentation": "

A value that indicates the percentage of the end of the time range. To set a relative\n time range, you must specify a start percentage and an end percentage. For example, if\n you specify the following values:

\n
    \n
  • \n

    StartPercentage - 10

    \n
    • \n
  • \n

    EndPercentage - 50

    \n
    • \n
\n

This looks at the time range starting from 10% of the way into the call to 50% of the \n way through the call. For a call that lasts 100,000 milliseconds, this example range would \n apply from the 10,000 millisecond mark to the 50,000 millisecond mark.

" + "smithy.api#documentation": "

The time, in percentage, when Amazon Transcribe stops searching for the specified criteria\n in your media file. If you include EndPercentage in your request, you must also\n include StartPercentage.

" } }, "First": { "target": "com.amazonaws.transcribe#Percentage", "traits": { - "smithy.api#documentation": "

A range that takes the portion of the call up to the time in milliseconds set by the \n value that you've specified. For example, if you specify 120000, the time \n range is set for the first 120,000 milliseconds of the call.

" + "smithy.api#documentation": "

The time, in percentage, from the start of your media file until the value you specify in\n which Amazon Transcribe searches for your specified criteria.

" } }, "Last": { "target": "com.amazonaws.transcribe#Percentage", "traits": { - "smithy.api#documentation": "

A range that takes the portion of the call from the time in milliseconds set by the\n value that you've specified to the end of the call. For example, if you specify \n 120000, the time range is set for the last 120,000 milliseconds of the \n call.

" + "smithy.api#documentation": "

The time, in percentage, from the value you specify until the end of your media file in\n which Amazon Transcribe searches for your specified criteria.

" } } }, "traits": { - "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where you \n would like to apply a filter. For example, you can specify the first half of the call. You can\n also specify the period of time between halfway through to three-quarters of the way \n through the call. Because the length of conversation can vary between calls, you can apply \n relative time ranges across all calls.

" + "smithy.api#documentation": "

A time range, in percentage, between two points in your media file.

\n

You can use StartPercentage and EndPercentage to \n search a custom segment. For example, setting StartPercentage to 10 and\n EndPercentage to 50 only searches for your specified criteria in the audio \n contained between the 10 percent mark and the 50 percent mark of your media file.

\n

You can use also First to search from the start of the media file until the\n time you specify, or Last to search from the time you specify until the end of \n the media file. For example, setting First to 10 only searches for your specified \n criteria in the audio contained in the first 10 percent of the media file.

\n

If you prefer to use milliseconds instead of percentage, see\n .

" } }, "com.amazonaws.transcribe#Rule": { @@ -3641,30 +3691,30 @@ "NonTalkTimeFilter": { "target": "com.amazonaws.transcribe#NonTalkTimeFilter", "traits": { - "smithy.api#documentation": "

A condition for a time period when neither the customer nor the agent was talking.

" + "smithy.api#documentation": "

Flag the presence or absence of periods of silence in your Call Analytics transcription \n output. Refer to for more detail.

" } }, "InterruptionFilter": { "target": "com.amazonaws.transcribe#InterruptionFilter", "traits": { - "smithy.api#documentation": "

A condition for a time period when either the customer or agent was interrupting the\n other person.

" + "smithy.api#documentation": "

Flag the presence or absence of interruptions in your Call Analytics transcription output. Refer to \n for more detail.

" } }, "TranscriptFilter": { "target": "com.amazonaws.transcribe#TranscriptFilter", "traits": { - "smithy.api#documentation": "

A condition that catches particular words or phrases based on a exact match. For \n example, if you set the phrase \"I want to speak to the manager\", only that exact phrase will\n be returned.

" + "smithy.api#documentation": "

Flag the presence or absence of specific words or phrases in your Call Analytics transcription \n output. Refer to for more detail.

" } }, "SentimentFilter": { "target": "com.amazonaws.transcribe#SentimentFilter", "traits": { - "smithy.api#documentation": "

A condition that is applied to a particular customer sentiment.

" + "smithy.api#documentation": "

Flag the presence or absence of specific sentiments in your Call Analytics transcription output. \n Refer to for more detail.

" } } }, "traits": { - "smithy.api#documentation": "

A condition in the call between the customer and the agent that you want to filter \n for.

" + "smithy.api#documentation": "

A rule is a set of criteria you can specify to flag an attribute in your Call Analytics output.\n Rules define a Call Analytics category.

\n

Rules can include these parameters: , \n , , and \n . To learn more about these parameters, refer to\n Rule\n criteria.

\n

To learn more about Call Analytics categories, see Creating categories.

\n

To learn more about Call Analytics, see Analyzing call center audio with Call \n Analytics.

" } }, "com.amazonaws.transcribe#RuleList": { @@ -3685,37 +3735,37 @@ "Sentiments": { "target": "com.amazonaws.transcribe#SentimentValueList", "traits": { - "smithy.api#documentation": "

An array that enables you to specify sentiments for the customer or agent. You can \n specify one or more values.

", + "smithy.api#documentation": "

Specify the sentiments you want to flag.

", "smithy.api#required": {} } }, "AbsoluteTimeRange": { "target": "com.amazonaws.transcribe#AbsoluteTimeRange", "traits": { - "smithy.api#documentation": "

The time range, measured in seconds, of the sentiment.

" + "smithy.api#documentation": "

Allows you to specify a time range (in milliseconds) in your audio, during which you want\n to search for the specified sentiments. See for more\n detail.

" } }, "RelativeTimeRange": { "target": "com.amazonaws.transcribe#RelativeTimeRange", "traits": { - "smithy.api#documentation": "

The time range, set in percentages, that correspond to proportion of the call.

" + "smithy.api#documentation": "

Allows you to specify a time range (in percentage) in your media file, during which you\n want to search for the specified sentiments. See \n for more detail.

" } }, "ParticipantRole": { "target": "com.amazonaws.transcribe#ParticipantRole", "traits": { - "smithy.api#documentation": "

A value that determines whether the sentiment belongs to the customer or the agent.

" + "smithy.api#documentation": "

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying\n both participants.

" } }, "Negate": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Set to TRUE to look for sentiments that weren't specified in the request.

" + "smithy.api#documentation": "

Set to TRUE to flag the sentiments you didn't include in your request. Set to\n FALSE to flag the sentiments you specified in your request.

" } } }, "traits": { - "smithy.api#documentation": "

An object that enables you to specify a particular customer or agent sentiment. If at \n least 50 percent of the conversation turns (the back-and-forth between two speakers) in a \n specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a\n match.

" + "smithy.api#documentation": "

Flag the presence or absence of specific sentiments detected in your Call Analytics \n transcription output.

\n

Rules using SentimentFilter are designed to match:

\n
    \n
  • \n

    The presence or absence of a positive sentiment felt by the customer, agent,\n or both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a negative sentiment felt by the customer, agent,\n or both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a neutral sentiment felt by the customer, agent, or\n both at specified points in the call

    \n
    • \n
  • \n

    The presence or absence of a mixed sentiment felt by the customer, the agent, \n or both at specified points in the call

    \n
    • \n
\n

See Rule\n criteria for examples.

" } }, "com.amazonaws.transcribe#SentimentValue": { @@ -3758,54 +3808,54 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of a vocabulary to use when processing the transcription job.

" + "smithy.api#documentation": "

The name of the custom vocabulary you want to use in your transcription job request. This \n name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account.

" } }, "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether the transcription job uses speaker recognition to identify different \n speakers in the input audio. Speaker recognition labels individual speakers in the audio file. \n If you set the ShowSpeakerLabels field to true, you must also set the\n maximum number of speaker labels MaxSpeakerLabels field.

\n

You can't set both ShowSpeakerLabels and \n ChannelIdentification in the same request. If you set both, your request returns\n a BadRequestException.

" + "smithy.api#documentation": "

Enables speaker identification (diarization) in your transcription output. Speaker identification \n labels the speech from individual speakers in your media file.

\n

If you enable ShowSpeakerLabels in your request, you must also include\n MaxSpeakerLabels.

\n

You can't include both ShowSpeakerLabels and \n ChannelIdentification in the same request. Including both parameters \n returns a BadRequestException.

\n

For more information, see Identifying speakers (diarization).

" } }, "MaxSpeakerLabels": { "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "

The maximum number of speakers to identify in the input audio. If there are more \n speakers in the audio than this number, multiple speakers are identified as a single speaker. \n If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" + "smithy.api#documentation": "

Specify the maximum number of speakers you want to identify in your media.

\n

Note that if your media contains more speakers than the specified number, multiple speakers\n will be identified as a single speaker.

\n

If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" } }, "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Instructs Amazon Transcribe to process each audio channel separately and then merge the \n transcription output of each channel into a single transcription.

\n

Amazon Transcribe also produces a transcription of each item detected on an audio channel, \n including the start time and end time of the item and alternative transcriptions of the item\n including the confidence that Amazon Transcribe has in the transcription.

\n

You can't set both ShowSpeakerLabels and \n ChannelIdentification in the same request. If you set both, your request \n returns a BadRequestException.

" + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then appends the \n output for each channel into one transcript.

\n

You can't include both ShowSpeakerLabels and \n ChannelIdentification in the same request. Including both parameters \n returns a BadRequestException.

\n

For more information, see Transcribing multi-channel audio.

" } }, "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether the transcription contains alternative transcriptions. If you set the \n ShowAlternatives field to true, you must also set the maximum number of\n alternatives to return in the MaxAlternatives field.

" + "smithy.api#documentation": "

To include alternative transcriptions within your transcription output, include\n ShowAlternatives in your transcription request.

\n

If you have multi-channel audio and do not enable channel identification, your audio is \n transcribed in a continuous manner and your transcript does not separate the speech by channel.

\n

If you include ShowAlternatives, you must also include \n MaxAlternatives, which is the maximum number of alternative transcriptions\n you want Amazon Transcribe to generate.

\n

For more information, see Alternative transcriptions.

" } }, "MaxAlternatives": { "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "

The number of alternative transcriptions that the service should return. If you specify \n the MaxAlternatives field, you must set the ShowAlternatives \n field to true.

" + "smithy.api#documentation": "

Indicate the maximum number of alternative transcriptions you want Amazon Transcribe \n to include in your transcript.

\n

If you select a number greater than the number of alternative transcriptions generated by \n Amazon Transcribe, only the actual number of alternative transcriptions are included.

\n

If you include MaxAlternatives in your request, you must also include\n ShowAlternatives with a value of true.

\n

For more information, see Alternative transcriptions.

" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter to use when transcribing the audio. The filter that you\n specify must have the same language code as the transcription job.

" + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to use in your transcription job request.\n This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account.

\n

Note that if you include VocabularyFilterName in your request, you must \n also include VocabularyFilterMethod.

" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribe#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "

Set to mask to remove filtered text from the transcript and replace it \n with three asterisks (\"***\") as placeholder text. Set to remove to remove \n filtered text from the transcript without using placeholder text. Set to tag to\n mark the word in the transcription output that matches the vocabulary filter. When you set \n the filter method to tag, the words matching your vocabulary filter are not\n masked or removed.

" + "smithy.api#documentation": "

Specify how you want your vocabulary filter applied to your transcript.

\n

To replace words with ***, choose mask.

\n

To delete words, choose remove.

\n

To flag words without changing them, choose tag.

" } } }, "traits": { - "smithy.api#documentation": "

Provides optional settings for the StartTranscriptionJob operation.

" + "smithy.api#documentation": "

Allows additional optional settings in your \n request, including channel identification, alternative transcriptions, and speaker labeling; allows \n you to apply custom vocabularies to your transcription job.

" } }, "com.amazonaws.transcribe#Specialty": { @@ -3842,7 +3892,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an asynchronous analytics job that not only transcribes the audio recording of a \n caller and agent, but also returns additional insights. These insights include how quickly or \n loudly the caller or agent was speaking. To retrieve additional insights with your analytics \n jobs, create categories. A category is a way to classify analytics jobs based on attributes, \n such as a customer's sentiment or a particular phrase being used during the call. For more\n information, see the operation.

", + "smithy.api#documentation": "

Transcribes the audio from a customer service call and applies any additional Request \n Parameters you choose to include in your request.

\n

In addition to many of the standard transcription features, Call Analytics provides you with \n call characteristics, call summarization, speaker sentiment, and optional redaction of your text \n transcript and your audio file. You can also apply custom categories to flag specified conditions. To\n learn more about these features and insights, refer to Analyzing call center audio with Call \n Analytics.

\n

If you want to apply categories to your Call Analytics job, you must create them\n before submitting your job request. Categories cannot be retroactively applied to a job. To\n create a new category, use the operation.\n To learn more about Call Analytics categories, see Creating \n categories.

\n

To make a StartCallAnalyticsJob request, you must first upload your media file \n into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file \n using the Media parameter.

\n

You must include the following parameters in your StartCallAnalyticsJob \n request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer\n to Amazon Transcribe \n endpoints and quotas.

    \n
    • \n
  • \n

    \n CallAnalyticsJobName: A custom name you create for your transcription job\n that is unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that\n has permissions to access the Amazon S3 bucket that contains your input files.

    \n
    • \n
  • \n

    \n Media (MediaFileUri or RedactedMediaFileUri):\n The Amazon S3 location of your media file.

    \n
    • \n
\n \n

With Call Analytics, you can redact the audio contained in your media file by including \n RedactedMediaFileUri, instead of MediaFileUri, to specify the \n location of your input audio. If you choose to redact your audio, you can find your redacted \n media at the location specified in the RedactedMediaFileUri field of your \n response.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -3856,7 +3906,7 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

The name of the call analytics job. You can't use the string \".\" or \"..\" by themselves as\n the job name. The name must also be unique within an Amazon Web Services account. If you \n try to create a call analytics job with the same name as a previous call analytics job, you get\n a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your Call Analytics job.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a new job with the same name as an \n existing job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3870,32 +3920,31 @@ "OutputLocation": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location where the output of the call analytics job is stored. You can \n provide the following location types to store the output of call analytics job:

\n
    \n
  • \n

    s3://DOC-EXAMPLE-BUCKET1

    \n

    If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file \n at the root level of the bucket.

    \n
    • \n
  • \n

    s3://DOC-EXAMPLE-BUCKET1/folder/

    \n

    f you specify a path, Amazon Transcribe saves the output of the analytics job as\n s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.

    \n

    If you specify a folder, you must provide a trailing slash.

    \n
    • \n
  • \n

    s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.

    \n

    If you provide a path that has the filename specified, Amazon Transcribe saves the output of \n the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json.

    \n
    • \n
\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt \n the output of our analytics job using the OutputEncryptionKMSKeyId parameter. \n If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption \n of the analytics job output that is placed in your S3 bucket.

" + "smithy.api#documentation": "

The Amazon S3 location where you want your Call Analytics transcription output \n stored. You can use any of the following formats to specify the output location:

\n
    \n
  1. \n

    s3://DOC-EXAMPLE-BUCKET

    \n
    2. \n
  2. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/

    \n
    3. \n
  3. \n

    s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

    \n
    4. \n
\n

Unless you specify a file name (option 3), the name of your output file has a default \n value that matches the name you specified for your transcription job using the \n CallAnalyticsJobName parameter.

\n

You can specify a KMS key to encrypt your output using the\n OutputEncryptionKMSKeyId parameter. If you don't specify a \n KMS key, Amazon Transcribe uses the default Amazon S3 key for \n server-side encryption.

\n

If you don't specify OutputLocation, your transcript is placed in a \n service-managed Amazon S3 bucket and you are provided with a URI to access your \n transcript.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service \n key used to encrypt the output of the call analytics job. The user calling the \n operation must have permission to use the \n specified KMS key.

\n

You use either of the following to identify an Amazon Web Services KMS key in the current\n account:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"

    \n
    • \n
\n

You can use either of the following to identify a KMS key in the current account or \n another account:

\n
    \n
  • \n

    Amazon Resource Name (ARN) of a KMS key in the current account or \n another account: \n \"arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab\"

    \n
    • \n
  • \n

    ARN of a KMS Key Alias:\n \"arn:aws:kms:region:accountID:alias/ExampleAlias\"

    \n
    • \n
\n

If you don't specify an encryption key, the output of the call analytics job is encrypted \n with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output location \n in the OutputLocation parameter.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your Call Analytics output.

\n

If using a key located in the current \n Amazon Web Services account, you can specify your KMS key in one of \n four ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example, \n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For \n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example, \n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different \n Amazon Web Services account than the current Amazon Web Services account, you can \n specify your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example, \n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example, \n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default \n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify \n an output location using the OutputLocation parameter.

\n

Note that the user making the \n request must have permission to use the specified KMS key.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that\n contains your input files. Amazon Transcribe assumes this role to read queued audio files. If you have \n specified an output S3 bucket for your transcription results, this role should have access to \n the output bucket as well.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that has permissions to\n access the Amazon S3 bucket that contains your input files. If the role you specify doesn’t \n have the appropriate permissions to access the specified Amazon S3 location, your request \n fails.

\n

IAM role ARNs have the format\n arn:partition:iam::account:role/role-name-with-path. For example:\n arn:aws:iam::111122223333:role/Admin.

\n

For more information, see IAM ARNs.

" } }, "Settings": { "target": "com.amazonaws.transcribe#CallAnalyticsJobSettings", "traits": { - "smithy.api#documentation": "

A Settings object that provides optional settings for a call analytics \n job.

" + "smithy.api#documentation": "

Specify additional optional settings in your \n request, including content redaction; allows you to apply custom language models, vocabulary \n filters, and custom vocabularies to your Call Analytics job.

" } }, "ChannelDefinitions": { "target": "com.amazonaws.transcribe#ChannelDefinitions", "traits": { - "smithy.api#documentation": "

When you start a call analytics job, you must pass an array that maps the agent and the\n customer to specific audio channels. The values you can assign to a channel are 0 and 1. The \n agent and the customer must each have their own channel. You can't assign more than one \n channel to an agent or customer.

" + "smithy.api#documentation": "

Allows you to specify which speaker is on which channel. For example, if your agent is the \n first participant to speak, you would set ChannelId to 0 (to\n indicate the first channel) and ParticipantRole to AGENT (to \n indicate that it's the agent speaking).

" } } } @@ -3906,7 +3955,7 @@ "CallAnalyticsJob": { "target": "com.amazonaws.transcribe#CallAnalyticsJob", "traits": { - "smithy.api#documentation": "

An object containing the details of the asynchronous call analytics job.

" + "smithy.api#documentation": "

Provides detailed information about the current Call Analytics job, including job status\n and, if applicable, failure reason.

" } } } @@ -3934,7 +3983,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a batch job to transcribe medical speech to text.

", + "smithy.api#documentation": "

Transcribes the audio from a medical dictation or conversation and applies any additional \n Request Parameters you choose to include in your request.

\n

In addition to many of the standard transcription features, Amazon Transcribe Medical provides\n you with a robust medical vocabulary and, optionally, content identification, which adds flags to \n personal health information (PHI). To learn more about these features, refer to \n How \n Amazon Transcribe Medical works.

\n

To make a StartMedicalTranscriptionJob request, you must first upload your media\n file into an Amazon S3 bucket; you can then specify the S3 location of the file using the \n Media parameter.

\n

You must include the following parameters in your StartMedicalTranscriptionJob \n request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer\n to Amazon Transcribe \n endpoints and quotas.

    \n
    • \n
  • \n

    \n MedicalTranscriptionJobName: A custom name you create for your\n transcription job that is unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n Media (MediaFileUri): The Amazon S3 location of \n your media file.

    \n
    • \n
  • \n

    \n LanguageCode: This must be en-US.

    \n
    • \n
  • \n

    \n OutputBucketName: The Amazon S3 bucket where you want \n your transcript stored. If you want your output stored in a sub-folder of this bucket, you must \n also include OutputKey.

    \n
    • \n
  • \n

    \n Specialty: This must be PRIMARYCARE.

    \n
    • \n
  • \n

    \n Type: Choose whether your audio is a conversation or a dictation.

    \n
    • \n
", "smithy.api#http": { "method": "PUT", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -3948,7 +3997,7 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the medical transcription job. You can't use the strings \".\" \n or \"..\" by themselves as the job name. The name must also be unique within an\n Amazon Web Services account. If you try to create a medical transcription job with the same\n name as a previous medical transcription job, you get a ConflictException \n error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your medical transcription job. The name you specify is \n also used as the default name of your transcription output file. If you want to specify a different \n name for your transcription output, use the OutputKey parameter.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a new job with the same name as an \n existing job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3956,20 +4005,20 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language spoken in the input media file. US English (en-US) is \n the valid value for medical transcription jobs. Any other value you enter for language code \n results in a BadRequestException error.

", + "smithy.api#documentation": "

The language code that represents the language spoken in the input media file. US English\n (en-US) is the only valid value for medical transcription jobs. Any other value \n you enter for language code results in a BadRequestException error.

", "smithy.api#required": {} } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MedicalMediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in the input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you \n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine\n the sample rate.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in your input media file.

\n

If you don't specify the media sample rate, Amazon Transcribe Medical determines it for\n you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe \n Medical; if there's a mismatch between the value you specify and the value detected, your job \n fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let\n Amazon Transcribe Medical determine the sample rate.

" } }, "MediaFormat": { "target": "com.amazonaws.transcribe#MediaFormat", "traits": { - "smithy.api#documentation": "

The audio format of the input media file.

" + "smithy.api#documentation": "

Specify the format of your input media file.

" } }, "Media": { @@ -3981,58 +4030,58 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The Amazon S3 location where the transcription is stored.

\n

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription \n results. Your transcript appears in the S3 location you specify. When you call the \n GetMedicalTranscriptionJob, the operation returns this location in the\n TranscriptFileUri field. The S3 bucket must have permissions that allow\n Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt\n the output of your transcription using the OutputEncryptionKMSKeyId parameter. \n If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side \n encryption of transcripts that are placed in your S3 bucket.

", + "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your medical transcription \n output stored. Do not include the S3:// prefix of the specified bucket.

\n

If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the \n name of a bucket.

\n

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if \n you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

\n

Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions\n Required for IAM User Roles.

\n

If you don't specify OutputBucketName, your transcript is placed in a \n service-managed Amazon S3 bucket and you are provided with a URI to access your \n transcript.

", "smithy.api#required": {} } }, "OutputKey": { "target": "com.amazonaws.transcribe#OutputKey", "traits": { - "smithy.api#documentation": "

You can specify a location in an Amazon S3 bucket to store the output of your medical \n transcription job.

\n

If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in\n the Amazon S3 bucket you specified. By default, the object key is \n \"your-transcription-job-name.json\".

\n

You can use output keys to specify the Amazon S3 prefix and file name of the transcription \n output. For example, specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key would \n lead to the output being stored as \"folder1/folder2/your-transcription-job-name.json\". If you \n specify \"my-other-job-name.json\" as the output key, the object key is changed to\n \"my-other-job-name.json\". You can use an output key to change both the prefix and the file\n name, for example \"folder/my-other-job-name.json\".

\n

If you specify an output key, you must also specify an S3 bucket in the\n OutputBucketName parameter.

" + "smithy.api#documentation": "

Use in combination with OutputBucketName to specify the output location of\n your transcript and, optionally, a unique name for your output file. The default name for your \n transcription output is the same as the name you specified for your medical transcription job \n (MedicalTranscriptionJobName).

\n

Here are some examples of how you can use OutputKey:

\n
    \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName\n and 'my-transcript.json' as the OutputKey, your transcription output \n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the MedicalTranscriptionJobName,\n 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and \n 'my-transcript' as the OutputKey, your transcription output path is \n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

    \n
    • \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName\n and 'test-files/my-transcript.json' as the OutputKey, your transcription output \n path is s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the MedicalTranscriptionJobName,\n 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and \n 'test-files/my-transcript' as the OutputKey, your transcription output path is \n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

    \n
    • \n
\n

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is \n created for you.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service\n (KMS) key used to encrypt the output of the transcription job. The user calling the \n StartMedicalTranscriptionJob operation must have permission to use the \n specified KMS key.

\n

You use either of the following to identify a KMS key in the current account:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"

    \n
    • \n
\n

You can use either of the following to identify a KMS key in the current account or \n another account:

\n
    \n
  • \n

    Amazon Resource Name (ARN) of a KMS key in the current account or another\n account: \"arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    ARN of a KMS Key Alias: \"arn:aws:kms:region:account ID:alias/ExampleAlias\"

    \n
    • \n
\n

If you don't specify an encryption key, the output of the medical transcription job is \n encrypted with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output location \n in the OutputBucketName parameter.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your medical transcription\n output.

\n

If using a key located in the current \n Amazon Web Services account, you can specify your KMS key in one of \n four ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example, \n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For \n example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example, \n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different \n Amazon Web Services account than the current Amazon Web Services account, you can \n specify your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example, \n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default \n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify \n an output location using the OutputLocation parameter.

\n

Note that the user making the \n request must have permission to use the specified KMS key.

" } }, "KMSEncryptionContext": { "target": "com.amazonaws.transcribe#KMSEncryptionContextMap", "traits": { - "smithy.api#documentation": "

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that \n provide an added layer of security for your data.

" + "smithy.api#documentation": "

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that \n provide an added layer of security for your data. For more information, see \n KMS \n encryption context and Asymmetric keys in \n KMS.

" } }, "Settings": { "target": "com.amazonaws.transcribe#MedicalTranscriptionSetting", "traits": { - "smithy.api#documentation": "

Optional settings for the medical transcription job.

" + "smithy.api#documentation": "

Specify additional optional settings in your \n request, including channel identification, alternative transcriptions, and speaker labeling; allows \n you to apply custom vocabularies to your transcription job.

" } }, "ContentIdentificationType": { "target": "com.amazonaws.transcribe#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "

You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify\n PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the\n transcription output.

" + "smithy.api#documentation": "

Labels all personal health information (PHI) identified in your transcript. For more information, \n see Identifying personal health \n information (PHI) in a transcription.

" } }, "Specialty": { "target": "com.amazonaws.transcribe#Specialty", "traits": { - "smithy.api#documentation": "

The medical specialty of any clinician speaking in the input media.

", + "smithy.api#documentation": "

Specify the predominant medical specialty represented in your media. For batch \n transcriptions, PRIMARYCARE is the only valid value. If you require additional \n specialties, refer to .

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "

The type of speech in the input audio. CONVERSATION refers to \n conversations between two or more speakers, e.g., a conversations between doctors and \n patients. DICTATION refers to single-speaker dictated speech, such as clinical\n notes.

", + "smithy.api#documentation": "

Specify whether your input media contains only one person (DICTATION) or \n contains a conversation between two people (CONVERSATION).

\n

For example, DICTATION could be used for a medical professional wanting to\n transcribe voice memos; CONVERSATION could be used for transcribing the \n doctor-patient dialogue during the patient's office visit.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Add tags to an Amazon Transcribe Medical transcription job.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new medical \n transcription job at the time you start this new job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" } } } @@ -4043,7 +4092,7 @@ "MedicalTranscriptionJob": { "target": "com.amazonaws.transcribe#MedicalTranscriptionJob", "traits": { - "smithy.api#documentation": "

A batch job submitted to transcribe medical speech to text.

" + "smithy.api#documentation": "

Provides detailed information about the current medical transcription job, including job\n status and, if applicable, failure reason.

" } } } @@ -4071,7 +4120,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an asynchronous job to transcribe speech to text.

", + "smithy.api#documentation": "

Transcribes the audio from a media file and applies any additional Request Parameters you \n choose to include in your request.

\n

To make a StartTranscriptionJob request, you must first upload your media file \n into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file \n using the Media parameter.

\n

You must include the following parameters in your StartTranscriptionJob \n request:

\n
    \n
  • \n

    \n region: The Amazon Web Services Region where you are making your\n request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer\n to Amazon Transcribe \n endpoints and quotas.

    \n
    • \n
  • \n

    \n TranscriptionJobName: A custom name you create for your transcription \n job that is unique within your Amazon Web Services account.

    \n
    • \n
  • \n

    \n Media (MediaFileUri): The Amazon S3 location of \n your media file.

    \n
    • \n
  • \n

    One of LanguageCode, IdentifyLanguage, or\n IdentifyMultipleLanguages: If you know the language of your media file, \n specify it using the LanguageCode parameter; you can find all valid language\n codes in the Supported languages table. \n If you don't know the languages spoken in your media, use either \n IdentifyLanguage or IdentifyMultipleLanguages and let \n Amazon Transcribe identify the languages for you.

    \n
    • \n
", "smithy.api#http": { "method": "PUT", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -4085,7 +4134,7 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the job. You can't use the strings \".\" or \"..\"\n by themselves as the job name. The name must also be unique within an Amazon Web Services\n account. If you try to create a transcription job with the same name as a previous \n transcription job, you get a ConflictException error.

", + "smithy.api#documentation": "

A unique name, chosen by you, for your transcription job. The name you specify is \n also used as the default name of your transcription output file. If you want to specify a different \n name for your transcription output, use the OutputKey parameter.

\n

This name is case sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account. If you try to create a new job with the same name as an \n existing job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4093,104 +4142,110 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language used in the input media file. You must include \n either LanguageCode or IdentifyLanguage in your \n request.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must \n be encoded at a sample rate of 16,000 Hz or higher.

" + "smithy.api#documentation": "

The language code that represents the language spoken in the input media file.

\n

If you're unsure of the language spoken in your media file, consider using \n IdentifyLanguage or IdentifyMultipleLanguages to enable \n automatic language identification.

\n

Note that you must include one of LanguageCode, \n IdentifyLanguage, or IdentifyMultipleLanguages in your \n request. If you include more than one of these parameters, your transcription job \n fails.

\n

For a list of supported languages and their associated language codes, refer to the \n Supported\n languages table.

\n \n

To transcribe speech in Modern Standard Arabic (ar-SA), your media file \n must be encoded at a sample rate of 16,000 Hz or higher.

\n " } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in the input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you \n specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases,\n you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe \n determine the sample rate.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in your input media file.

\n

If you don't specify the media sample rate, Amazon Transcribe determines it for you. If you\n specify the sample rate, it must match the rate detected by Amazon Transcribe; if there's a\n mismatch between the value you specify and the value detected, your job fails. Therefore, in most \n cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe \n determine the sample rate.

" } }, "MediaFormat": { "target": "com.amazonaws.transcribe#MediaFormat", "traits": { - "smithy.api#documentation": "

The format of the input media file.

" + "smithy.api#documentation": "

Specify the format of your input media file.

" } }, "Media": { "target": "com.amazonaws.transcribe#Media", "traits": { - "smithy.api#documentation": "

An object that describes the input media for a transcription job.

", + "smithy.api#documentation": "

Describes the Amazon S3 location of the media file you want to use in your \n request.

", "smithy.api#required": {} } }, "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The location where the transcription is stored.

\n

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the \n specified S3 bucket. When you call the GetTranscriptionJob operation, the\n operation returns this location in the TranscriptFileUri field. If you enable \n content redaction, the redacted transcript appears in\n RedactedTranscriptFileUri. If you enable content redaction and choose to \n output an unredacted transcript, that transcript's location still appears in the\n TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to \n put files in the bucket. For more information, see Permissions\n Required for IAM User Roles.

\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt \n the output of your transcription using the OutputEncryptionKMSKeyId \n parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for \n server-side encryption of transcripts that are placed in your S3 bucket.

\n

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL,\n a shareable URL that provides secure access to your transcription, and returns it in the\n TranscriptFileUri field. Use this URL to download the transcription.

" + "smithy.api#documentation": "

The name of the Amazon S3 bucket where you want your transcription output \n stored. Do not include the S3:// prefix of the specified bucket.

\n

If you want your output to go to a sub-folder of this bucket, specify it using the\n OutputKey parameter; OutputBucketName only accepts the \n name of a bucket.

\n

For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET,\n set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if \n you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set\n OutputBucketName to DOC-EXAMPLE-BUCKET and\n OutputKey to test-files/.

\n

Note that Amazon Transcribe must have permission to use the specified location. You\n can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions\n Required for IAM User Roles.

\n

If you don't specify OutputBucketName, your transcript is placed in a \n service-managed Amazon S3 bucket and you are provided with a URI to access your \n transcript.

" } }, "OutputKey": { "target": "com.amazonaws.transcribe#OutputKey", "traits": { - "smithy.api#documentation": "

You can specify a location in an Amazon S3 bucket to store the output of your transcription\n job.

\n

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in \n the Amazon S3 bucket you specified. By default, the object key is\n \"your-transcription-job-name.json\".

\n

You can use output keys to specify the Amazon S3 prefix and file name of the transcription \n output. For example, specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key would \n lead to the output being stored as \"folder1/folder2/your-transcription-job-name.json\". If you \n specify \"my-other-job-name.json\" as the output key, the object key is changed to\n \"my-other-job-name.json\". You can use an output key to change both the prefix and the file \n name, for example \"folder/my-other-job-name.json\".

\n

If you specify an output key, you must also specify an S3 bucket in the\n OutputBucketName parameter.

" + "smithy.api#documentation": "

Use in combination with OutputBucketName to specify the output location of\n your transcript and, optionally, a unique name for your output file. The default name for your \n transcription output is the same as the name you specified for your transcription job \n (TranscriptionJobName).

\n

Here are some examples of how you can use OutputKey:

\n
    \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName\n and 'my-transcript.json' as the OutputKey, your transcription output \n path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the TranscriptionJobName,\n 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and \n 'my-transcript' as the OutputKey, your transcription output path is \n s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.

    \n
    • \n
  • \n

    If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName\n and 'test-files/my-transcript.json' as the OutputKey, your transcription \n output path is \n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.

    \n
    • \n
  • \n

    If you specify 'my-first-transcription' as the TranscriptionJobName,\n 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and \n 'test-files/my-transcript' as the OutputKey, your transcription output \n path is \n s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.

    \n
    • \n
\n

If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is \n created for you.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management \n Service (KMS) key used to encrypt the output of the transcription job. The user calling the\n StartTranscriptionJob operation must have permission to use the specified\n KMS key.

\n

You can use either of the following to identify a KMS key in the current account:

\n
    \n
  • \n

    KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    KMS Key Alias: \"alias/ExampleAlias\"

    \n
    • \n
\n

You can use either of the following to identify a KMS key in the current account or \n another account:

\n
    \n
  • \n

    Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:region:account\n ID:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    \n
    • \n
  • \n

    ARN of a KMS Key Alias: \"arn:aws:kms:region:account-ID:alias/ExampleAlias\"

    \n
    • \n
\n

If you don't specify an encryption key, the output of the transcription job is encrypted \n with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output location\n in the OutputBucketName parameter.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your transcription output.

\n

If using a key located in the current \n Amazon Web Services account, you can specify your KMS key in one of \n four ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example, \n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For \n example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example, \n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different \n Amazon Web Services account than the current Amazon Web Services account, you can \n specify your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example, \n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

If you don't specify an encryption key, your output is encrypted with the default \n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify \n an output location using the OutputLocation parameter.

\n

Note that the user making the \n request must have permission to use the specified KMS key.

" } }, "KMSEncryptionContext": { "target": "com.amazonaws.transcribe#KMSEncryptionContextMap", "traits": { - "smithy.api#documentation": "

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that \n provide an added layer of security for your data.

" + "smithy.api#documentation": "

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that \n provide an added layer of security for your data. For more information, see \n KMS \n encryption context and Asymmetric keys in \n KMS.

" } }, "Settings": { "target": "com.amazonaws.transcribe#Settings", "traits": { - "smithy.api#documentation": "

A Settings object that provides optional settings for a transcription \n job.

" + "smithy.api#documentation": "

Specify additional optional settings in your \n request, including channel identification, alternative transcriptions, speaker labeling; allows \n you to apply custom vocabularies and vocabulary filters.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with \n your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.

\n

If you're using automatic language identification with your request and want to include a\n custom language model, a custom vocabulary, or a custom vocabulary filter, use instead the \n parameter with the\n LanguageModelName, VocabularyName \n or VocabularyFilterName sub-parameters.

" } }, "ModelSettings": { "target": "com.amazonaws.transcribe#ModelSettings", "traits": { - "smithy.api#documentation": "

Choose the custom language model you use for your transcription job in this \n parameter.

" + "smithy.api#documentation": "

Specify the custom language model you want to include with your transcription job. If you \n include ModelSettings in your request, you must include the \n LanguageModelName sub-parameter.

\n

For more information, see Custom language \n models.

" } }, "JobExecutionSettings": { "target": "com.amazonaws.transcribe#JobExecutionSettings", "traits": { - "smithy.api#documentation": "

Provides information about how a transcription job is executed. Use this field to indicate\n that the job can be queued for deferred execution if the concurrency limit is reached and\n there are no slots available to immediately run the job.

" + "smithy.api#documentation": "

Allows you to control how your transcription job is processed. Currently, the only\n JobExecutionSettings modification you can choose is enabling job queueing using \n the AllowDeferredExecution sub-parameter.

\n

If you include JobExecutionSettings in your request, you must also include\n the sub-parameters: AllowDeferredExecution and \n DataAccessRoleArn.

" } }, "ContentRedaction": { "target": "com.amazonaws.transcribe#ContentRedaction", "traits": { - "smithy.api#documentation": "

An object that contains the request parameters for content redaction.

" + "smithy.api#documentation": "

Allows you to redact or flag specified personally identifiable information (PII) in your transcript. If \n you use ContentRedaction, you must also include the sub-parameters:\n PiiEntityTypes, RedactionOutput, and \n RedactionType.

" } }, "IdentifyLanguage": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Set this field to true to enable automatic language identification. \n Automatic language identification is disabled by default. You receive a\n BadRequestException error if you enter a value for a\n LanguageCode.

\n

You must include either LanguageCode or \n IdentifyLanguage in your request.

" + "smithy.api#documentation": "

Enables automatic language identification in your transcription job request.

\n

If you include IdentifyLanguage, you can optionally include a list of \n language codes, using LanguageOptions, that you think may be present in \n your media file. Including language options can improve transcription accuracy.

\n

If you want to apply a custom language model, a custom vocabulary, or a custom \n vocabulary filter to your automatic language identification request, include\n LanguageIdSettings with the relevant sub-parameters \n (VocabularyName, LanguageModelName, and \n VocabularyFilterName).

\n

Note that you must include one of LanguageCode, \n IdentifyLanguage, or IdentifyMultipleLanguages in your \n request. If you include more than one of these parameters, your transcription job \n fails.

" + } + }, + "IdentifyMultipleLanguages": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Enables automatic multi-language identification in your transcription job request. Use this\n parameter if your media file contains more than one language.

\n

If you include IdentifyMultipleLanguages, you can optionally include a list \n of language codes, using LanguageOptions, that you think may be present in \n your media file. Including language options can improve transcription accuracy.

\n

If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic\n language identification request, include LanguageIdSettings with the relevant\n sub-parameters (VocabularyName and \n VocabularyFilterName).

\n

Note that you must include one of LanguageCode, \n IdentifyLanguage, or IdentifyMultipleLanguages in your \n request. If you include more than one of these parameters, your transcription job fails.

" } }, "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

An object containing a list of languages that might be present in your collection of \n audio files. Automatic language identification chooses a language that best matches the \n source audio from that list.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must \n be encoded at a sample rate of 16,000 Hz or higher.

" + "smithy.api#documentation": "

You can specify two or more language codes that represent the languages you think may \n be present in your media; including more than five is not recommended. If you're unsure what\n languages are present, do not include this parameter.

\n

If you include LanguageOptions in your request, you must also include \n IdentifyLanguage.

\n

For more information, refer to Supported languages.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your media file \n must be encoded at a sample rate of 16,000 Hz or higher.

" } }, "Subtitles": { "target": "com.amazonaws.transcribe#Subtitles", "traits": { - "smithy.api#documentation": "

Add subtitles to your batch transcription job.

" + "smithy.api#documentation": "

Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and SubRip\n (*.srt) formats.

" } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

Add tags to an Amazon Transcribe transcription job.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new transcription \n job at the time you start this new job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" } }, "LanguageIdSettings": { "target": "com.amazonaws.transcribe#LanguageIdSettingsMap", "traits": { - "smithy.api#documentation": "

The language identification settings associated with your transcription job. These \n settings include VocabularyName, VocabularyFilterName, \n and LanguageModelName.

" + "smithy.api#documentation": "

If using automatic language identification (IdentifyLanguage) in your request \n and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary\n filter, include LanguageIdSettings with the relevant sub-parameters \n (VocabularyName, LanguageModelName, and \n VocabularyFilterName).

\n

You can specify two or more language codes that represent the languages you think may be \n present in your media; including more than five is not recommended. Each language code you \n include can have an associated custom language model, custom vocabulary, and custom \n vocabulary filter. The languages you specify must match the languages of the specified custom\n language models, custom vocabularies, and custom vocabulary filters.

\n

To include language options using IdentifyLanguage \n without including a custom language model, a custom \n vocabulary, or a custom vocabulary filter, use LanguageOptions instead of\n LanguageIdSettings. Including language options can improve the accuracy of \n automatic language identification.

\n

If you want to include a custom language model with your request but \n do not want to use automatic language identification,\n use instead the parameter with the\n LanguageModelName sub-parameter.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with\n your request but do not want to use automatic \n language identification, use instead the \n parameter with the VocabularyName or \n VocabularyFilterName (or both) sub-parameter.

" } } } @@ -4201,7 +4256,7 @@ "TranscriptionJob": { "target": "com.amazonaws.transcribe#TranscriptionJob", "traits": { - "smithy.api#documentation": "

Provides information about your asynchronous transcription job.

" + "smithy.api#documentation": "

Provides detailed information about the current transcription job, including job status\n and, if applicable, failure reason.

" } } } @@ -4263,18 +4318,18 @@ "Formats": { "target": "com.amazonaws.transcribe#SubtitleFormats", "traits": { - "smithy.api#documentation": "

Specify the output format for your subtitle file; if you select both srt and\n vtt formats, two output files are generated.

" + "smithy.api#documentation": "

Specify the output format for your subtitle file; if you select both WebVTT \n (vtt) and SubRip (srt) formats, two output files are \n generated.

" } }, "OutputStartIndex": { "target": "com.amazonaws.transcribe#SubtitleOutputStartIndex", "traits": { - "smithy.api#documentation": "

Defines the starting value that is assigned to the first subtitle segment.

\n

The default start index for Amazon Transcribe is 0, which differs from\n the more widely used standard of 1. If you're uncertain which value to use,\n we recommend choosing 1, as this may improve compatibility with other\n services.

" + "smithy.api#documentation": "

Specify the starting value that is assigned to the first subtitle segment.

\n

The default start index for Amazon Transcribe is 0, which differs from\n the more widely used standard of 1. If you're uncertain which value to use,\n we recommend choosing 1, as this may improve compatibility with other\n services.

" } } }, "traits": { - "smithy.api#documentation": "

Generate subtitles for your batch transcription job. Note that your subtitle files are\n placed in the same location as your transcription output.

" + "smithy.api#documentation": "

Generate subtitles for your media file with your transcription request.

\n

You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or\n both) as your output format.

\n

Note that your subtitle files are placed in the same location as your transcription \n output.

" } }, "com.amazonaws.transcribe#SubtitlesOutput": { @@ -4283,24 +4338,24 @@ "Formats": { "target": "com.amazonaws.transcribe#SubtitleFormats", "traits": { - "smithy.api#documentation": "

The format of your subtitle files. If your request specified both srt and\n vtt formats, both formats are shown.

" + "smithy.api#documentation": "

Provides the format of your subtitle files. If your request included both WebVTT \n (vtt) and SubRip (srt) formats, both formats are \n shown.

" } }, "SubtitleFileUris": { "target": "com.amazonaws.transcribe#SubtitleFileUris", "traits": { - "smithy.api#documentation": "

Contains the output location for your subtitle file. This location must be an S3 \n bucket.

" + "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or \n download your subtitle file. Your subtitle file is stored in the same location as your \n transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are \n provided.

\n

If you included OutputBucketName in your transcription job request, this is\n the URI of that bucket. If you also included OutputKey in your request, your \n output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your subtitle file is stored in a service-managed bucket, and TranscriptFileUri\n provides you with a temporary URI you can use for secure access to your subtitle file.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 \n minutes. If you get an AccesDenied error, you can get a new temporary \n URI by running a GetTranscriptionJob or \n ListTranscriptionJob request.

\n " } }, "OutputStartIndex": { "target": "com.amazonaws.transcribe#SubtitleOutputStartIndex", "traits": { - "smithy.api#documentation": "

Shows the output start index value for your subtitle files. If you did not specify a value\n in your request, the default value of 0 is used.

" + "smithy.api#documentation": "

Provides the start index value for your subtitle files. If you did not specify a value\n in your request, the default value of 0 is used.

" } } }, "traits": { - "smithy.api#documentation": "

The S3 location where your subtitle files are located. Note that your subtitle files are\n placed in the same location as your transcription output. Refer to\n TranscriptFileUri to download your files.

" + "smithy.api#documentation": "

Provides information about your subtitle file, including format, start index, and\n Amazon S3 location.

" } }, "com.amazonaws.transcribe#Tag": { @@ -4309,20 +4364,20 @@ "Key": { "target": "com.amazonaws.transcribe#TagKey", "traits": { - "smithy.api#documentation": "

The first part of a key:value pair that forms a tag associated with a given resource. For\n example, in the tag ‘Department’:’Sales’, the key is 'Department'.

", + "smithy.api#documentation": "

The first part of a key:value pair that forms a tag associated with a given resource. For\n example, in the tag Department:Sales, the key is 'Department'.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.transcribe#TagValue", "traits": { - "smithy.api#documentation": "

The second part of a key:value pair that forms a tag associated with a given resource.\n For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.

", + "smithy.api#documentation": "

The second part of a key:value pair that forms a tag associated with a given resource.\n For example, in the tag Department:Sales, the value is 'Sales'.

\n

Note that you can set the value of a tag to an empty string, but you can't set the value of a\n tag to null. Omitting the tag value is the same as using an empty string.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag \n with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use\n by your organization's sales department.

" + "smithy.api#documentation": "

Adds metadata, in the form of a key:value pair, to the specified resource.

\n

For example, you could add the tag Department:Sales to a \n resource to indicate that it pertains to your organization's sales department. You can also use \n tags for tag-based access control.

\n

To learn more about tagging, see Tagging resources.

" } }, "com.amazonaws.transcribe#TagKey": { @@ -4384,7 +4439,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tags an Amazon Transcribe resource with the given list of tags.

", + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the specified \n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

", "smithy.api#http": { "method": "PUT", "uri": "/tags/{ResourceArn}", @@ -4398,7 +4453,7 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag. ARNs have \n the format arn:partition:service:region:account-id:resource-type/resource-id \n (for example, \n arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). \n Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary, \n medical-vocabulary, vocabulary-filter, and \n language-model.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example, \n arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary, \n medical-vocabulary, vocabulary-filter, and \n language-model.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4406,7 +4461,7 @@ "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

The tags you are assigning to a given Amazon Transcribe resource.

", + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to the specified \n resource.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

", "smithy.api#required": {} } } @@ -4449,7 +4504,7 @@ "name": "transcribe" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Operations and objects for transcribing speech to text.

", + "smithy.api#documentation": "

Amazon Transcribe offers three main types of batch transcription: \n Standard, Medical, and\n Call Analytics.

\n
    \n
  • \n

    \n Standard transcriptions are the most common \n option. Refer to for details.

    \n
    • \n
  • \n

    \n Medical transcriptions are tailored to medical\n professionals and incorporate medical terms. A common use case for this service is \n transcribing doctor-patient dialogue into after-visit notes. Refer to \n for details.

    \n
    • \n
  • \n

    \n Call Analytics transcriptions are designed for use \n with call center audio on two different channels; if you're looking for insight into customer\n service calls, use this option. Refer to for \n details.

    \n
    • \n
", "smithy.api#title": "Amazon Transcribe Service" }, "version": "2017-10-26", @@ -4589,18 +4644,18 @@ "TranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the transcript.

\n

Use this URI to access the transcript. If you specified an S3 bucket in the\n OutputBucketName field when you created the job, this is the URI of that \n bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides \n secure access to that location.

" + "smithy.api#documentation": "

The Amazon S3 location of your transcript. You can use this URI to access or \n download your transcript.

\n

If you included OutputBucketName in your transcription job request, this is\n the URI of that bucket. If you also included OutputKey in your request, your \n output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and TranscriptFileUri\n provides you with a temporary URI you can use for secure access to your transcript.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 \n minutes. If you get an AccesDenied error, you can get a new temporary \n URI by running a GetTranscriptionJob or \n ListTranscriptionJob request.

\n " } }, "RedactedTranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the redacted transcript.

\n

Use this URI to access the redacted transcript. If you specified an S3 bucket in the \n OutputBucketName field when you created the job, this is the URI of that \n bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides \n secure access to that location.

" + "smithy.api#documentation": "

The Amazon S3 location of your redacted transcript. You can use this URI to access\n or download your transcript.

\n

If you included OutputBucketName in your transcription job request, this is\n the URI of that bucket. If you also included OutputKey in your request, your \n output is located in the path you specified in your request.

\n

If you didn't include OutputBucketName in your transcription job request,\n your transcript is stored in a service-managed bucket, and \n RedactedTranscriptFileUri provides you with a temporary URI you can use for \n secure access to your transcript.

\n \n

Temporary URIs for service-managed Amazon S3 buckets are only valid for 15 \n minutes. If you get an AccesDenied error, you can get a new temporary \n URI by running a GetTranscriptionJob or \n ListTranscriptionJob request.

\n " } } }, "traits": { - "smithy.api#documentation": "

Identifies the location of a transcription.

" + "smithy.api#documentation": "

Provides you with the Amazon S3 URI you can use to access your transcript.

" } }, "com.amazonaws.transcribe#TranscriptFilter": { @@ -4609,44 +4664,44 @@ "TranscriptFilterType": { "target": "com.amazonaws.transcribe#TranscriptFilterType", "traits": { - "smithy.api#documentation": "

Matches the phrase to the transcription output in a word\n for word fashion. For example, if you specify the phrase \"I want to speak to the manager.\"\n Amazon Transcribe attempts to match that specific phrase to the transcription.

", + "smithy.api#documentation": "

Flag the presence or absence of an exact match to the phrases you specify. For example, if you\n specify the phrase \"speak to a manager\" as your Targets value, only that exact\n phrase is flagged.

\n

Note that semantic matching is not supported. For example, if your customer says \"speak to \n the manager\", instead of \"speak to a\n manager\", your content is not flagged.

", "smithy.api#required": {} } }, "AbsoluteTimeRange": { "target": "com.amazonaws.transcribe#AbsoluteTimeRange", "traits": { - "smithy.api#documentation": "

A time range, set in seconds, between two points in the call.

" + "smithy.api#documentation": "

Allows you to specify a time range (in milliseconds) in your audio, during which you want to\n search for the specified key words or phrases. See \n for more detail.

" } }, "RelativeTimeRange": { "target": "com.amazonaws.transcribe#RelativeTimeRange", "traits": { - "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where you would \n like to apply a filter. For example, you can specify the first half of the call. You can also \n specify the period of time between halfway through to three-quarters of the way through \n the call. Because the length of conversation can vary between calls, you can apply relative\n time ranges across all calls.

" + "smithy.api#documentation": "

Allows you to specify a time range (in percentage) in your media file, during which you\n want to search for the specified key words or phrases. See \n for more detail.

" } }, "ParticipantRole": { "target": "com.amazonaws.transcribe#ParticipantRole", "traits": { - "smithy.api#documentation": "

Determines whether the customer or the agent is speaking the phrases that you've\n specified.

" + "smithy.api#documentation": "

Specify the participant you want to flag. Omitting this parameter is equivalent to specifying\n both participants.

" } }, "Negate": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

If TRUE, the rule that you specify is applied to everything except for the \n phrases that you specify.

" + "smithy.api#documentation": "

Set to TRUE to flag the absence of the phrase you specified in your request.\n Set to FALSE to flag the presence of the phrase you specified in your request.

" } }, "Targets": { "target": "com.amazonaws.transcribe#StringTargetList", "traits": { - "smithy.api#documentation": "

The phrases that you're specifying for the transcript filter to match.

", + "smithy.api#documentation": "

Specify the phrases you want to flag.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Matches the output of the transcription to either the specific phrases that you specify, \n or the intent of the phrases that you specify.

" + "smithy.api#documentation": "

Flag the presence or absence of specific words or phrases detected in your Call Analytics \n transcription output.

\n

Rules using TranscriptFilter are designed to match:

\n
    \n
  • \n

    Custom words or phrases spoken by the agent, the customer, or both

    \n
    • \n
  • \n

    Custom words or phrases not spoken by the \n agent, the customer, or either

    \n
    • \n
  • \n

    Custom words or phrases that occur at a specific time frame

    \n
    • \n
\n

See Rule\n criteria for examples.

" } }, "com.amazonaws.transcribe#TranscriptFilterType": { @@ -4666,25 +4721,25 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the transcription job.

" + "smithy.api#documentation": "

The name of the transcription job. Job names are case sensitive and must be unique \n within an Amazon Web Services account.

" } }, "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

The status of the transcription job.

" + "smithy.api#documentation": "

Provides the status of the specified transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the results\n at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If the status is \n FAILED, FailureReason provides details on why your transcription\n job failed.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the input speech.

" + "smithy.api#documentation": "

The language code used to create your transcription job. For a list of supported languages\n and their associated language codes, refer to the Supported languages\n table.

\n

Note that you must include one of LanguageCode, \n IdentifyLanguage, or IdentifyMultipleLanguages in your \n request. If you include more than one of these parameters, your transcription job \n fails.

" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz (Hz), of the audio track in the input media file.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in your input media file.

" } }, "MediaFormat": { @@ -4696,102 +4751,114 @@ "Media": { "target": "com.amazonaws.transcribe#Media", "traits": { - "smithy.api#documentation": "

An object that describes the input media for the transcription job.

" + "smithy.api#documentation": "

Describes the Amazon S3 location of the media file you want to use in your \n request.

" } }, "Transcript": { "target": "com.amazonaws.transcribe#Transcript", "traits": { - "smithy.api#documentation": "

An object that describes the output of the transcription job.

" + "smithy.api#documentation": "

Provides you with the Amazon S3 URI you can use to access your transcript.

" } }, "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job started processing.

" + "smithy.api#documentation": "

The date and time the specified transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job was created.

" + "smithy.api#documentation": "

The date and time the specified transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job completed.

" + "smithy.api#documentation": "

The date and time the specified transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, this field \n contains information about why the job failed.

\n

The FailureReason field can contain one of the following values:

\n
    \n
  • \n

    \n Unsupported media format - The media format specified in the\n MediaFormat field of the request isn't valid. See the description of the\n MediaFormat field for a list of valid values.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media \n format - The media format of the audio file doesn't match the format specified \n in the MediaFormat field in the request. Check the media format of \n your media file and make sure that the two values match.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file - The sample rate specified in the \n MediaSampleRateHertz of the request isn't valid. The sample rate must \n be between 8,000 and 48,000 Hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample \n rate - The sample rate in the audio file doesn't match the sample rate \n specified in the MediaSampleRateHertz field in the request. Check\n the sample rate of your media file and make sure that the two values match.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large - The size of your audio file is \n larger than Amazon Transcribe can process. For more information, see Limits in the\n Amazon Transcribe Developer Guide.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large - Your \n audio contains more channels than Amazon Transcribe is configured to process. To request additional\n channels, see Amazon\n Transcribe Limits in the Amazon Web Services General\n Reference.

    \n
    • \n
" + "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED, \n FailureReason contains information about why the transcription job request\n failed.

\n

The FailureReason field contains one of the following values:

\n
    \n
  • \n

    \n Unsupported media format.

    \n

    The media format specified in MediaFormat isn't valid. Refer to\n MediaFormat for a list of supported formats.

    \n
    • \n
  • \n

    \n The media format provided does not match the detected media \n format.

    \n

    The media format specified in MediaFormat doesn't match the \n format of the input file. Check the media format of your media file and correct the \n specified value.

    \n
    • \n
  • \n

    \n Invalid sample rate for audio file.

    \n

    The sample rate specified in MediaSampleRateHertz isn't valid.\n The sample rate must be between 8,000 and 48,000 Hertz.

    \n
    • \n
  • \n

    \n The sample rate provided does not match the detected sample \n rate.

    \n

    The sample rate specified in MediaSampleRateHertz doesn't \n match the sample rate detected in your input media file. Check the sample rate of \n your media file and correct the specified value.

    \n
    • \n
  • \n

    \n Invalid file size: file size too large.

    \n

    The size of your media file is larger than what Amazon Transcribe can process. \n For more information, refer to Guidelines and\n quotas.

    \n
    • \n
  • \n

    \n Invalid number of channels: number of channels too large.

    \n

    Your audio contains more channels than Amazon Transcribe is able to process. \n For more information, refer to Guidelines and \n quotas.

    \n
    • \n
" } }, "Settings": { "target": "com.amazonaws.transcribe#Settings", "traits": { - "smithy.api#documentation": "

Optional settings for the transcription job. Use these settings to turn on speaker \n recognition, to set the maximum number of speakers that should be identified and to specify \n a custom vocabulary to use when processing the transcription job.

" + "smithy.api#documentation": "

Specify additional optional settings in your \n request, including channel identification, alternative transcriptions, speaker labeling; allows you\n to apply custom vocabularies and vocabulary filters.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with \n your request but do not want to use automatic\n language identification, use Settings with the VocabularyName\n or VocabularyFilterName (or both) sub-parameter.

\n

If you're using automatic language identification with your request and want to include a\n custom language model, a custom vocabulary, or a custom vocabulary filter, do not use the \n Settings parameter; use instead the \n \n parameter with the LanguageModelName, VocabularyName \n or VocabularyFilterName sub-parameters.

" } }, "ModelSettings": { "target": "com.amazonaws.transcribe#ModelSettings", "traits": { - "smithy.api#documentation": "

An object containing the details of your custom language model.

" + "smithy.api#documentation": "

The custom language model you want to include with your transcription job. If you include\n ModelSettings in your request, you must include the \n LanguageModelName sub-parameter.

" } }, "JobExecutionSettings": { "target": "com.amazonaws.transcribe#JobExecutionSettings", "traits": { - "smithy.api#documentation": "

Provides information about how a transcription job is executed.

" + "smithy.api#documentation": "

Provides information about how your transcription job is being processed. This parameter shows \n if your request is queued and what data access role is being used.

" } }, "ContentRedaction": { "target": "com.amazonaws.transcribe#ContentRedaction", "traits": { - "smithy.api#documentation": "

An object that describes content redaction settings for the transcription job.

" + "smithy.api#documentation": "

Redacts or flags specified personally identifiable information (PII) in your transcript.

" } }, "IdentifyLanguage": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

A value that shows if automatic language identification was enabled for a transcription \n job.

" + "smithy.api#documentation": "

Indicates whether automatic language identification was enabled (TRUE)\n for the specified transcription job.

" + } + }, + "IdentifyMultipleLanguages": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether automatic multi-language identification was enabled \n (TRUE) for the specified transcription job.

" } }, "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

An object that shows the optional array of languages inputted for transcription jobs with\n automatic language identification enabled.

" + "smithy.api#documentation": "

You can specify two or more language codes that represent the languages you think may \n be present in your media; including more than five is not recommended. If you're unsure what\n languages are present, do not include this parameter.

\n

If you include LanguageOptions in your request, you must also include \n IdentifyLanguage.

\n

For more information, refer to Supported languages.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your media file \n must be encoded at a sample rate of 16,000 Hz or higher.

" } }, "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language that it identified in\n the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it\n identified.

" + "smithy.api#documentation": "

The confidence score associated with the language identified in your media file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher \n probability that the identified language correctly matches the language spoken in your\n media.

" + } + }, + "LanguageCodes": { + "target": "com.amazonaws.transcribe#LanguageCodeList", + "traits": { + "smithy.api#documentation": "

The language codes used to create your transcription job. This parameter is used with\n multi-language identification. For single-language identification requests, refer to the singular \n version of this parameter, LanguageCode.

\n

For a list of supported languages and their associated language codes, refer to the \n Supported languages\n table.

" } }, "Tags": { "target": "com.amazonaws.transcribe#TagList", "traits": { - "smithy.api#documentation": "

A key:value pair assigned to a given transcription job.

" + "smithy.api#documentation": "

Adds one or more custom tags, each in the form of a key:value pair, to a new transcription\n job at the time you start this new job.

\n

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

" } }, "Subtitles": { "target": "com.amazonaws.transcribe#SubtitlesOutput", "traits": { - "smithy.api#documentation": "

Generate subtitles for your batch transcription job.

" + "smithy.api#documentation": "

Generate subtitles for your media file with your transcription request.

" } }, "LanguageIdSettings": { "target": "com.amazonaws.transcribe#LanguageIdSettingsMap", "traits": { - "smithy.api#documentation": "

Language-specific settings that can be specified when language identification is enabled\n for your transcription job. These settings include VocabularyName,\n VocabularyFilterName, and LanguageModelName.

" + "smithy.api#documentation": "

If using automatic language identification (IdentifyLanguage) in your request \n and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary\n filter, include LanguageIdSettings with the relevant sub-parameters \n (VocabularyName, LanguageModelName, and \n VocabularyFilterName).

\n

You can specify two or more language codes that represent the languages you think may be \n present in your media; including more than five is not recommended. Each language code you\n include can have an associated custom language model, custom vocabulary, and custom \n vocabulary filter. The languages you specify must match the languages of the specified custom\n language models, custom vocabularies, and custom vocabulary filters.

\n

To include language options using IdentifyLanguage \n without including a custom language model, a custom \n vocabulary, or a custom vocabulary filter, use LanguageOptions instead of\n LanguageIdSettings. Including language options can improve the accuracy of \n automatic language identification.

\n

If you want to include a custom language model with your request but \n do not want to use automatic language identification,\n use instead the parameter with the\n LanguageModelName sub-parameter.

\n

If you want to include a custom vocabulary or a custom vocabulary filter (or both) with\n your request but do not want to use automatic \n language identification, use instead the \n parameter with the VocabularyName or \n VocabularyFilterName (or both) sub-parameter.

" } } }, "traits": { - "smithy.api#documentation": "

Describes an asynchronous transcription job that was created with the \n StartTranscriptionJob operation.

" + "smithy.api#documentation": "

Provides detailed information about a transcription job.

\n

To view the status of the specified transcription job, check the \n TranscriptionJobStatus field. If the status is COMPLETED, the \n job is finished and you can find the results at the location specified in\n TranscriptFileUri. If the status is FAILED, \n FailureReason provides details on why your transcription job failed.

\n

If you enabled content redaction, the redacted transcript\n can be found at the location specified in RedactedTranscriptFileUri.

" } }, "com.amazonaws.transcribe#TranscriptionJobName": { @@ -4839,49 +4906,49 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the transcription job.

" + "smithy.api#documentation": "

The name of the transcription job. Job names are case sensitive and must be unique \n within an Amazon Web Services account.

" } }, "CreationTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job was created.

" + "smithy.api#documentation": "

The date and time the specified transcription job request was made.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job started processing.

" + "smithy.api#documentation": "

The date and time your transcription job began processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job\n that started processing at 12:32 PM UTC-7 on May 4, 2022.

" } }, "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job was completed.

" + "smithy.api#documentation": "

The date and time the specified transcription job finished processing.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job\n that started processing at 12:33 PM UTC-7 on May 4, 2022.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the input speech.

" + "smithy.api#documentation": "

The language code used to create your transcription.

" } }, "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

The status of the transcription job. When the status is COMPLETED,\n use the GetTranscriptionJob operation to get the results of the \n transcription.

" + "smithy.api#documentation": "

Provides the status of your transcription job.

\n

If the status is COMPLETED, the job is finished and you can find the results\n at the location specified in TranscriptFileUri (or\n RedactedTranscriptFileUri, if you requested transcript redaction). If the status is \n FAILED, FailureReason provides details on why your transcription\n job failed.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, a \n description of the error.

" + "smithy.api#documentation": "

If TranscriptionJobStatus is FAILED,\n FailureReason contains information about why the transcription job \n failed. See also: Common Errors.

" } }, "OutputLocationType": { "target": "com.amazonaws.transcribe#OutputLocationType", "traits": { - "smithy.api#documentation": "

Indicates the location of the output of the transcription job.

\n

If the value is CUSTOMER_BUCKET then the location is the S3 bucket\n specified in the outputBucketName field when the transcription job was \n started with the StartTranscriptionJob operation.

\n

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and \n can be retrieved using the URI in the GetTranscriptionJob response's\n TranscriptFileUri field.

" + "smithy.api#documentation": "

Indicates where the specified transcription output is stored.

\n

If the value is CUSTOMER_BUCKET, the location is the Amazon S3\n bucket you specified using the OutputBucketName parameter in your \n request. If you also included \n OutputKey in your request, your output is located in the path you specified in your\n request.

\n

If the value is SERVICE_BUCKET, the location is a service-managed \n Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use\n the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri \n field.

" } }, "ContentRedaction": { @@ -4896,18 +4963,30 @@ "IdentifyLanguage": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Whether automatic language identification was enabled for a transcription job.

" + "smithy.api#documentation": "

Indicates whether automatic language identification was enabled (TRUE)\n for the specified transcription job.

" + } + }, + "IdentifyMultipleLanguages": { + "target": "com.amazonaws.transcribe#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether automatic multi-language identification was enabled \n (TRUE) for the specified transcription job.

" } }, "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language it identified in \n the source audio. A higher score indicates that Amazon Transcribe is more confident in the language it\n identified.

" + "smithy.api#documentation": "

The confidence score associated with the language identified in your media file.

\n

Confidence scores are values between 0 and 1; a larger value indicates a higher \n probability that the identified language correctly matches the language spoken in your\n media.

" + } + }, + "LanguageCodes": { + "target": "com.amazonaws.transcribe#LanguageCodeList", + "traits": { + "smithy.api#documentation": "

The language codes used to create your transcription job. This parameter is used with\n multi-language identification. For single-language identification, the singular version of this \n parameter, LanguageCode, is present.

" } } }, "traits": { - "smithy.api#documentation": "

Provides a summary of information about a transcription job.

" + "smithy.api#documentation": "

Provides detailed information about a specific transcription job.

" } }, "com.amazonaws.transcribe#Type": { @@ -4951,7 +5030,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes specified tags from a specified Amazon Transcribe resource.

", + "smithy.api#documentation": "

Removes the specified tags from the specified Amazon Transcribe resource.

\n

If you include UntagResource in your request, you must also include \n ResourceArn and TagKeys.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{ResourceArn}", @@ -4965,7 +5044,7 @@ "ResourceArn": { "target": "com.amazonaws.transcribe#TranscribeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags\n from. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id (for example,\n arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name). \n Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary, \n medical-vocabulary, vocabulary-filter, and \n language-model.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove\n tags from. ARNs have the format\n arn:partition:service:region:account-id:resource-type/resource-id.

\n

For example, \n arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name.

\n

Valid values for resource-type are: transcription-job,\n medical-transcription-job, vocabulary, \n medical-vocabulary, vocabulary-filter, and \n language-model.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4973,7 +5052,7 @@ "TagKeys": { "target": "com.amazonaws.transcribe#TagKeyList", "traits": { - "smithy.api#documentation": "

A list of tag keys you want to remove from a specified Amazon Transcribe resource.

", + "smithy.api#documentation": "

Removes the specified tag keys from the specified Amazon Transcribe resource.

", "smithy.api#required": {} } } @@ -5009,7 +5088,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the call analytics category with new values. The\n UpdateCallAnalyticsCategory operation overwrites all of the existing \n information with the values that you provide in the request.

", + "smithy.api#documentation": "

Updates the specified Call Analytics category with new rules. Note that the\n UpdateCallAnalyticsCategory operation overwrites all existing rules contained in \n the specified category. You cannot append additional rules onto an existing category.

\n

To create a new category, see .

", "smithy.api#http": { "method": "PATCH", "uri": "/callanalyticscategories/{CategoryName}", @@ -5023,7 +5102,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

The name of the analytics category to update. The name is case sensitive. If you try\n to update a call analytics category with the same name as a previous category you will \n receive a ConflictException error.

", + "smithy.api#documentation": "

The name of the Call Analytics category you want to update. Category names are case\n sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5031,7 +5110,7 @@ "Rules": { "target": "com.amazonaws.transcribe#RuleList", "traits": { - "smithy.api#documentation": "

The rules used for the updated analytics category. The rules that you provide in this \n field replace the ones that are currently being used.

", + "smithy.api#documentation": "

The rules used for the updated Call Analytics category. The rules you provide in this field\n replace the ones that are currently being used in the specified category.

", "smithy.api#required": {} } } @@ -5043,7 +5122,7 @@ "CategoryProperties": { "target": "com.amazonaws.transcribe#CategoryProperties", "traits": { - "smithy.api#documentation": "

The attributes describing the analytics category. You can see information such as the \n rules that you've used to update the category and when the category was originally \n created.

" + "smithy.api#documentation": "

Provides you with the properties of the Call Analytics category you specified in your\n UpdateCallAnalyticsCategory request.

" } } } @@ -5074,7 +5153,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a vocabulary with new values that you provide in a different text file from\n the one you used to create the vocabulary. The UpdateMedicalVocabulary \n operation overwrites all of the existing information with the values that you provide in the\n request.

", + "smithy.api#documentation": "

Updates an existing custom medical vocabulary with new values. This operation overwrites\n all existing information with your new values; you cannot append new terms onto an existing\n vocabulary.

", "smithy.api#http": { "method": "PATCH", "uri": "/medicalvocabularies/{VocabularyName}", @@ -5088,7 +5167,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to update. The name is case sensitive. If you try to update\n a vocabulary with the same name as a vocabulary you've already made, you get a\n ConflictException error.

", + "smithy.api#documentation": "

The name of the custom medical vocabulary you want to update. Vocabulary names are\n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5096,14 +5175,14 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the language used for the entries in the updated vocabulary. \n U.S. English (en-US) is the only valid language code in Amazon Transcribe Medical.

", + "smithy.api#documentation": "

The language code that represents the language of the entries in the custom vocabulary \n you want to update. US English (en-US) is the only language supported with \n Amazon Transcribe Medical.

", "smithy.api#required": {} } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must\n be in the same Amazon Web Services Region as the resource that you are calling. The following\n is the format for a URI:

\n

\n https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey\n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

\n

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom\n Vocabularies.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom medical \n vocabulary. The URI must be located in the same Amazon Web Services Region as the resource \n you're calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

" } } } @@ -5114,25 +5193,25 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the updated vocabulary.

" + "smithy.api#documentation": "

The name of the updated custom medical vocabulary.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language of the text file used to update the custom \n vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The language code you selected for your medical vocabulary. US English \n (en-US) is the only language supported with Amazon Transcribe Medical.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary was updated.

" + "smithy.api#documentation": "

The date and time the specified custom medical vocabulary was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the update to the vocabulary. When the \n VocabularyState field is READY, the vocabulary is ready to \n be used in a StartMedicalTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of your custom medical vocabulary. If the state is \n READY, you can use the vocabulary in a \n StartMedicalTranscriptionJob request.

" } } } @@ -5163,7 +5242,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an existing vocabulary with new values. The \n UpdateVocabulary operation overwrites all of the existing information with\n the values that you provide in the request.

", + "smithy.api#documentation": "

Updates an existing custom vocabulary with new values. This operation overwrites all existing\n information with your new values; you cannot append new terms onto an existing vocabulary.

", "smithy.api#http": { "method": "PATCH", "uri": "/vocabularies/{VocabularyName}", @@ -5194,7 +5273,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a vocabulary filter with a new list of filtered words.

", + "smithy.api#documentation": "

Updates an existing custom vocabulary filter with a new list of words. The new list you provide\n overwrites all previous entries; you cannot append new terms onto an existing vocabulary \n filter.

", "smithy.api#http": { "method": "PUT", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -5208,7 +5287,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter to update. If you try to update a vocabulary filter with\n the same name as another vocabulary filter, you get a ConflictException \n error.

", + "smithy.api#documentation": "

The name of the custom vocabulary filter you want to update. Vocabulary filter names \n are case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5216,13 +5295,13 @@ "Words": { "target": "com.amazonaws.transcribe#Words", "traits": { - "smithy.api#documentation": "

The words to use in the vocabulary filter. Only use characters from the character \n set defined for custom vocabularies. For a list of character sets, see \n Character\n Sets for Custom Vocabularies.

\n

If you provide a list of words in the Words parameter, you can't use the \n VocabularyFilterFileUri parameter.

" + "smithy.api#documentation": "

Use this parameter if you want to update your vocabulary filter by including all desired terms, \n as comma-separated values, within your request. The other option for updating your vocabulary \n filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then\n specify the location of your file using the VocabularyFilterFileUri \n parameter.

\n

Note that if you include Words in your request, you cannot use\n VocabularyFilterFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that specific \n language. If you use unsupported characters, your vocabulary filter request fails. Refer to \n Character Sets for \n Custom Vocabularies to get the character set for your language.

" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of a text file used as input to create the vocabulary filter.\n Only use characters from the character set defined for custom vocabularies. For a list of \n character sets, see Character Sets for Custom\n Vocabularies.

\n

The specified file must be less than 50 KB of UTF-8 characters.

\n

If you provide the location of a list of words in the VocabularyFilterFileUri\n parameter, you can't use the Words parameter.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary filter \n terms. The URI must be located in the same Amazon Web Services Region as the resource you're \n calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt\n

\n

Note that if you include VocabularyFilterFileUri in your request, you \n cannot use Words; you must choose one or the other.

" } } } @@ -5233,19 +5312,19 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the updated vocabulary filter.

" + "smithy.api#documentation": "

The name of the updated custom vocabulary filter.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the words in the vocabulary filter.

" + "smithy.api#documentation": "

The language code you selected for your vocabulary filter.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary filter was updated.

" + "smithy.api#documentation": "

The date and time the specified vocabulary filter was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } } } @@ -5256,7 +5335,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to update. The name is case sensitive. If you try to update\n a vocabulary with the same name as a previous vocabulary you will receive a\n ConflictException error.

", + "smithy.api#documentation": "

The name of the custom vocabulary you want to update. Vocabulary names are\n case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5264,20 +5343,20 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their \n corresponding language codes, see Supported languages.

", + "smithy.api#documentation": "

The language code that represents the language of the entries in the custom vocabulary \n you want to update. Each vocabulary must contain terms in only one language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the \n vocabulary. For example, if you create a vocabulary using US English (en-US), \n you can only apply this vocabulary to files that contain English audio.

\n

For a list of supported languages and their associated language codes, refer to the \n Supported\n languages table.

", "smithy.api#required": {} } }, "Phrases": { "target": "com.amazonaws.transcribe#Phrases", "traits": { - "smithy.api#documentation": "

An array of strings containing the vocabulary entries.

" + "smithy.api#documentation": "

Use this parameter if you want to update your vocabulary by including all desired terms, as\n comma-separated values, within your request. The other option for updating your vocabulary is to\n save your entries in a text file and upload them to an Amazon S3 bucket, then specify \n the location of your file using the VocabularyFileUri parameter.

\n

Note that if you include Phrases in your request, you cannot use\n VocabularyFileUri; you must choose one or the other.

\n

Each language has a character set that contains all allowed characters for that specific \n language. If you use unsupported characters, your vocabulary filter request fails. Refer to \n Character Sets for \n Custom Vocabularies to get the character set for your language.

" } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom vocabulary. \n The URI must be in the same region as the API endpoint that you are calling. The general form\n is:

\n

\n https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey\n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about S3 object names, see Object Keys in the\n Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom \n Vocabularies.

" + "smithy.api#documentation": "

The Amazon S3 location of the text file that contains your custom vocabulary. The\n URI must be located in the same Amazon Web Services Region as the resource you're \n calling.

\n

Here's an example URI path:\n s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt\n

\n

Note that if you include VocabularyFileUri in your request, you \n cannot use the Phrases flag; you must choose one or the other.

" } } } @@ -5288,25 +5367,25 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary that was updated.

" + "smithy.api#documentation": "

The name of the updated custom vocabulary.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries.

" + "smithy.api#documentation": "

The language code you selected for your custom vocabulary.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary was updated.

" + "smithy.api#documentation": "

The date and time the specified vocabulary was last updated.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the vocabulary. When the VocabularyState \n field contains READY the vocabulary is ready to be used in a\n StartTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of your custom vocabulary. If the state is READY, you\n can use the vocabulary in a StartTranscriptionJob request.

" } } } @@ -5333,24 +5412,24 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter. The name must be unique in the account that\n holds the filter.

" + "smithy.api#documentation": "

A unique name, chosen by you, for your custom vocabulary filter. This name is case \n sensitive, cannot contain spaces, and must be unique within an \n Amazon Web Services account.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the words in the vocabulary filter.

" + "smithy.api#documentation": "

The language code that represents the language of the entries in your vocabulary \n filter. Each vocabulary filter must contain terms in only one language.

\n

A vocabulary filter can only be used to transcribe files in the same language as the \n filter. For example, if you create a vocabulary filter using US English (en-US), you\n can only apply this filter to files that contain English audio.

\n

For a list of supported languages and their associated language codes, refer to the \n Supported\n languages table.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary was last updated.

" + "smithy.api#documentation": "

The date and time the specified vocabulary filter was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about a vocabulary filter.

" + "smithy.api#documentation": "

Provides information about a vocabulary filter, including the language of the filter, when it\n was last modified, and its name.

" } }, "com.amazonaws.transcribe#VocabularyFilterMethod": { @@ -5394,30 +5473,30 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary.

" + "smithy.api#documentation": "

A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, \n cannot contain spaces, and must be unique within an Amazon Web Services account.

" } }, "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries.

" + "smithy.api#documentation": "

The language code used to create your custom vocabulary. Each vocabulary must contain\n terms in only one language.

\n

A custom vocabulary can only be used to transcribe files in the same language as the \n vocabulary. For example, if you create a vocabulary using US English (en-US), \n you can only apply this vocabulary to files that contain English audio.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary was last modified.

" + "smithy.api#documentation": "

The date and time the specified vocabulary was last modified.

\n

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For\n example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 \n on May 4, 2022.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the vocabulary. If the state is READY you \n can use the vocabulary in a StartTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of your custom vocabulary. If the state is READY, you\n can use the vocabulary in a StartTranscriptionJob request.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about a custom vocabulary.

" + "smithy.api#documentation": "

Provides information about a custom vocabulary, including the language of the vocabulary, \n when it was last modified, its name, and the processing state.

" } }, "com.amazonaws.transcribe#VocabularyName": { diff --git a/aws/sdk/aws-models/voice-id.json b/aws/sdk/aws-models/voice-id.json index 3b7f6448e..9ac755f0b 100644 --- a/aws/sdk/aws-models/voice-id.json +++ b/aws/sdk/aws-models/voice-id.json @@ -196,6 +196,10 @@ { "value": "CONCURRENT_CHANGES", "name": "CONCURRENT_CHANGES" + }, + { + "value": "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES", + "name": "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES" } ] } @@ -259,7 +263,7 @@ "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.voiceid#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration, containing the KMS Key Identifier, to be used by Voice ID for \n the server-side encryption of your data. Refer to \n Amazon Connect VoiceID encryption at rest for more details on how the KMS Key is used.\n

", + "smithy.api#documentation": "

The configuration, containing the KMS key identifier, to be used by Voice ID for \n the server-side encryption of your data. Refer to \n Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.\n

", "smithy.api#required": {} } }, @@ -329,7 +333,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified domain from the Amazon Connect Voice ID system.

", + "smithy.api#documentation": "

Deletes the specified domain from Voice ID.

", "smithy.api#http": { "method": "DELETE", "uri": "/domains/{DomainId}", @@ -362,6 +366,9 @@ { "target": "com.amazonaws.voiceid#AccessDeniedException" }, + { + "target": "com.amazonaws.voiceid#ConflictException" + }, { "target": "com.amazonaws.voiceid#InternalServerException" }, @@ -376,7 +383,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified fraudster from the Amazon Connect Voice ID system.

", + "smithy.api#documentation": "

Deletes the specified fraudster from Voice ID.

", "smithy.api#http": { "method": "DELETE", "uri": "/domains/{DomainId}/fraudsters/{FraudsterId}", @@ -434,7 +441,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified speaker from the Amazon Connect Voice ID system.

", + "smithy.api#documentation": "

Deletes the specified speaker from Voice ID.

", "smithy.api#http": { "method": "DELETE", "uri": "/domains/{DomainId}/speakers/{SpeakerId}", @@ -827,7 +834,7 @@ "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.voiceid#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use\n to encrypt your data.

" + "smithy.api#documentation": "

The server-side encryption configuration containing the KMS key identifier you want Voice ID to use\n to encrypt your data.

" } }, "CreatedAt": { @@ -841,6 +848,12 @@ "traits": { "smithy.api#documentation": "

The timestamp showing the domain's last update.

" } + }, + "ServerSideEncryptionUpdateDetails": { + "target": "com.amazonaws.voiceid#ServerSideEncryptionUpdateDetails", + "traits": { + "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the server-side\n encryption configuration is changed, dependency on the old KMS key is removed through an\n asynchronous process. When this update is complete, the domain's data can only be accessed using the\n new KMS key.

" + } } }, "traits": { @@ -929,7 +942,7 @@ "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.voiceid#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use\n to encrypt your data..

" + "smithy.api#documentation": "

The server-side encryption configuration containing the KMS key identifier you want Voice ID to use\n to encrypt your data.

" } }, "CreatedAt": { @@ -943,6 +956,12 @@ "traits": { "smithy.api#documentation": "

The timestamp showing the domain's last update.

" } + }, + "ServerSideEncryptionUpdateDetails": { + "target": "com.amazonaws.voiceid#ServerSideEncryptionUpdateDetails", + "traits": { + "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the server-side\n encryption configuration is changed, dependency on the old KMS key is removed through an\n asynchronous process. When this update is complete, the domain’s data can only be accessed using the\n new KMS key.

" + } } }, "traits": { @@ -1016,6 +1035,9 @@ { "target": "com.amazonaws.voiceid#AccessDeniedException" }, + { + "target": "com.amazonaws.voiceid#ConflictException" + }, { "target": "com.amazonaws.voiceid#InternalServerException" }, @@ -1082,7 +1104,7 @@ "StreamingStatus": { "target": "com.amazonaws.voiceid#StreamingStatus", "traits": { - "smithy.api#documentation": "

The current status of audio streaming for this session. This field is useful to infer next steps when\n the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH.\n In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can\n mean that the client should call the API again later, once Voice ID has enough audio to produce a result.\n If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED,\n it means that the previously streamed session did not have enough speech to perform evaluation, and a new\n streaming session is needed to try again.

" + "smithy.api#documentation": "

The current status of audio streaming for this session. This field is useful to infer next steps when\n the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH.\n In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can\n mean that the client should call the API again later, after Voice ID has enough audio to produce a result.\n If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED,\n it means that the previously streamed session did not have enough speech to perform evaluation, and a new\n streaming session is needed to try again.

" } }, "AuthenticationResult": { @@ -1314,7 +1336,7 @@ "JobName": { "target": "com.amazonaws.voiceid#JobName", "traits": { - "smithy.api#documentation": "

The client-provied name for the fraudster registration job.

" + "smithy.api#documentation": "

The client-provided name for the fraudster registration job.

" } }, "JobId": { @@ -1356,7 +1378,7 @@ "OutputDataConfig": { "target": "com.amazonaws.voiceid#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data config containing the S3 location where you want Voice ID to write your job output \n file; you must also include a KMS Key ID in order to encrypt the file.

" + "smithy.api#documentation": "

The output data config containing the S3 location where you want Voice ID to write your job output \n file; you must also include a KMS key iD in order to encrypt the file.

" } }, "CreatedAt": { @@ -2057,7 +2079,7 @@ } ], "traits": { - "smithy.api#documentation": "

Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they\n already exist in the system. If they don't yet exist, a new speaker is created in an opted out state.\n If they already exist, their existing status is overridden and they are opted out. Enrollment and\n evaluation authentication requests are rejected for opted out speakers, and opted out speakers have\n no voice embeddings stored in the system.

", + "smithy.api#documentation": "

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they\n already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state.\n If they already exist, their existing status is overridden and they are opted out. Enrollment and\n evaluation authentication requests are rejected for opted out speakers, and opted out speakers have\n no voice embeddings stored in Voice ID.

", "smithy.api#http": { "method": "PUT", "uri": "/domains/{DomainId}/speakers/{SpeakerId}/optout" @@ -2102,7 +2124,7 @@ "S3Uri": { "target": "com.amazonaws.voiceid#S3Uri", "traits": { - "smithy.api#documentation": "

The S3 path of the folder to which Voice ID writes the job output file, which has a \n *.out extension. For example, if the input file name is input-file.json and \n the output folder path is s3://output-bucket/output-folder, the full output file path is \n s3://output-bucket/output-folder/job-Id/input-file.json.out.

", + "smithy.api#documentation": "

The S3 path of the folder where Voice ID writes the job output file. It has a \n *.out extension. For example, if the input file name is input-file.json and \n the output folder path is s3://output-bucket/output-folder, the full output file path is \n s3://output-bucket/output-folder/job-Id/input-file.json.out.

", "smithy.api#required": {} } }, @@ -2134,7 +2156,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration definining the action to take when a duplicate fraudster is detected, and the \n similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.

" + "smithy.api#documentation": "

The configuration defining the action to take when a duplicate fraudster is detected, and the \n similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.

" } }, "com.amazonaws.voiceid#ResourceNotFoundException": { @@ -2213,13 +2235,58 @@ "KmsKeyId": { "target": "com.amazonaws.voiceid#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier of the KMS Key you want Voice ID to use to encrypt your data.

", + "smithy.api#documentation": "

The identifier of the KMS key you want Voice ID to use to encrypt your data.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configuration containing information about the customer-managed KMS Key used for encrypting\n customer data.

" + "smithy.api#documentation": "

The configuration containing information about the customer managed key used for encrypting\n customer data.

" + } + }, + "com.amazonaws.voiceid#ServerSideEncryptionUpdateDetails": { + "type": "structure", + "members": { + "OldKmsKeyId": { + "target": "com.amazonaws.voiceid#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The previous KMS key ID the domain was encrypted with, before\n ServerSideEncryptionConfiguration was updated to a new KMS key ID.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.voiceid#ServerSideEncryptionUpdateStatus", + "traits": { + "smithy.api#documentation": "

Status of the server-side encryption update. During an update, if there is an issue with the domain's\n current or old KMS key ID, such as an inaccessible or disabled key, then the status\n is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call\n with the existing server-side encryption configuration will re-attempt this update process.

" + } + }, + "Message": { + "target": "com.amazonaws.voiceid#String", + "traits": { + "smithy.api#documentation": "

Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains\n the cause of the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the server-side\n encryption configuration is changed, dependency on the old KMS key is removed through an\n asynchronous process. When this update is complete, the domain’s data can only be accessed using the\n new KMS key.

" + } + }, + "com.amazonaws.voiceid#ServerSideEncryptionUpdateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] } }, "com.amazonaws.voiceid#ServiceQuotaExceededException": { @@ -2363,7 +2430,7 @@ "OutputDataConfig": { "target": "com.amazonaws.voiceid#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must \n also include a KMS Key ID to encrypt the file.

" + "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must \n also include a KMS key ID to encrypt the file.

" } }, "CreatedAt": { @@ -2661,7 +2728,7 @@ "OutputDataConfig": { "target": "com.amazonaws.voiceid#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must\n also include a KMS Key ID to encrypt the file.

", + "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must\n also include a KMS key ID to encrypt the file.

", "smithy.api#required": {} } } @@ -2752,7 +2819,7 @@ "EnrollmentConfig": { "target": "com.amazonaws.voiceid#EnrollmentConfig", "traits": { - "smithy.api#documentation": "

The enrollment config that contains details such as the action to take when a speaker is already\n enrolled in the Voice ID system or when a speaker is identified as a fraudster.

" + "smithy.api#documentation": "

The enrollment config that contains details such as the action to take when a speaker is already\n enrolled in Voice ID or when a speaker is identified as a fraudster.

" } }, "InputDataConfig": { @@ -2765,7 +2832,7 @@ "OutputDataConfig": { "target": "com.amazonaws.voiceid#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must\n also include a KMS Key ID to encrypt the file.

", + "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must\n also include a KMS key ID to encrypt the file.

", "smithy.api#required": {} } } @@ -2895,7 +2962,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tags an Amazon Connect Voice ID resource with the provided list of tags.

", + "smithy.api#documentation": "

Tags a Voice ID resource with the provided list of tags.

", "smithy.api#http": { "uri": "/tags/{ResourceArn}", "method": "POST" @@ -3088,7 +3155,7 @@ "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.voiceid#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side\n encryption of your data. Note that all the existing data in the domain are still encrypted using the\n existing key, only the data added to domain after updating the key is encrypted using the new key.

", + "smithy.api#documentation": "

The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side\n encryption of your data. Note that all the existing data in the domain are still encrypted using the\n existing key, only the data added to domain after updating the key is encrypted using the new key.

", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/wellarchitected.json b/aws/sdk/aws-models/wellarchitected.json index 588e29f5f..85b3c7984 100644 --- a/aws/sdk/aws-models/wellarchitected.json +++ b/aws/sdk/aws-models/wellarchitected.json @@ -45,6 +45,47 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.wellarchitected#AdditionalResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HELPFUL_RESOURCE", + "name": "HELPFUL_RESOURCE" + }, + { + "value": "IMPROVEMENT_PLAN", + "name": "IMPROVEMENT_PLAN" + } + ] + } + }, + "com.amazonaws.wellarchitected#AdditionalResources": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.wellarchitected#AdditionalResourceType", + "traits": { + "smithy.api#documentation": "

Type of additional resource.

" + } + }, + "Content": { + "target": "com.amazonaws.wellarchitected#Urls", + "traits": { + "smithy.api#documentation": "

The URLs for additional resources, either helpful resources or improvement plans. Up to five additional URLs can be specified.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The choice level additional resources.

" + } + }, + "com.amazonaws.wellarchitected#AdditionalResourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#AdditionalResources" + } + }, "com.amazonaws.wellarchitected#Answer": { "type": "structure", "members": { @@ -186,6 +227,9 @@ "input": { "target": "com.amazonaws.wellarchitected#AssociateLensesInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" @@ -282,6 +326,12 @@ "traits": { "smithy.api#documentation": "

The choice level improvement plan.

" } + }, + "AdditionalResources": { + "target": "com.amazonaws.wellarchitected#AdditionalResourcesList", + "traits": { + "smithy.api#documentation": "

The additional resources for a choice. A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, \n one of type IMPROVEMENT_PLAN, or both.

" + } } }, "traits": { @@ -907,10 +957,7 @@ "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" }, "ReviewOwner": { - "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner", - "traits": { - "smithy.api#required": {} - } + "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" }, "IndustryType": { "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" @@ -1052,6 +1099,9 @@ "input": { "target": "com.amazonaws.wellarchitected#DeleteLensInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" @@ -1114,6 +1164,9 @@ "input": { "target": "com.amazonaws.wellarchitected#DeleteLensShareInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" @@ -1175,6 +1228,9 @@ "input": { "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" @@ -1232,6 +1288,9 @@ "input": { "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" @@ -1315,6 +1374,9 @@ "input": { "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" @@ -2220,6 +2282,12 @@ "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the lens.

" + } } }, "traits": { @@ -2229,7 +2297,7 @@ "com.amazonaws.wellarchitected#LensAlias": { "type": "string", "traits": { - "smithy.api#documentation": "

The alias of the lens, for example, serverless.

\n

Each lens is identified by its LensSummary$LensAlias.

", + "smithy.api#documentation": "

The alias of the lens.

\n

For Amazon Web Services official lenses, this is either the lens alias,\n such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-west-2::lens/serverless.

\n

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens.

\n

Each lens is identified by its LensSummary$LensAlias.

", "smithy.api#length": { "min": 1, "max": 128 @@ -3385,7 +3453,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the tags for a resource.

", + "smithy.api#documentation": "

List the tags for a resource.

\n \n

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

\n ", "smithy.api#http": { "method": "GET", "uri": "/tags/{WorkloadArn}", @@ -4245,7 +4313,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds one or more tags to the specified resource.

", + "smithy.api#documentation": "

Adds one or more tags to the specified resource.

\n \n

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

\n ", "smithy.api#http": { "method": "POST", "uri": "/tags/{WorkloadArn}", @@ -4330,7 +4398,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes specified tags from a resource.

\n

To specify multiple tags, use separate tagKeys parameters, for example:

\n

\n DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2\n

", + "smithy.api#documentation": "

Deletes specified tags from a resource.

\n \n

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

\n \n \n

To specify multiple tags, use separate tagKeys parameters, for example:

\n

\n DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2\n

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{WorkloadArn}", @@ -4813,6 +4881,9 @@ "input": { "target": "com.amazonaws.wellarchitected#UpgradeLensReviewInput" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" @@ -4870,6 +4941,12 @@ } } }, + "com.amazonaws.wellarchitected#Urls": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceContent" + } + }, "com.amazonaws.wellarchitected#ValidationException": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/workspaces.json b/aws/sdk/aws-models/workspaces.json index 600d5c164..1d4b75881 100644 --- a/aws/sdk/aws-models/workspaces.json +++ b/aws/sdk/aws-models/workspaces.json @@ -1440,7 +1440,7 @@ "LogoUrl": { "target": "com.amazonaws.workspaces#ClientUrl", "traits": { - "smithy.api#documentation": "

The logo URL. This is the link where users can download the logo image. The only\n supported image format is .png.

" + "smithy.api#documentation": "

The logo URL. The only image \n format accepted is a binary data object that is converted from a .png file.

" } }, "SupportEmail": { @@ -1478,7 +1478,7 @@ "Logo": { "target": "com.amazonaws.workspaces#DefaultLogo", "traits": { - "smithy.api#documentation": "

The logo. This is the link where users can download the logo image. The only image\n format accepted is .png.

" + "smithy.api#documentation": "

The logo. The only image \n format accepted is a binary data object that is converted from a .png file.

" } }, "SupportEmail": { @@ -3014,6 +3014,9 @@ "com.amazonaws.workspaces#ErrorType": { "type": "string" }, + "com.amazonaws.workspaces#ExceptionErrorCode": { + "type": "string" + }, "com.amazonaws.workspaces#ExceptionMessage": { "type": "string" }, @@ -3297,7 +3300,7 @@ "IngestionProcess": { "target": "com.amazonaws.workspaces#WorkspaceImageIngestionProcess", "traits": { - "smithy.api#documentation": "

The ingestion process to be used when importing the image, depending on which protocol \n you want to use for your BYOL Workspace image, either PCoIP or WorkSpaces Streaming Protocol \n (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value \n that does not end in _WSP.

\n \n

For non-GPU-enabled images (bundles other than Graphics.g4dn, GraphicsPro.g4dn, Graphics, \n or GraphicsPro), specify BYOL_REGULAR or BYOL_REGULAR_WSP, depending\n on the protocol.

\n \n

Use BYOL_GRAPHICS_G4DN ingestion for both Graphics.g4dn and\n GraphicsPro.g4dn.

\n ", + "smithy.api#documentation": "

The ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP or WorkSpaces Streaming\n Protocol (WSP). To use WSP, specify a value that ends in _WSP. To use PCoIP,\n specify a value that does not end in _WSP.

\n

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify\n BYOL_REGULAR or BYOL_REGULAR_WSP, depending on the\n protocol.

", "smithy.api#required": {} } }, @@ -3324,7 +3327,7 @@ "Applications": { "target": "com.amazonaws.workspaces#ApplicationList", "traits": { - "smithy.api#documentation": "

If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.

\n \n
    \n
  • \n

    Although this parameter is an array, only one item is allowed at this time

    \n
    • \n
  • \n

    Microsoft Office 2016 application subscription through AWS is currently not supported \n for Graphics.g4dn Bring Your Own License (BYOL) images

    \n
    • \n
\n " + "smithy.api#documentation": "

If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.

\n \n

Although this parameter is an array, only one item is allowed at this time.

\n " } } } @@ -3391,19 +3394,19 @@ "LogoUrl": { "target": "com.amazonaws.workspaces#ClientUrl", "traits": { - "smithy.api#documentation": "

The logo. This is the link where users can download the logo image. This is the\n standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal\n to one point.

" + "smithy.api#documentation": "

The logo. This is the\n standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal\n to one point. The only image format accepted is a binary data object that is converted from \n a .png file.

" } }, "Logo2xUrl": { "target": "com.amazonaws.workspaces#ClientUrl", "traits": { - "smithy.api#documentation": "

The @2x version of the logo. This is the higher resolution display that offers a scale\n factor of 2.0 (or @2x).

\n \n

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

\n " + "smithy.api#documentation": "

The @2x version of the logo. This is the higher resolution display that offers a scale\n factor of 2.0 (or @2x). The only image format accepted is a binary data object that is \n converted from a .png file.

\n \n

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

\n " } }, "Logo3xUrl": { "target": "com.amazonaws.workspaces#ClientUrl", "traits": { - "smithy.api#documentation": "

The @3x version of the logo. This is the higher resolution display that offers a scale\n factor of 3.0 (or @3x).

\n \n

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

\n " + "smithy.api#documentation": "

The @3x version of the logo. This is the higher resolution display that offers a scale\n factor of 3.0 (or @3x).The only image format accepted is a binary data object that is \n converted from a .png file.

\n \n

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

\n " } }, "SupportEmail": { @@ -3441,19 +3444,19 @@ "Logo": { "target": "com.amazonaws.workspaces#IosLogo", "traits": { - "smithy.api#documentation": "

The logo. This is the link where users can download the logo image. This is the\n standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal\n to one point.

" + "smithy.api#documentation": "

The logo. This is the\n standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal\n to one point. The only image format accepted is a binary data object that is converted \n from a .png file.

" } }, "Logo2x": { "target": "com.amazonaws.workspaces#Ios2XLogo", "traits": { - "smithy.api#documentation": "

The @2x version of the logo. This is the higher resolution display that offers a scale\n factor of 2.0 (or @2x).

\n \n

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

\n " + "smithy.api#documentation": "

The @2x version of the logo. This is the higher resolution display that offers a scale\n factor of 2.0 (or @2x). The only image format accepted is a binary data object that is \n converted from a .png file.

\n \n

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

\n " } }, "Logo3x": { "target": "com.amazonaws.workspaces#Ios3XLogo", "traits": { - "smithy.api#documentation": "

The @3x version of the logo. This is the higher resolution display that offers a scale\n factor of 3.0 (or @3x).

\n \n

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

\n " + "smithy.api#documentation": "

The @3x version of the logo. This is the higher resolution display that offers a scale\n factor of 3.0 (or @3x). The only image format accepted is a binary data object that is \n converted from a .png file.

\n \n

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface\n Guidelines.

\n " } }, "SupportEmail": { @@ -4168,7 +4171,16 @@ "type": "structure", "members": { "message": { - "target": "com.amazonaws.workspaces#ExceptionMessage" + "target": "com.amazonaws.workspaces#ExceptionMessage", + "traits": { + "smithy.api#documentation": "

The exception error message.

" + } + }, + "reason": { + "target": "com.amazonaws.workspaces#ExceptionErrorCode", + "traits": { + "smithy.api#documentation": "

The exception error reason.

" + } } }, "traits": { diff --git a/gradle.properties b/gradle.properties index 9aac8d05f..413f6a2c8 100644 --- a/gradle.properties +++ b/gradle.properties @@ -10,10 +10,10 @@ org.gradle.jvmargs=-Xmx1024M # Version number to use for the generated SDK # Note: these must always be full 3-segment semver versions -aws.sdk.version=0.13.0 +aws.sdk.version=0.14.0 # Version number to use for the generated runtime crates -smithy.rs.runtime.crate.version=0.43.0 +smithy.rs.runtime.crate.version=0.44.0 kotlin.code.style=official -- GitLab