diff --git a/.changes/a47197cb-bd29-4d82-af32-3a810588a918.json b/.changes/a47197cb-bd29-4d82-af32-3a810588a918.json new file mode 100644 index 00000000000..ae36240d46b --- /dev/null +++ b/.changes/a47197cb-bd29-4d82-af32-3a810588a918.json @@ -0,0 +1,5 @@ +{ + "id": "a47197cb-bd29-4d82-af32-3a810588a918", + "type": "misc", + "description": "Sync AWS service models." +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/appconfig.json b/codegen/sdk/aws-models/appconfig.json index 896ad4d4bfc..583aff6342f 100644 --- a/codegen/sdk/aws-models/appconfig.json +++ b/codegen/sdk/aws-models/appconfig.json @@ -29,6 +29,156 @@ ] }, "shapes": { + "com.amazonaws.appconfig#Action": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appconfig#Name", + "traits": { + "smithy.api#documentation": "
The action name.
" + } + }, + "Description": { + "target": "com.amazonaws.appconfig#Description", + "traits": { + "smithy.api#documentation": "Information about the action.
" + } + }, + "Uri": { + "target": "com.amazonaws.appconfig#Uri", + "traits": { + "smithy.api#documentation": "The extension URI associated to the action point in the extension definition. The URI\n can be an Amazon Resource Name (ARN) for one of the following: an Lambda\n function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An action defines the tasks the extension performs during the AppConfig\n workflow. Each action includes an action point such as\n ON_CREATE_HOSTED_CONFIGURATION, PRE_DEPLOYMENT, or\n ON_DEPLOYMENT. Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management\n assume role. You specify the name, URI, and ARN for each action point\n defined in the extension. You can specify the following actions for an extension:
\n PRE_CREATE_HOSTED_CONFIGURATION_VERSION\n
\n PRE_START_DEPLOYMENT\n
\n ON_DEPLOYMENT_START\n
\n ON_DEPLOYMENT_STEP\n
\n ON_DEPLOYMENT_BAKING\n
\n ON_DEPLOYMENT_COMPLETE\n
\n ON_DEPLOYMENT_ROLLED_BACK\n
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
" + } + }, + "ActionName": { + "target": "com.amazonaws.appconfig#Name", + "traits": { + "smithy.api#documentation": "The name of the action.
" + } + }, + "Uri": { + "target": "com.amazonaws.appconfig#Uri", + "traits": { + "smithy.api#documentation": "The extension URI associated to the action point in the extension definition. The URI\n can be an Amazon Resource Name (ARN) for one of the following: an Lambda\n function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.appconfig#String", + "traits": { + "smithy.api#documentation": "The error message when an extension invocation fails.
" + } + }, + "ErrorCode": { + "target": "com.amazonaws.appconfig#String", + "traits": { + "smithy.api#documentation": "The error code when an extension invocation fails.
" + } + }, + "InvocationId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "A system-generated ID for this invocation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An extension that was invoked as part of a deployment event.
" + } + }, + "com.amazonaws.appconfig#ActionInvocations": { + "type": "list", + "member": { + "target": "com.amazonaws.appconfig#ActionInvocation" + } + }, + "com.amazonaws.appconfig#ActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appconfig#Action" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.appconfig#ActionPoint": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRE_CREATE_HOSTED_CONFIGURATION_VERSION", + "name": "PRE_CREATE_HOSTED_CONFIGURATION_VERSION" + }, + { + "value": "PRE_START_DEPLOYMENT", + "name": "PRE_START_DEPLOYMENT" + }, + { + "value": "ON_DEPLOYMENT_START", + "name": "ON_DEPLOYMENT_START" + }, + { + "value": "ON_DEPLOYMENT_STEP", + "name": "ON_DEPLOYMENT_STEP" + }, + { + "value": "ON_DEPLOYMENT_BAKING", + "name": "ON_DEPLOYMENT_BAKING" + }, + { + "value": "ON_DEPLOYMENT_COMPLETE", + "name": "ON_DEPLOYMENT_COMPLETE" + }, + { + "value": "ON_DEPLOYMENT_ROLLED_BACK", + "name": "ON_DEPLOYMENT_ROLLED_BACK" + } + ] + } + }, + "com.amazonaws.appconfig#ActionsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appconfig#ActionPoint" + }, + "value": { + "target": "com.amazonaws.appconfig#ActionList" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.appconfig#AmazonAppConfig": { "type": "service", "traits": { @@ -43,7 +193,7 @@ "name": "appconfig" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy\n application configurations. AppConfig supports controlled deployments to applications of\n any size and includes built-in validation checks and monitoring. You can use AppConfig with\n applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT\n devices.
\nTo prevent errors when deploying application configurations, especially for production\n systems where a simple typo could cause an unexpected outage, AppConfig includes\n validators. A validator provides a syntactic or semantic check to ensure that the\n configuration you want to deploy works as intended. To validate your application\n configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against\n the configuration. The configuration deployment or update can only proceed when the\n configuration data is valid.
\nDuring a configuration deployment, AppConfig monitors the application to ensure that the\n deployment is successful. If the system encounters an error, AppConfig rolls back the\n change to minimize impact for your application users. You can configure a deployment\n strategy for each application or environment that includes deployment criteria, including\n velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment\n triggers an alarm, AppConfig automatically rolls back to the previous version.
\nAppConfig supports multiple use cases. Here are some examples:
\n\n Feature flags: Use AppConfig to turn on new\n features that require a timely deployment, such as a product launch or announcement.\n
\n\n Application tuning: Use AppConfig to carefully\n introduce changes to your application that can only be tested with production\n traffic.
\n\n Allow list: Use AppConfig to allow premium\n subscribers to access paid content.
\n\n Operational issues: Use AppConfig to reduce\n stress on your application when a dependency or other external factor impacts the\n system.
\nThis reference is intended to be used with the AppConfig User Guide.
", + "smithy.api#documentation": "Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly\n deploy application configurations. AppConfig supports controlled deployments to\n applications of any size and includes built-in validation checks and monitoring. You can\n use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers,\n mobile applications, or IoT devices.
\nTo prevent errors when deploying application configurations, especially for production\n systems where a simple typo could cause an unexpected outage, AppConfig includes\n validators. A validator provides a syntactic or semantic check to ensure that the\n configuration you want to deploy works as intended. To validate your application\n configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against\n the configuration. The configuration deployment or update can only proceed when the\n configuration data is valid.
\nDuring a configuration deployment, AppConfig monitors the application to\n ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can\n configure a deployment strategy for each application or environment that includes\n deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error\n monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back\n to the previous version.
\nAppConfig supports multiple use cases. Here are some examples:
\n\n Feature flags: Use AppConfig to turn on\n new features that require a timely deployment, such as a product launch or\n announcement.
\n\n Application tuning: Use AppConfig to\n carefully introduce changes to your application that can only be tested with\n production traffic.
\n\n Allow list: Use AppConfig to allow\n premium subscribers to access paid content.
\n\n Operational issues: Use AppConfig to\n reduce stress on your application when a dependency or other external factor impacts\n the system.
\nThis reference is intended to be used with the AppConfig User\n Guide.
", "smithy.api#title": "Amazon AppConfig" }, "version": "2019-10-09", @@ -60,6 +210,12 @@ { "target": "com.amazonaws.appconfig#CreateEnvironment" }, + { + "target": "com.amazonaws.appconfig#CreateExtension" + }, + { + "target": "com.amazonaws.appconfig#CreateExtensionAssociation" + }, { "target": "com.amazonaws.appconfig#CreateHostedConfigurationVersion" }, @@ -75,6 +231,12 @@ { "target": "com.amazonaws.appconfig#DeleteEnvironment" }, + { + "target": "com.amazonaws.appconfig#DeleteExtension" + }, + { + "target": "com.amazonaws.appconfig#DeleteExtensionAssociation" + }, { "target": "com.amazonaws.appconfig#DeleteHostedConfigurationVersion" }, @@ -96,6 +258,12 @@ { "target": "com.amazonaws.appconfig#GetEnvironment" }, + { + "target": "com.amazonaws.appconfig#GetExtension" + }, + { + "target": "com.amazonaws.appconfig#GetExtensionAssociation" + }, { "target": "com.amazonaws.appconfig#GetHostedConfigurationVersion" }, @@ -114,6 +282,12 @@ { "target": "com.amazonaws.appconfig#ListEnvironments" }, + { + "target": "com.amazonaws.appconfig#ListExtensionAssociations" + }, + { + "target": "com.amazonaws.appconfig#ListExtensions" + }, { "target": "com.amazonaws.appconfig#ListHostedConfigurationVersions" }, @@ -144,6 +318,12 @@ { "target": "com.amazonaws.appconfig#UpdateEnvironment" }, + { + "target": "com.amazonaws.appconfig#UpdateExtension" + }, + { + "target": "com.amazonaws.appconfig#UpdateExtensionAssociation" + }, { "target": "com.amazonaws.appconfig#ValidateConfiguration" } @@ -195,6 +375,44 @@ } } }, + "com.amazonaws.appconfig#AppliedExtension": { + "type": "structure", + "members": { + "ExtensionId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "The system-generated ID of the extension.
" + } + }, + "ExtensionAssociationId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "The system-generated ID for the association.
" + } + }, + "VersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#documentation": "The extension version number.
" + } + }, + "Parameters": { + "target": "com.amazonaws.appconfig#ParameterValueMap", + "traits": { + "smithy.api#documentation": "One or more parameters for the actions called by the extension.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An extension that was invoked during a deployment.
" + } + }, + "com.amazonaws.appconfig#AppliedExtensions": { + "type": "list", + "member": { + "target": "com.amazonaws.appconfig#AppliedExtension" + } + }, "com.amazonaws.appconfig#Arn": { "type": "string", "traits": { @@ -255,6 +473,9 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.appconfig#Boolean": { + "type": "boolean" + }, "com.amazonaws.appconfig#BytesMeasure": { "type": "string", "traits": { @@ -272,7 +493,7 @@ "Content": { "target": "com.amazonaws.appconfig#Blob", "traits": { - "smithy.api#documentation": "The content of the configuration or the configuration data.
\nThe Content attribute only contains data if the system finds new or\n updated configuration data. If there is no new or updated data and\n ClientConfigurationVersion matches the version of the current\n configuration, AppConfig returns a 204 No Content HTTP response code and\n the Content value will be empty.
The content of the configuration or the configuration data.
\nThe Content attribute only contains data if the system finds new or\n updated configuration data. If there is no new or updated data and\n ClientConfigurationVersion matches the version of the current\n configuration, AppConfig returns a 204 No Content HTTP response\n code and the Content value will be empty.
The name of the configuration profile.
" } @@ -340,7 +561,7 @@ "Type": { "target": "com.amazonaws.appconfig#ConfigurationProfileType", "traits": { - "smithy.api#documentation": "The type of configurations contained in the profile. AppConfig supports feature\n flags and freeform configurations. We recommend you create feature\n flag configurations to enable or disable new features and freeform configurations to\n distribute configurations to an application. When calling this API, enter one of the\n following values for Type:
\n AWS.AppConfig.FeatureFlags\n
\n AWS.Freeform\n
The type of configurations contained in the profile. AppConfig supports\n feature flags and freeform configurations. We recommend you\n create feature flag configurations to enable or disable new features and freeform\n configurations to distribute configurations to an application. When calling this API, enter\n one of the following values for Type:
\n AWS.AppConfig.FeatureFlags\n
\n AWS.Freeform\n
The name of the configuration profile.
" } @@ -381,7 +602,7 @@ "Type": { "target": "com.amazonaws.appconfig#ConfigurationProfileType", "traits": { - "smithy.api#documentation": "The type of configurations contained in the profile. AppConfig supports feature\n flags and freeform configurations. We recommend you create feature\n flag configurations to enable or disable new features and freeform configurations to\n distribute configurations to an application. When calling this API, enter one of the\n following values for Type:
\n AWS.AppConfig.FeatureFlags\n
\n AWS.Freeform\n
The type of configurations contained in the profile. AppConfig supports\n feature flags and freeform configurations. We recommend you\n create feature flag configurations to enable or disable new features and freeform\n configurations to distribute configurations to an application. When calling this API, enter\n one of the following values for Type:
\n AWS.AppConfig.FeatureFlags\n
\n AWS.Freeform\n
Creates an application. An application in AppConfig is a logical unit of code that\n provides capabilities for your customers. For example, an application can be a microservice\n that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless\n application using Amazon API Gateway and Lambda, or any system you run on behalf of\n others.
", + "smithy.api#documentation": "Creates an application. In AppConfig, an application is simply an\n organizational construct like a folder. This organizational construct has a relationship\n with some unit of executable code. For example, you could create an application called\n MyMobileApp to organize and manage configuration data for a mobile application installed by\n your users.
", "smithy.api#http": { "method": "POST", "uri": "/applications", @@ -475,7 +696,7 @@ "Tags": { "target": "com.amazonaws.appconfig#TagMap", "traits": { - "smithy.api#documentation": "Metadata to assign to the application. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.
" + "smithy.api#documentation": "Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which\n you define.
" } } } @@ -500,7 +721,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a configuration profile, which is information that enables AppConfig to access\n the configuration source. Valid configuration sources include the AppConfig hosted\n configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3\n objects, or any integration source\n action supported by CodePipeline. A configuration profile includes the following\n information:
\n \nThe URI location of the configuration data.
\nThe Identity and Access Management (IAM) role that provides access to the configuration data.
\nA validator for the configuration data. Available validators include either a JSON\n Schema or an Amazon Web Services Lambda function.
\nFor more information, see Create a\n Configuration and a Configuration Profile in the AppConfig User\n Guide.
", + "smithy.api#documentation": "Creates a configuration profile, which is information that enables AppConfig\n to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store\n parameters, Amazon S3 objects, or any integration source\n action supported by CodePipeline. A configuration profile includes the following\n information:
\n \nThe URI location of the configuration data.
\nThe Identity and Access Management (IAM) role that provides access to the configuration data.
\nA validator for the configuration data. Available validators include either a JSON\n Schema or an Amazon Web Services Lambda function.
\nFor more information, see Create a\n Configuration and a Configuration Profile in the AppConfig\n User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{ApplicationId}/configurationprofiles", @@ -520,7 +741,7 @@ } }, "Name": { - "target": "com.amazonaws.appconfig#Name", + "target": "com.amazonaws.appconfig#LongName", "traits": { "smithy.api#documentation": "A name for the configuration profile.
", "smithy.api#required": {} @@ -535,14 +756,14 @@ "LocationUri": { "target": "com.amazonaws.appconfig#Uri", "traits": { - "smithy.api#documentation": "A URI to locate the configuration. You can specify the AppConfig hosted configuration\n store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the\n hosted configuration store and for feature flags, specify hosted. For an SSM\n document, specify either the document name in the format\n ssm-document:// or the Amazon Resource Name (ARN). For\n a parameter, specify either the parameter name in the format\n ssm-parameter:// or the ARN. For an Amazon S3 object,\n specify the URI in the following format: s3://. Here is an example:\n s3://my-bucket/my-app/us-east-1/my-config.json\n
A URI to locate the configuration. You can specify the AppConfig hosted\n configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3\n object. For the hosted configuration store and for feature flags, specify\n hosted. For an SSM document, specify either the document name in the format\n ssm-document:// or the Amazon Resource Name (ARN). For\n a parameter, specify either the parameter name in the format\n ssm-parameter:// or the ARN. For an Amazon S3 object,\n specify the URI in the following format: s3://. Here is an example:\n s3://my-bucket/my-app/us-east-1/my-config.json\n
The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.
A retrieval role ARN is not required for configurations stored in the AppConfig\n hosted configuration store. It is required for all other sources that store your\n configuration.
\nThe ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.
A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that\n store your configuration.
\nMetadata to assign to the configuration profile. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of which you\n define.
" + "smithy.api#documentation": "Metadata to assign to the configuration profile. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of\n which you define.
" } }, "Type": { "target": "com.amazonaws.appconfig#ConfigurationProfileType", "traits": { - "smithy.api#documentation": "The type of configurations contained in the profile. AppConfig supports feature\n flags and freeform configurations. We recommend you create feature\n flag configurations to enable or disable new features and freeform configurations to\n distribute configurations to an application. When calling this API, enter one of the\n following values for Type:
\n AWS.AppConfig.FeatureFlags\n
\n AWS.Freeform\n
The type of configurations contained in the profile. AppConfig supports\n feature flags and freeform configurations. We recommend you\n create feature flag configurations to enable or disable new features and freeform\n configurations to distribute configurations to an application. When calling this API, enter\n one of the following values for Type:
\n AWS.AppConfig.FeatureFlags\n
\n AWS.Freeform\n
The amount of time AppConfig monitors for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.
" + "smithy.api#documentation": "Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the\n configuration has been deployed to 100% of its targets, before considering the deployment\n to be complete. If an alarm is triggered during this time, AppConfig rolls back\n the deployment. You must configure permissions for AppConfig to roll back based\n on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the\n AppConfig User Guide.
" } }, "GrowthFactor": { @@ -631,20 +852,19 @@ "GrowthType": { "target": "com.amazonaws.appconfig#GrowthType", "traits": { - "smithy.api#documentation": "The algorithm used to define how percentage grows over time. AppConfig supports the\n following growth types:
\n\n Linear: For this type, AppConfig processes the\n deployment by dividing the total number of targets by the value specified for Step\n percentage. For example, a linear deployment that uses a Step\n percentage of 10 deploys the configuration to 10 percent of the hosts. After\n those deployments are complete, the system deploys the configuration to the next 10\n percent. This continues until 100% of the targets have successfully received the\n configuration.
\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:
\n 2*(2^0)\n
\n 2*(2^1)\n
\n 2*(2^2)\n
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.
" + "smithy.api#documentation": "The algorithm used to define how percentage grows over time. AppConfig\n supports the following growth types:
\n\n Linear: For this type, AppConfig processes\n the deployment by dividing the total number of targets by the value specified for\n Step percentage. For example, a linear deployment that uses a Step\n percentage of 10 deploys the configuration to 10 percent of the hosts. After\n those deployments are complete, the system deploys the configuration to the next 10\n percent. This continues until 100% of the targets have successfully received the\n configuration.
\n Exponential: For this type, AppConfig\n processes the deployment exponentially using the following formula: G*(2^N).\n In this formula, G is the growth factor specified by the user and\n N is the number of steps until the configuration is deployed to all\n targets. For example, if you specify a growth factor of 2, then the system rolls out the\n configuration as follows:
\n 2*(2^0)\n
\n 2*(2^1)\n
\n 2*(2^2)\n
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.
" } }, "ReplicateTo": { "target": "com.amazonaws.appconfig#ReplicateTo", "traits": { - "smithy.api#documentation": "Save the deployment strategy to a Systems Manager (SSM) document.
", - "smithy.api#required": {} + "smithy.api#documentation": "Save the deployment strategy to a Systems Manager (SSM) document.
" } }, "Tags": { "target": "com.amazonaws.appconfig#TagMap", "traits": { - "smithy.api#documentation": "Metadata to assign to the deployment strategy. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of which you\n define.
" + "smithy.api#documentation": "Metadata to assign to the deployment strategy. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of\n which you define.
" } } } @@ -669,7 +889,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an environment. For each application, you define one or more environments. An\n environment is a logical deployment group of AppConfig targets, such as applications in a\n Beta or Production environment. You can also define\n environments for application subcomponents such as the Web,\n Mobile and Back-end components for your application. You can\n configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a\n configuration deployment. If an alarm is triggered, the system rolls back the\n configuration.
Creates an environment. For each application, you define one or more environments. An\n environment is a deployment group of AppConfig targets, such as applications in a\n Beta or Production environment. You can also define\n environments for application subcomponents such as the Web,\n Mobile and Back-end components for your application. You can\n configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a\n configuration deployment. If an alarm is triggered, the system rolls back the\n configuration.
Metadata to assign to the environment. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.
" + "smithy.api#documentation": "Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which\n you define.
" + } + } + } + }, + "com.amazonaws.appconfig#CreateExtension": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#CreateExtensionRequest" + }, + "output": { + "target": "com.amazonaws.appconfig#Extension" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#ConflictException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + }, + { + "target": "com.amazonaws.appconfig#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an AppConfig extension. An extension augments your ability to inject\n logic or behavior at different points during the AppConfig workflow of creating\n or deploying a configuration.
\nYou can create your own extensions or use the Amazon Web Services-authored extensions provided by\n AppConfig. For most use-cases, to create your own extension, you must create\n an Lambda function to perform any computation and processing defined in the\n extension. For more information about extensions, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/extensions", + "code": 201 + } + } + }, + "com.amazonaws.appconfig#CreateExtensionAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#CreateExtensionAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appconfig#ExtensionAssociation" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + }, + { + "target": "com.amazonaws.appconfig#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appconfig#ServiceQuotaExceededException" + } + ], + "traits": { + "smithy.api#documentation": "When you create an extension or configure an Amazon Web Services-authored extension, you\n associate the extension with an AppConfig application, environment, or\n configuration profile. For example, you can choose to run the AppConfig\n deployment events to Amazon SNS\n Amazon Web Services-authored extension and receive notifications on an Amazon SNS\n topic anytime a configuration deployment is started for a specific application. Defining\n which extension to associate with an AppConfig resource is called an\n extension association. An extension association is a specified\n relationship between an extension and an AppConfig resource, such as an\n application or a configuration profile. For more information about extensions and\n associations, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
", + "smithy.api#required": {} + } + }, + "ExtensionVersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The version number of the extension. If not specified, AppConfig uses the\n maximum version of the extension.
" + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.appconfig#Identifier", + "traits": { + "smithy.api#documentation": "The ARN of an application, configuration profile, or environment.
", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.appconfig#ParameterValueMap", + "traits": { + "smithy.api#documentation": "The parameter names and values defined in the extensions. Extension parameters marked\n Required must be entered for this field.
Adds one or more tags for the specified extension association. Tags are metadata that\n help you categorize resources in different ways, for example, by purpose, owner, or\n environment. Each tag consists of a key and an optional value, both of which you define.\n
" + } + } + } + }, + "com.amazonaws.appconfig#CreateExtensionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appconfig#Name", + "traits": { + "smithy.api#documentation": "A name for the extension. Each extension name in your account must be unique. Extension\n versions use the same name.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appconfig#Description", + "traits": { + "smithy.api#documentation": "Information about the extension.
" + } + }, + "Actions": { + "target": "com.amazonaws.appconfig#ActionsMap", + "traits": { + "smithy.api#documentation": "The actions defined in the extension.
", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.appconfig#ParameterMap", + "traits": { + "smithy.api#documentation": "The parameters accepted by the extension. You specify parameter values when you\n associate the extension to an AppConfig resource by using the\n CreateExtensionAssociation API action. For Lambda extension\n actions, these parameters are included in the Lambda request object.
Adds one or more tags for the specified extension. Tags are metadata that help you\n categorize resources in different ways, for example, by purpose, owner, or environment.\n Each tag consists of a key and an optional value, both of which you define.
" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "You can omit this field when you create an extension. When you create a new version,\n specify the most recent current version number. For example, you create version 3, enter 2\n for this field.
", + "smithy.api#httpHeader": "Latest-Version-Number" } } } @@ -744,7 +1109,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new configuration in the AppConfig hosted configuration store.
", + "smithy.api#documentation": "Creates a new configuration in the AppConfig hosted configuration\n store.
", "smithy.api#http": { "method": "POST", "uri": "/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions", @@ -809,6 +1174,9 @@ "input": { "target": "com.amazonaws.appconfig#DeleteApplicationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.appconfig#BadRequestException" @@ -847,6 +1215,9 @@ "input": { "target": "com.amazonaws.appconfig#DeleteConfigurationProfileRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.appconfig#BadRequestException" @@ -896,6 +1267,9 @@ "input": { "target": "com.amazonaws.appconfig#DeleteDeploymentStrategyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.appconfig#BadRequestException" @@ -934,13 +1308,93 @@ "input": { "target": "com.amazonaws.appconfig#DeleteEnvironmentRequest" }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#ConflictException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + }, + { + "target": "com.amazonaws.appconfig#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an environment. Deleting an environment does not delete a configuration from a\n host.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{ApplicationId}/environments/{EnvironmentId}", + "code": 204 + } + } + }, + "com.amazonaws.appconfig#DeleteEnvironmentRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "The application ID that includes the environment that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EnvironmentId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "The ID of the environment that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appconfig#DeleteExtension": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#DeleteExtensionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + }, + { + "target": "com.amazonaws.appconfig#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an AppConfig extension. You must delete all associations to an\n extension before you delete the extension.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/extensions/{ExtensionIdentifier}", + "code": 204 + } + } + }, + "com.amazonaws.appconfig#DeleteExtensionAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#DeleteExtensionAssociationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.appconfig#BadRequestException" }, - { - "target": "com.amazonaws.appconfig#ConflictException" - }, { "target": "com.amazonaws.appconfig#InternalServerException" }, @@ -949,32 +1403,45 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an environment. Deleting an environment does not delete a configuration from a\n host.
", + "smithy.api#documentation": "Deletes an extension association. This action doesn't delete extensions defined in the\n association.
", "smithy.api#http": { "method": "DELETE", - "uri": "/applications/{ApplicationId}/environments/{EnvironmentId}", + "uri": "/extensionassociations/{ExtensionAssociationId}", "code": 204 } } }, - "com.amazonaws.appconfig#DeleteEnvironmentRequest": { + "com.amazonaws.appconfig#DeleteExtensionAssociationRequest": { "type": "structure", "members": { - "ApplicationId": { + "ExtensionAssociationId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "The application ID that includes the environment that you want to delete.
", + "smithy.api#documentation": "The ID of the extension association to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "EnvironmentId": { - "target": "com.amazonaws.appconfig#Id", + } + } + }, + "com.amazonaws.appconfig#DeleteExtensionRequest": { + "type": "structure", + "members": { + "ExtensionIdentifier": { + "target": "com.amazonaws.appconfig#Identifier", "traits": { - "smithy.api#documentation": "The ID of the environment that you want to delete.
", + "smithy.api#documentation": "The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "VersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "A specific version of an extension to delete. If omitted, the highest version is\n deleted.
", + "smithy.api#httpQuery": "version" + } } } }, @@ -983,6 +1450,9 @@ "input": { "target": "com.amazonaws.appconfig#DeleteHostedConfigurationVersionRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.appconfig#BadRequestException" @@ -1110,7 +1580,7 @@ "FinalBakeTimeInMinutes": { "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "The amount of time that AppConfig monitored for alarms before considering the deployment\n to be complete and no longer eligible for automatic rollback.
" + "smithy.api#documentation": "The amount of time that AppConfig monitored for alarms before considering the\n deployment to be complete and no longer eligible for automatic rollback.
" } }, "State": { @@ -1142,6 +1612,12 @@ "traits": { "smithy.api#documentation": "The time the deployment completed.
" } + }, + "AppliedExtensions": { + "target": "com.amazonaws.appconfig#AppliedExtensions", + "traits": { + "smithy.api#documentation": "A list of extensions that were processed as part of the deployment. The extensions that\n were previously associated to the configuration profile, environment, or the application\n when StartDeployment was called.
The entity that triggered the deployment event. Events can be triggered by a user,\n AppConfig, an Amazon CloudWatch alarm, or an internal error.
" + "smithy.api#documentation": "The entity that triggered the deployment event. Events can be triggered by a user,\n AppConfig, an Amazon CloudWatch alarm, or an internal error.
" } }, "Description": { @@ -1166,6 +1642,12 @@ "smithy.api#documentation": "A description of the deployment event. Descriptions include, but are not limited to, the\n user account or the Amazon CloudWatch alarm ARN that initiated a rollback, the percentage of hosts\n that received the deployment, or in the case of an internal error, a recommendation to\n attempt a new deployment.
" } }, + "ActionInvocations": { + "target": "com.amazonaws.appconfig#ActionInvocations", + "traits": { + "smithy.api#documentation": "The list of extensions that were invoked as part of the deployment.
" + } + }, "OccurredAt": { "target": "com.amazonaws.appconfig#Iso8601DateTime", "traits": { @@ -1310,7 +1792,7 @@ "FinalBakeTimeInMinutes": { "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "The amount of time that AppConfig monitored for alarms before considering the deployment\n to be complete and no longer eligible for automatic rollback.
" + "smithy.api#documentation": "The amount of time that AppConfig monitored for alarms before considering the\n deployment to be complete and no longer eligible for automatic rollback.
" } }, "ReplicateTo": { @@ -1375,7 +1857,7 @@ "FinalBakeTimeInMinutes": { "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "The amount of time that AppConfig monitors for alarms before considering the deployment\n to be complete and no longer eligible for automatic rollback.
" + "smithy.api#documentation": "The amount of time that AppConfig monitors for alarms before considering the\n deployment to be complete and no longer eligible for automatic rollback.
" } }, "State": { @@ -1520,6 +2002,204 @@ } } }, + "com.amazonaws.appconfig#Extension": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "The system-generated ID of the extension.
" + } + }, + "Name": { + "target": "com.amazonaws.appconfig#Name", + "traits": { + "smithy.api#documentation": "The extension name.
" + } + }, + "VersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#documentation": "The extension version number.
" + } + }, + "Arn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The system-generated Amazon Resource Name (ARN) for the extension.
" + } + }, + "Description": { + "target": "com.amazonaws.appconfig#Description", + "traits": { + "smithy.api#documentation": "Information about the extension.
" + } + }, + "Actions": { + "target": "com.amazonaws.appconfig#ActionsMap", + "traits": { + "smithy.api#documentation": "The actions defined in the extension.
" + } + }, + "Parameters": { + "target": "com.amazonaws.appconfig#ParameterMap", + "traits": { + "smithy.api#documentation": "The parameters accepted by the extension. You specify parameter values when you\n associate the extension to an AppConfig resource by using the\n CreateExtensionAssociation API action. For Lambda extension\n actions, these parameters are included in the Lambda request object.
The system-generated ID for the association.
" + } + }, + "ExtensionArn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the extension defined in the association.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The ARNs of applications, configuration profiles, or environments defined in the\n association.
" + } + }, + "Arn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The system-generated Amazon Resource Name (ARN) for the extension.
" + } + }, + "Parameters": { + "target": "com.amazonaws.appconfig#ParameterValueMap", + "traits": { + "smithy.api#documentation": "The parameter names and values defined in the association.
" + } + }, + "ExtensionVersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#documentation": "The version number for the extension defined in the association.
" + } + } + } + }, + "com.amazonaws.appconfig#ExtensionAssociationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.appconfig#ExtensionAssociationSummary" + } + }, + "com.amazonaws.appconfig#ExtensionAssociationSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.appconfig#Identifier", + "traits": { + "smithy.api#documentation": "The extension association ID. This ID is used to call other\n ExtensionAssociation API actions such as\n GetExtensionAssociation or DeleteExtensionAssociation.
The system-generated Amazon Resource Name (ARN) for the extension.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The ARNs of applications, configuration profiles, or environments defined in the\n association.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an association between an extension and an AppConfig\n resource such as an application, environment, or configuration profile. Call\n GetExtensionAssociation to get more information about an\n association.
The list of extension associations. Each item represents an extension association to an\n application, environment, or configuration profile.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. Use this token to get the next set of\n results.
" + } + } + } + }, + "com.amazonaws.appconfig#ExtensionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.appconfig#ExtensionSummary" + } + }, + "com.amazonaws.appconfig#ExtensionSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "The system-generated ID of the extension.
" + } + }, + "Name": { + "target": "com.amazonaws.appconfig#Name", + "traits": { + "smithy.api#documentation": "The extension name.
" + } + }, + "VersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#documentation": "The extension version number.
" + } + }, + "Arn": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The system-generated Amazon Resource Name (ARN) for the extension.
" + } + }, + "Description": { + "target": "com.amazonaws.appconfig#Description", + "traits": { + "smithy.api#documentation": "Information about the extension.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an extension. Call GetExtension to get more information\n about an extension.
The list of available extensions. The list includes Amazon Web Services-authored and\n user-created extensions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. Use this token to get the next set of\n results.
" + } + } + } + }, "com.amazonaws.appconfig#Float": { "type": "float" }, @@ -1587,7 +2267,7 @@ "smithy.api#deprecated": { "message": "This API has been deprecated in favor of the GetLatestConfiguration API used in conjunction with StartConfigurationSession." }, - "smithy.api#documentation": "Retrieves the latest deployed configuration.
\n\nNote the following important information.
\nThis API action has been deprecated. Calls to receive configuration data should\n use the StartConfigurationSession and GetLatestConfiguration APIs instead.
\n\n GetConfiguration is a priced call. For more information, see\n Pricing.
AppConfig uses the value of the ClientConfigurationVersion\n parameter to identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration.\n You are charged each time your clients receive a configuration.
To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration\n version on your behalf. If you choose to continue using\n GetConfiguration, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. The value to use for\n ClientConfigurationVersion comes from the\n ConfigurationVersion attribute returned by\n GetConfiguration when there is new or updated data, and should be\n saved for subsequent calls to GetConfiguration.
Retrieves the latest deployed configuration.
\n\nNote the following important information.
\nThis API action has been deprecated. Calls to receive configuration data should\n use the StartConfigurationSession and GetLatestConfiguration APIs instead.
\n\n GetConfiguration is a priced call. For more information, see\n Pricing.
AppConfig uses the value of the\n ClientConfigurationVersion parameter to identify the configuration\n version on your clients. If you don’t send ClientConfigurationVersion\n with each call to GetConfiguration, your clients receive the current\n configuration. You are charged each time your clients receive a\n configuration.
To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration\n version on your behalf. If you choose to continue using\n GetConfiguration, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. The value to use for\n ClientConfigurationVersion comes from the\n ConfigurationVersion attribute returned by\n GetConfiguration when there is new or updated data, and should be\n saved for subsequent calls to GetConfiguration.
The clientId parameter in the following command is a unique, user-specified ID to\n identify the client for the configuration. This ID enables AppConfig to deploy the\n configuration in intervals, as defined in the deployment strategy.
", + "smithy.api#documentation": "The clientId parameter in the following command is a unique, user-specified ID to\n identify the client for the configuration. This ID enables AppConfig to deploy\n the configuration in intervals, as defined in the deployment strategy.
", "smithy.api#httpQuery": "client_id", "smithy.api#required": {} } @@ -1682,7 +2362,7 @@ "ClientConfigurationVersion": { "target": "com.amazonaws.appconfig#Version", "traits": { - "smithy.api#documentation": "The configuration version returned in the most recent GetConfiguration\n response.
AppConfig uses the value of the ClientConfigurationVersion parameter to\n identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration. You\n are charged each time your clients receive a configuration.
To avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.
For more information about working with configurations, see Retrieving the\n Configuration in the AppConfig User Guide.
", + "smithy.api#documentation": "The configuration version returned in the most recent GetConfiguration\n response.
AppConfig uses the value of the ClientConfigurationVersion\n parameter to identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration. You\n are charged each time your clients receive a configuration.
To avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.
For more information about working with configurations, see Retrieving the\n Configuration in the AppConfig User Guide.
", "smithy.api#httpQuery": "client_configuration_version" } } @@ -1807,7 +2487,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about an environment. An environment is a logical deployment group\n of AppConfig applications, such as applications in a Production environment or\n in an EU_Region environment. Each configuration deployment targets an\n environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is\n triggered during a deployment, AppConfig roles back the configuration.
Retrieves information about an environment. An environment is a deployment group of\n AppConfig applications, such as applications in a Production\n environment or in an EU_Region environment. Each configuration deployment\n targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If\n an alarm is triggered during a deployment, AppConfig roles back the\n configuration.
Returns information about an AppConfig extension.
", + "smithy.api#http": { + "method": "GET", + "uri": "/extensions/{ExtensionIdentifier}", + "code": 200 + } + } + }, + "com.amazonaws.appconfig#GetExtensionAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#GetExtensionAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appconfig#ExtensionAssociation" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + }, + { + "target": "com.amazonaws.appconfig#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an AppConfig extension association. For more\n information about extensions and associations, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/extensionassociations/{ExtensionAssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.appconfig#GetExtensionAssociationRequest": { + "type": "structure", + "members": { + "ExtensionAssociationId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "The extension association ID to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appconfig#GetExtensionRequest": { + "type": "structure", + "members": { + "ExtensionIdentifier": { + "target": "com.amazonaws.appconfig#Identifier", + "traits": { + "smithy.api#documentation": "The name, the ID, or the Amazon Resource Name (ARN) of the extension.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The extension version number. If no version number was defined, AppConfig uses\n the highest version.
", + "smithy.api#httpQuery": "version_number" + } + } + } + }, "com.amazonaws.appconfig#GetHostedConfigurationVersion": { "type": "operation", "input": { @@ -2031,6 +2801,15 @@ "smithy.api#pattern": "^[a-z0-9]{4,7}$" } }, + "com.amazonaws.appconfig#Identifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.appconfig#Integer": { "type": "integer" }, @@ -2073,6 +2852,12 @@ "traits": { "smithy.api#documentation": "The type of error for an invalid configuration.
" } + }, + "Value": { + "target": "com.amazonaws.appconfig#String", + "traits": { + "smithy.api#documentation": "Details about an error with Lambda when a synchronous extension\n experiences an error during an invocation.
" + } } }, "traits": { @@ -2135,7 +2920,7 @@ "NextToken": { "target": "com.amazonaws.appconfig#NextToken", "traits": { - "smithy.api#documentation": "A token to start the list. Next token is a pagination token generated by AppConfig to\n describe what page the previous List call ended on. For the first List request, the\n nextToken should not be set. On subsequent calls, the nextToken parameter should be set to\n the previous responses nextToken value. Use this token to get the next set of results.\n
", + "smithy.api#documentation": "A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List\n request, the nextToken should not be set. On subsequent calls, the nextToken parameter\n should be set to the previous responses nextToken value. Use this token to get the next set\n of results.
", "smithy.api#httpQuery": "next_token" } } @@ -2389,6 +3174,135 @@ } } }, + "com.amazonaws.appconfig#ListExtensionAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#ListExtensionAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.appconfig#ExtensionAssociations" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all AppConfig extension associations in the account. For more\n information about extensions and associations, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/extensionassociations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.appconfig#ListExtensionAssociationsRequest": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.appconfig#Arn", + "traits": { + "smithy.api#documentation": "The ARN of an application, configuration profile, or environment.
", + "smithy.api#httpQuery": "resource_identifier" + } + }, + "ExtensionIdentifier": { + "target": "com.amazonaws.appconfig#Identifier", + "traits": { + "smithy.api#documentation": "The name, the ID, or the Amazon Resource Name (ARN) of the extension.
", + "smithy.api#httpQuery": "extension_identifier" + } + }, + "ExtensionVersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The version number for the extension defined in the association.
", + "smithy.api#httpQuery": "extension_version_number" + } + }, + "MaxResults": { + "target": "com.amazonaws.appconfig#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that\n you can specify in a subsequent call to get the next set of results.
", + "smithy.api#httpQuery": "max_results" + } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", + "traits": { + "smithy.api#documentation": "A token to start the list. Use this token to get the next set of results or pass null to\n get the first set of results.
", + "smithy.api#httpQuery": "next_token" + } + } + } + }, + "com.amazonaws.appconfig#ListExtensions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#ListExtensionsRequest" + }, + "output": { + "target": "com.amazonaws.appconfig#Extensions" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all custom and Amazon Web Services-authored AppConfig extensions in the\n account. For more information about extensions, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/extensions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.appconfig#ListExtensionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.appconfig#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of items to return for this call. The call also returns a token that\n you can specify in a subsequent call to get the next set of results.
", + "smithy.api#httpQuery": "max_results" + } + }, + "NextToken": { + "target": "com.amazonaws.appconfig#NextToken", + "traits": { + "smithy.api#documentation": "A token to start the list. Use this token to get the next set of results.
", + "smithy.api#httpQuery": "next_token" + } + }, + "Name": { + "target": "com.amazonaws.appconfig#QueryName", + "traits": { + "smithy.api#documentation": "The extension name.
", + "smithy.api#httpQuery": "name" + } + } + } + }, "com.amazonaws.appconfig#ListHostedConfigurationVersions": { "type": "operation", "input": { @@ -2499,6 +3413,15 @@ } } }, + "com.amazonaws.appconfig#LongName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.appconfig#MaxResults": { "type": "integer", "traits": { @@ -2530,7 +3453,7 @@ "AlarmRoleArn": { "target": "com.amazonaws.appconfig#RoleArn", "traits": { - "smithy.api#documentation": "ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.
ARN of an Identity and Access Management (IAM) role for AppConfig to monitor\n AlarmArn.
Information about the parameter.
" + } + }, + "Required": { + "target": "com.amazonaws.appconfig#Boolean", + "traits": { + "smithy.api#documentation": "A parameter value must be specified in the extension association.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered\n in an extension when invoked. Parameter values are specified in an extension association.\n For more information about extensions, see Working with\n AppConfig extensions in the\n AppConfig User Guide.
" + } + }, + "com.amazonaws.appconfig#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appconfig#Name" + }, + "value": { + "target": "com.amazonaws.appconfig#Parameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.appconfig#ParameterValueMap": { + "type": "map", + "key": { + "target": "com.amazonaws.appconfig#Name" + }, + "value": { + "target": "com.amazonaws.appconfig#StringWithLengthBetween1And2048" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.appconfig#PayloadTooLargeException": { "type": "structure", "members": { @@ -2599,6 +3572,15 @@ } } }, + "com.amazonaws.appconfig#QueryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.appconfig#ReplicateTo": { "type": "string", "traits": { @@ -2636,7 +3618,7 @@ "Tags": { "target": "com.amazonaws.appconfig#TagMap", "traits": { - "smithy.api#documentation": "Metadata to assign to AppConfig resources. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of which you\n define.
" + "smithy.api#documentation": "Metadata to assign to AppConfig resources. Tags help organize and categorize\n your AppConfig resources. Each tag consists of a key and an optional value, both\n of which you define.
" } } } @@ -2659,7 +3641,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of hosted configuration versions exceeds the limit for the AppConfig hosted\n configuration store. Delete one or more versions and try again.
", + "smithy.api#documentation": "The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -2744,7 +3726,7 @@ "Tags": { "target": "com.amazonaws.appconfig#TagMap", "traits": { - "smithy.api#documentation": "Metadata to assign to the deployment. Tags help organize and categorize your AppConfig\n resources. Each tag consists of a key and an optional value, both of which you\n define.
" + "smithy.api#documentation": "Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which\n you define.
" } } } @@ -2888,6 +3870,9 @@ "input": { "target": "com.amazonaws.appconfig#TagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.appconfig#BadRequestException" @@ -2900,7 +3885,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns\n metadata\n to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each\n tag consists of a key and an optional value, both of which you define. You can specify a\n maximum of 50 tags for a resource.
", + "smithy.api#documentation": "Assigns metadata to an AppConfig resource. Tags help organize and categorize\n your AppConfig resources. Each tag consists of a key and an optional value, both\n of which you define. You can specify a maximum of 50 tags for a resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", @@ -2965,6 +3950,9 @@ "input": { "target": "com.amazonaws.appconfig#UntagResourceRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.appconfig#BadRequestException" @@ -3188,7 +4176,7 @@ "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The amount of time that AppConfig monitors for alarms before considering the deployment\n to be complete and no longer eligible for automatic rollback.
" + "smithy.api#documentation": "The amount of time that AppConfig monitors for alarms before considering the\n deployment to be complete and no longer eligible for automatic rollback.
" } }, "GrowthFactor": { @@ -3201,7 +4189,7 @@ "GrowthType": { "target": "com.amazonaws.appconfig#GrowthType", "traits": { - "smithy.api#documentation": "The algorithm used to define how percentage grows over time. AppConfig supports the\n following growth types:
\n\n Linear: For this type, AppConfig processes the\n deployment by increments of the growth factor evenly distributed over the deployment time.\n For example, a linear deployment that uses a growth factor of 20 initially makes the\n configuration available to 20 percent of the targets. After 1/5th of the deployment time\n has passed, the system updates the percentage to 40 percent. This continues until 100% of\n the targets are set to receive the deployed configuration.
\n\n\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:
\n 2*(2^0)\n
\n 2*(2^1)\n
\n 2*(2^2)\n
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.
" + "smithy.api#documentation": "The algorithm used to define how percentage grows over time. AppConfig\n supports the following growth types:
\n\n Linear: For this type, AppConfig processes\n the deployment by increments of the growth factor evenly distributed over the deployment\n time. For example, a linear deployment that uses a growth factor of 20 initially makes the\n configuration available to 20 percent of the targets. After 1/5th of the deployment time\n has passed, the system updates the percentage to 40 percent. This continues until 100% of\n the targets are set to receive the deployed configuration.
\n\n\n Exponential: For this type, AppConfig\n processes the deployment exponentially using the following formula: G*(2^N).\n In this formula, G is the growth factor specified by the user and\n N is the number of steps until the configuration is deployed to all\n targets. For example, if you specify a growth factor of 2, then the system rolls out the\n configuration as follows:
\n 2*(2^0)\n
\n 2*(2^1)\n
\n 2*(2^2)\n
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.
" } } } @@ -3273,6 +4261,122 @@ } } }, + "com.amazonaws.appconfig#UpdateExtension": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#UpdateExtensionRequest" + }, + "output": { + "target": "com.amazonaws.appconfig#Extension" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#ConflictException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + }, + { + "target": "com.amazonaws.appconfig#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an AppConfig extension. For more information about extensions, see\n Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/extensions/{ExtensionIdentifier}", + "code": 200 + } + } + }, + "com.amazonaws.appconfig#UpdateExtensionAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.appconfig#UpdateExtensionAssociationRequest" + }, + "output": { + "target": "com.amazonaws.appconfig#ExtensionAssociation" + }, + "errors": [ + { + "target": "com.amazonaws.appconfig#BadRequestException" + }, + { + "target": "com.amazonaws.appconfig#InternalServerException" + }, + { + "target": "com.amazonaws.appconfig#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an association. For more information about extensions and associations, see\n Working with\n AppConfig extensions in the\n AppConfig User Guide.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/extensionassociations/{ExtensionAssociationId}", + "code": 200 + } + } + }, + "com.amazonaws.appconfig#UpdateExtensionAssociationRequest": { + "type": "structure", + "members": { + "ExtensionAssociationId": { + "target": "com.amazonaws.appconfig#Id", + "traits": { + "smithy.api#documentation": "The system-generated ID for the association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.appconfig#ParameterValueMap", + "traits": { + "smithy.api#documentation": "The parameter names and values defined in the extension.
" + } + } + } + }, + "com.amazonaws.appconfig#UpdateExtensionRequest": { + "type": "structure", + "members": { + "ExtensionIdentifier": { + "target": "com.amazonaws.appconfig#Identifier", + "traits": { + "smithy.api#documentation": "The name, the ID, or the Amazon Resource Name (ARN) of the extension.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appconfig#Description", + "traits": { + "smithy.api#documentation": "Information about the extension.
" + } + }, + "Actions": { + "target": "com.amazonaws.appconfig#ActionsMap", + "traits": { + "smithy.api#documentation": "The actions defined in the extension.
" + } + }, + "Parameters": { + "target": "com.amazonaws.appconfig#ParameterMap", + "traits": { + "smithy.api#documentation": "One or more parameters for the actions called by the extension.
" + } + }, + "VersionNumber": { + "target": "com.amazonaws.appconfig#Integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The extension version number.
" + } + } + } + }, "com.amazonaws.appconfig#Uri": { "type": "string", "traits": { @@ -3287,6 +4391,9 @@ "input": { "target": "com.amazonaws.appconfig#ValidateConfigurationRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.appconfig#BadRequestException" @@ -3342,7 +4449,7 @@ "Type": { "target": "com.amazonaws.appconfig#ValidatorType", "traits": { - "smithy.api#documentation": "AppConfig supports validators of type JSON_SCHEMA and\n LAMBDA\n
AppConfig supports validators of type JSON_SCHEMA and\n LAMBDA\n
Provides information about an Athena query error. The\n AthenaError feature provides standardized error information to help you\n understand failed queries and take steps after a query failure occurs.\n AthenaError includes an ErrorCategory field that specifies\n whether the cause of the failed query is due to system error, user error, or other\n error.
Contains an array of named query IDs.
" } }, "com.amazonaws.athena#BatchGetNamedQueryOutput": { @@ -349,6 +362,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Contains an array of query execution IDs.
" } }, "com.amazonaws.athena#BatchGetQueryExecutionOutput": { @@ -2460,7 +2476,14 @@ } }, "com.amazonaws.athena#NamedQueryId": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^\\S+$" + } }, "com.amazonaws.athena#NamedQueryIdList": { "type": "list", @@ -2669,7 +2692,14 @@ } }, "com.amazonaws.athena#QueryExecutionId": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^\\S+$" + } }, "com.amazonaws.athena#QueryExecutionIdList": { "type": "list", @@ -2835,7 +2865,7 @@ "type": "structure", "members": { "OutputLocation": { - "target": "com.amazonaws.athena#String", + "target": "com.amazonaws.athena#ResultOutputLocation", "traits": { "smithy.api#documentation": "The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. To run the query, you must specify the\n query results location using one of the ways: either for individual queries using either\n this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena\n issues an error that no output location is provided. For more information, see Query Results. If\n workgroup settings override client-side settings, then the query uses the settings\n specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.
This is a client-side setting. If workgroup settings override client-side settings,\n then the query uses the ExpectedBucketOwner setting that is specified for\n the workgroup, and also uses the location for storing query results specified in the\n workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration\n and Workgroup Settings Override Client-Side Settings.
The location in Amazon S3 where your query results are stored, such as\n s3://path/to/query/bucket/. For more information, see Query Results If\n workgroup settings override client-side settings, then the query uses the location for\n the query results and the encryption configuration that are specified for the workgroup.\n The \"workgroup settings override\" is specified in\n EnforceWorkGroupConfiguration (true/false) in the\n WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.\n If set, Athena uses the value for ExpectedBucketOwner when it\n makes Amazon S3 calls to your specified output location. If the\n ExpectedBucketOwner\n Amazon Web Services account ID does not match the actual owner of the Amazon S3\n bucket, the call fails with a permissions error.
If workgroup settings override client-side settings, then the query uses the\n ExpectedBucketOwner setting that is specified for the workgroup, and\n also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.
The information about the updates in the query results, such as output location and\n encryption configuration for the query results.
" } }, + "com.amazonaws.athena#ResultOutputLocation": { + "type": "string" + }, "com.amazonaws.athena#ResultSet": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/backup.json b/codegen/sdk/aws-models/backup.json index 0c98c38a3c6..884ed9c8b1f 100644 --- a/codegen/sdk/aws-models/backup.json +++ b/codegen/sdk/aws-models/backup.json @@ -494,7 +494,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" } }, "RecoveryPointTags": { @@ -564,7 +564,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" } }, "RecoveryPointTags": { @@ -634,7 +634,7 @@ "ListOfTags": { "target": "com.amazonaws.backup#ListOfTags", "traits": { - "smithy.api#documentation": "A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\"Department\": \"accounting\". Condition\n operators are case sensitive.
\n ListOfTags differs from Conditions as follows:
When you specify more than one condition, you assign all resources that match AT\n LEAST ONE condition (using OR logic).
\n\n ListOfTags only supports StringEquals.\n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike.
A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\n \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\",\n \"ConditionValue\": \"true\"\n },. Condition\n operators are case sensitive.
\n ListOfTags differs from Conditions as follows:
When you specify more than one condition, you assign all resources that match AT\n LEAST ONE condition (using OR logic).
\n\n ListOfTags only supports StringEquals.\n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike.
A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\"Department\": \"accounting\". Condition\n operators are case sensitive.
\n Conditions differs from ListOfTags as follows:
When you specify more than one condition, you only assign the resources that match\n ALL conditions (using AND logic).
\n\n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike. ListOfTags only supports\n StringEquals.
A list of conditions that you define to assign resources to your backup plans using\n tags. For example, \"StringEquals\": {\n \"ConditionKey\": \"aws:ResourceTag/CreatedByCryo\",\n \"ConditionValue\": \"true\"\n },. Condition\n operators are case sensitive.
\n Conditions differs from ListOfTags as follows:
When you specify more than one condition, you only assign the resources that match\n ALL conditions (using AND logic).
\n\n Conditions supports StringEquals,\n StringLike, StringNotEquals, and\n StringNotLike. ListOfTags only supports\n StringEquals.
Used to specify a set of resources to a backup plan.
" + "smithy.api#documentation": "Used to specify a set of resources to a backup plan.
\nSpecifying your desired Conditions, ListOfTags, NotResources, \n and/or Resources is recommended. If none of these are specified, Backup will attempt to \n select all supported and opted-in storage resources, which could have unintended cost implications.
Contains DeleteAt and MoveToColdStorageAt timestamps, which\n are used to specify a lifecycle for a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "Contains DeleteAt and MoveToColdStorageAt timestamps, which\n are used to specify a lifecycle for a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" } }, "com.amazonaws.backup#ComplianceResourceIdList": { @@ -3120,7 +3120,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" } }, "EncryptionKeyArn": { @@ -4336,7 +4336,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains an array of Transition objects specifying how long in days before\n a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, on the console, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "Contains an array of Transition objects specifying how long in days before\n a recovery point transitions to cold storage or is deleted.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, on the console, the “retention” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" } }, "com.amazonaws.backup#LimitExceededException": { @@ -6093,7 +6093,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" } }, "EncryptionKeyArn": { @@ -6764,7 +6764,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" } }, "RecoveryPointTags": { @@ -7016,8 +7016,7 @@ "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create\n the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create\n the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.
Sets the transition lifecycle of a recovery point.
\nThe lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
\nThis operation does not support continuous backups.
", + "smithy.api#documentation": "Sets the transition lifecycle of a recovery point.
\nThe lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
\nThis operation does not support continuous backups.
", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", @@ -7550,7 +7549,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nOnly resource types that support full Backup management can transition their\n backups to cold storage. Those resource types are listed in the \"Full Backup\n management\" section of the Feature\n availability by resource table. Backup ignores this expression for\n other resource types.
" + "smithy.api#documentation": "The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.
\nBackups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “retention” setting must be 90 days greater than the “transition to\n cold after days” setting. The “transition to cold after days” setting cannot be changed\n after a backup has been transitioned to cold.
\nResource types that are able to be transitioned to cold storage are listed in the \"Lifecycle to cold storage\" \n section of the \n Feature availability by resource table. Backup ignores this expression for\n other resource types.
" } }, "CalculatedLifecycle": { diff --git a/codegen/sdk/aws-models/chime-sdk-meetings.json b/codegen/sdk/aws-models/chime-sdk-meetings.json index c5f92b38a55..29e7447fd7c 100644 --- a/codegen/sdk/aws-models/chime-sdk-meetings.json +++ b/codegen/sdk/aws-models/chime-sdk-meetings.json @@ -64,7 +64,7 @@ "Capabilities": { "target": "com.amazonaws.chimesdkmeetings#AttendeeCapabilities", "traits": { - "smithy.api#documentation": "The capabilities (audio, video, or content) assigned to an attendee.
" + "smithy.api#documentation": "The capabilities assigned to an attendee: audio, video, or content.
\nYou use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .
When using capabilities, be aware of these corner cases:
\nYou can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.
When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.
When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
The media capabilities of an attendee, including audio, video and content.
" + "smithy.api#documentation": "The media capabilities of an attendee: audio, video, or content.
\nYou use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .
When using capabilities, be aware of these corner cases:
\nYou can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.
When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.
When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.
Updates AttendeeCapabilities except the capabilities listed in an ExcludedAttendeeIds table.
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .
When using capabilities, be aware of these corner cases:
\nYou can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.
When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.
When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
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.
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.
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .
When using capabilities, be aware of these corner cases:
\nYou can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.
When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.
When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
When specified, replicates the media from the primary meeting to the new meeting.
" } + }, + "TenantIds": { + "target": "com.amazonaws.chimesdkmeetings#TenantIdList", + "traits": { + "smithy.api#documentation": "A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
" + } } } }, @@ -755,6 +761,12 @@ "traits": { "smithy.api#documentation": "When specified, replicates the media from the primary meeting to the new meeting.
" } + }, + "TenantIds": { + "target": "com.amazonaws.chimesdkmeetings#TenantIdList", + "traits": { + "smithy.api#documentation": "A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.
" + } } } }, @@ -940,7 +952,7 @@ "Region": { "target": "com.amazonaws.chimesdkmeetings#TranscribeMedicalRegion", "traits": { - "smithy.api#documentation": "The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" + "smithy.api#documentation": "The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.
" } }, "ContentIdentificationType": { @@ -1483,6 +1495,12 @@ "traits": { "smithy.api#documentation": "When specified, replicates the media from the primary meeting to this meeting.
" } + }, + "TenantIds": { + "target": "com.amazonaws.chimesdkmeetings#TenantIdList", + "traits": { + "smithy.api#documentation": "Array of strings.
" + } } }, "traits": { @@ -1602,7 +1620,7 @@ } }, "traits": { - "smithy.api#documentation": "The service is currently unavailable.
", + "smithy.api#documentation": "The service encountered an unexpected error.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1767,6 +1785,28 @@ } } }, + "com.amazonaws.chimesdkmeetings#TenantId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 256 + }, + "smithy.api#pattern": "^(?!.*?(.)\\1{3})[-_!@#$a-zA-Z0-9]*$" + } + }, + "com.amazonaws.chimesdkmeetings#TenantIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmeetings#TenantId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.chimesdkmeetings#ThrottlingException": { "type": "structure", "members": { @@ -1781,7 +1821,7 @@ } }, "traits": { - "smithy.api#documentation": "The number of requests exceeds the limit.
", + "smithy.api#documentation": "The number of customer requests exceeds the request rate limit.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2186,7 +2226,7 @@ } ], "traits": { - "smithy.api#documentation": "The capabilties that you want to update.
", + "smithy.api#documentation": "The capabilties that you want to update.
\nYou use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see \n .
When using capabilities, be aware of these corner cases:
\nYou can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive \n or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability \n to receive and you set your content capability to not receive.
When you change an audio capability from None or Receive to Send or SendReceive , \n and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.
When you change a video or content capability from None or Receive to Send or SendReceive , \n and if the attendee turned on their video or content streams, remote attendess can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
The updated attendee data.
" + } } } } diff --git a/codegen/sdk/aws-models/codeartifact.json b/codegen/sdk/aws-models/codeartifact.json index b32d5b2e9ea..57161996ee4 100644 --- a/codegen/sdk/aws-models/codeartifact.json +++ b/codegen/sdk/aws-models/codeartifact.json @@ -55,6 +55,36 @@ "smithy.api#pattern": "^[0-9]{12}$" } }, + "com.amazonaws.codeartifact#AllowPublish": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOW", + "name": "ALLOW" + }, + { + "value": "BLOCK", + "name": "BLOCK" + } + ] + } + }, + "com.amazonaws.codeartifact#AllowUpstream": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALLOW", + "name": "ALLOW" + }, + { + "value": "BLOCK", + "name": "BLOCK" + } + ] + } + }, "com.amazonaws.codeartifact#Arn": { "type": "string", "traits": { @@ -192,7 +222,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 public:npmjs - for the npm public repository.\n
\n public:nuget-org - for the NuGet Gallery.\n
\n public:pypi - for the Python Package Index.\n
\n public:maven-central - for Maven Central.\n
\n public:maven-googleandroid - for the Google Android repository.\n
\n public:maven-gradleplugins - for the Gradle plugins repository.\n
\n public:maven-commonsware - for the CommonsWare Android repository.\n
\n The name of the external connection to add to the repository. The following values are supported:\n
\n\n public:npmjs - for the npm public repository.\n
\n public:pypi - for the Python Package Index.\n
\n public:maven-central - for Maven Central.\n
\n public:maven-googleandroid - for the Google Android repository.\n
\n public:maven-gradleplugins - for the Gradle plugins repository.\n
\n public:maven-commonsware - for the CommonsWare Android repository.\n
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
\nUse the information in this guide to help you work with the following CodeArtifact components:
\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 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).
\nEach repository is a member of a single domain and can't be moved to a\n different domain.
\nThe 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.
\nAlthough 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 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.
\nIn CodeArtifact, a package consists of:
\nA name (for example, webpack is the name of a\n popular npm package)
An optional namespace (for example, @types in @types/node)
A set of versions (for example, 1.0.0, 1.0.1,\n 1.0.2, etc.)
Package-level metadata (for example, npm tags)
\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 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 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.
CodeArtifact supports these operations:
\n\n AssociateExternalConnection: Adds an existing external \n connection to a repository.\n
\n CopyPackageVersions: Copies package versions from one \n repository to another repository in the same domain.
\n CreateDomain: Creates a domain
\n CreateRepository: Creates a CodeArtifact repository in a domain.
\n DeleteDomain: Deletes a domain. You cannot delete a domain that contains\n repositories.
\n DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.
\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 DeleteRepository: Deletes a repository. \n
\n DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
\n DescribeDomain: Returns a DomainDescription object that\n contains information about the requested domain.
\n DescribePackageVersion: Returns a PackageVersionDescription\n object that contains details about a package version.
\n DescribeRepository: Returns a RepositoryDescription object\n that contains detailed information about the requested repository.
\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 DisassociateExternalConnection: Removes an existing external connection from a repository. \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 GetDomainPermissionsPolicy: Returns the policy of a resource\n that is attached to the specified domain.
\n GetPackageVersionAsset: Returns the contents of an asset that is in a package version.
\n GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.
\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 maven\n
\n npm\n
\n nuget\n
\n pypi\n
\n GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository. \n
\n ListDomains: Returns a list of DomainSummary objects. Each\n returned DomainSummary object contains information about a domain.
\n ListPackages: Lists the packages in a repository.
\n ListPackageVersionAssets: Lists the assets for a given package version.
\n ListPackageVersionDependencies: Returns a list of the direct dependencies for a\n package version.
\n ListPackageVersions: Returns a list of package versions for a specified\n package in a repository.
\n ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.
\n ListRepositoriesInDomain: Returns a list of the repositories in a domain.
\n PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
\n PutRepositoryPermissionsPolicy: Sets the resource policy on a repository\n that specifies permissions to access it.
\n UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
\n UpdateRepository: Updates the properties of a repository.
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
\nUse the information in this guide to help you work with the following CodeArtifact components:
\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 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).
\nEach repository is a member of a single domain and can't be moved to a\n different domain.
\nThe 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.
\nAlthough 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 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.
\nIn CodeArtifact, a package consists of:
\nA name (for example, webpack is the name of a\n popular npm package)
An optional namespace (for example, @types in @types/node)
A set of versions (for example, 1.0.0, 1.0.1,\n 1.0.2, etc.)
Package-level metadata (for example, npm tags)
\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 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 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.
CodeArtifact supports these operations:
\n\n AssociateExternalConnection: Adds an existing external \n connection to a repository.\n
\n CopyPackageVersions: Copies package versions from one \n repository to another repository in the same domain.
\n CreateDomain: Creates a domain
\n CreateRepository: Creates a CodeArtifact repository in a domain.
\n DeleteDomain: Deletes a domain. You cannot delete a domain that contains\n repositories.
\n DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.
\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 DeleteRepository: Deletes a repository. \n
\n DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
\n DescribeDomain: Returns a DomainDescription object that\n contains information about the requested domain.
\n DescribePackage: Returns a PackageDescription\n object that contains details about a package.
\n DescribePackageVersion: Returns a PackageVersionDescription\n object that contains details about a package version.
\n DescribeRepository: Returns a RepositoryDescription object\n that contains detailed information about the requested repository.
\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 DisassociateExternalConnection: Removes an existing external connection from a repository. \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 GetDomainPermissionsPolicy: Returns the policy of a resource\n that is attached to the specified domain.
\n GetPackageVersionAsset: Returns the contents of an asset that is in a package version.
\n GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.
\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 maven\n
\n npm\n
\n nuget\n
\n pypi\n
\n GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository. \n
\n ListDomains: Returns a list of DomainSummary objects. Each\n returned DomainSummary object contains information about a domain.
\n ListPackages: Lists the packages in a repository.
\n ListPackageVersionAssets: Lists the assets for a given package version.
\n ListPackageVersionDependencies: Returns a list of the direct dependencies for a\n package version.
\n ListPackageVersions: Returns a list of package versions for a specified\n package in a repository.
\n ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.
\n ListRepositoriesInDomain: Returns a list of the repositories in a domain.
\n PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
\n PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine \n how new versions of the package can be added to a specific repository.
\n PutRepositoryPermissionsPolicy: Sets the resource policy on a repository\n that specifies permissions to access it.
\n UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
\n UpdateRepository: Updates the properties of a repository.
\n The name of the repository that contains the package versions to copy.\n
", + "smithy.api#documentation": "\n The name of the repository that contains the package versions to be copied.\n
", "smithy.api#httpQuery": "source-repository", "smithy.api#required": {} } @@ -454,7 +490,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "\n The format of the package that is copied.\n
", + "smithy.api#documentation": "\n The format of the package versions to be copied.\n
", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -462,14 +498,14 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package versions to be copied. The package version component that specifies its \n namespace depends on its type. For example:
\n\n\n The namespace of a Maven package version is its groupId. The namespace is required when copying Maven package versions.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n The name of the package that is copied.\n
", + "smithy.api#documentation": "\n The name of the package that contains the versions to be copied.\n
", "smithy.api#httpQuery": "package", "smithy.api#required": {} } @@ -477,7 +513,7 @@ "versions": { "target": "com.amazonaws.codeartifact#PackageVersionList", "traits": { - "smithy.api#documentation": "\n The versions of the package to copy.\n
\n\n You must specify versions or versionRevisions. You cannot specify both.\n
\n The versions of the package to be copied.\n
\n\n You must specify versions or versionRevisions. You cannot specify both.\n
\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package versions to be deleted. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId. The namespace is required when deleting Maven package versions.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nReturns a \n PackageDescription \n object that contains information about the requested package.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/package", + "code": 200 + } + } + }, + "com.amazonaws.codeartifact#DescribePackageRequest": { + "type": "structure", + "members": { + "domain": { + "target": "com.amazonaws.codeartifact#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain that contains the repository that contains the package.
", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + }, + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "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" + } + }, + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository that contains the requested package.
", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", + "traits": { + "smithy.api#documentation": "A format that specifies the type of the requested package.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the requested package. The package component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package is its groupId. The namespace is required when requesting Maven packages.\n
\n The namespace of an npm package is its scope.\n
\n Python and NuGet packages do not contain a corresponding component, packages \n of those formats do not have a namespace.\n
\nThe name of the requested package.
", + "smithy.api#httpQuery": "package", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.codeartifact#DescribePackageResult": { + "type": "structure", + "members": { + "package": { + "target": "com.amazonaws.codeartifact#PackageDescription", + "traits": { + "smithy.api#documentation": "A PackageDescription \n object that contains information about the requested package.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.codeartifact#DescribePackageVersion": { "type": "operation", "input": { @@ -1243,7 +1376,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the requested package version. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package versions to be disposed. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you \n add one or more repositories.\n
" } }, + "com.amazonaws.codeartifact#DomainEntryPoint": { + "type": "structure", + "members": { + "repositoryName": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository that a package was originally published to.
" + } + }, + "externalConnectionName": { + "target": "com.amazonaws.codeartifact#ExternalConnectionName", + "traits": { + "smithy.api#documentation": "The name of the external connection that a package was ingested from.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about how a package originally entered the CodeArtifact domain. For packages published directly to CodeArtifact, the entry point is the repository it was published to. \n For packages ingested from an external repository, the entry point is the external connection that it was ingested from. An external \n connection is a CodeArtifact repository that is connected to an external repository such as the npm registry or NuGet gallery.
" + } + }, "com.amazonaws.codeartifact#DomainName": { "type": "string", "traits": { @@ -1714,6 +1867,10 @@ "com.amazonaws.codeartifact#ExternalConnectionName": { "type": "string", "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + }, "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9._\\-:]{1,99}$" } }, @@ -1945,7 +2102,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version with the requested asset file. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\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#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 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", @@ -2078,7 +2235,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.\n
\nAlthough maven is \n listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.
\n A format that specifies the type of the package version with the requested readme file.\n
", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -2086,7 +2243,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version with the requested readme file. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version with the requested readme file. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n The name of the repository that contains the package that contains the returned package version assets.\n
", + "smithy.api#documentation": "\n The name of the repository that contains the package that contains the requested package version assets.\n
", "smithy.api#httpQuery": "repository", "smithy.api#required": {} } @@ -2541,7 +2698,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "\n The format of the package that contains the returned package version assets.\n
", + "smithy.api#documentation": "\n The format of the package that contains the requested package version assets.\n
", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -2549,14 +2706,14 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version that contains the requested package version assets. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n The name of the package that contains the returned package version assets.\n
", + "smithy.api#documentation": "\n The name of the package that contains the requested package version assets.\n
", "smithy.api#httpQuery": "package", "smithy.api#required": {} } @@ -2591,25 +2748,25 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "\n The format of the package that contains the returned package version assets.\n
" + "smithy.api#documentation": "\n The format of the package that contains the requested package version assets.\n
" } }, "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version that contains the requested package version assets. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n The name of the package that contains the returned package version assets.\n
" + "smithy.api#documentation": "\n The name of the package that contains the requested package version assets.\n
" } }, "version": { "target": "com.amazonaws.codeartifact#PackageVersion", "traits": { - "smithy.api#documentation": "\n The version of the package associated with the returned assets.\n
" + "smithy.api#documentation": "\n The version of the package associated with the requested assets.\n
" } }, "versionRevision": { @@ -2703,7 +2860,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version with the requested dependencies. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version that contains the returned dependencies. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n The name of the domain that contains the repository that contains the returned package versions.\n
", + "smithy.api#documentation": "\n The name of the domain that contains the repository that contains the requested package versions.\n
", "smithy.api#httpQuery": "domain", "smithy.api#required": {} } @@ -2850,7 +3007,7 @@ "repository": { "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "\n The name of the repository that contains the package.\n
", + "smithy.api#documentation": "\n The name of the repository that contains the requested package versions.\n
", "smithy.api#httpQuery": "repository", "smithy.api#required": {} } @@ -2858,7 +3015,7 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "\n The format of the returned packages.\n
", + "smithy.api#documentation": "\n The format of the returned package versions.\n
", "smithy.api#httpQuery": "format", "smithy.api#required": {} } @@ -2866,14 +3023,14 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n Python and NuGet packages do not contain a corresponding component, packages \n of those formats do not have a namespace.\n
\n\n The name of the package for which you want to return a list of package versions.\n
", + "smithy.api#documentation": "\n The name of the package for which you want to request package versions.\n
", "smithy.api#httpQuery": "package", "smithy.api#required": {} } @@ -2881,14 +3038,14 @@ "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.\n
", + "smithy.api#documentation": "\n A string that filters the requested package versions by status.\n
", "smithy.api#httpQuery": "status" } }, "sortBy": { "target": "com.amazonaws.codeartifact#PackageVersionSortType", "traits": { - "smithy.api#documentation": "\n How to sort the returned list of package versions.\n
", + "smithy.api#documentation": "\n How to sort the requested list of package versions.\n
", "smithy.api#httpQuery": "sortBy" } }, @@ -2905,6 +3062,13 @@ "smithy.api#documentation": "\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n
", "smithy.api#httpQuery": "next-token" } + }, + "originType": { + "target": "com.amazonaws.codeartifact#PackageVersionOriginType", + "traits": { + "smithy.api#documentation": "The originType used to filter package versions. \n Only package versions with the provided originType will be returned.
\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package that contains the requested package versions. The package component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n Python and NuGet packages do not contain a corresponding component, packages \n of those formats do not have a namespace.\n
\n\n The name of the domain that contains the repository that contains the requested list of packages.\n
", + "smithy.api#documentation": "\n The name of the domain that contains the repository that contains the requested packages.\n
", "smithy.api#httpQuery": "domain", "smithy.api#required": {} } @@ -3020,7 +3184,7 @@ "repository": { "target": "com.amazonaws.codeartifact#RepositoryName", "traits": { - "smithy.api#documentation": "\n The name of the repository from which packages are to be listed.\n
", + "smithy.api#documentation": "\n The name of the repository that contains the requested packages.\n
", "smithy.api#httpQuery": "repository", "smithy.api#required": {} } @@ -3028,21 +3192,21 @@ "format": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "\n The format of the packages.\n
", + "smithy.api#documentation": "The format used to filter requested packages. Only packages from the provided format will be returned.
", "smithy.api#httpQuery": "format" } }, "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace used to filter requested packages. Only packages with the provided namespace will be returned. \n The package component that specifies its namespace depends on its type. For example:
\n \n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n Python and NuGet packages do not contain a corresponding component, packages \n of those formats do not have a namespace.\n
\n\n A prefix used to filter returned packages. Only packages with names that start with \n packagePrefix are returned.\n
\n A prefix used to filter requested packages. Only packages with names that start with \n packagePrefix are returned.\n
\n The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.\n
", "smithy.api#httpQuery": "next-token" } + }, + "publish": { + "target": "com.amazonaws.codeartifact#AllowPublish", + "traits": { + "smithy.api#documentation": "The value of the Publish package origin control restriction used to filter requested packages. \n Only packages with the provided restriction are returned. \n For more information, see PackageOriginRestrictions.
The value of the Upstream package origin control restriction used to filter requested packages. \n Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package that this package depends on. The package component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n Python and NuGet packages do not contain a corresponding component, packages \n of those formats do not have a namespace.\n
\nA format that specifies the type of the package.
" + } + }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n Python and NuGet packages do not contain a corresponding component, packages \n of those formats do not have a namespace.\n
\nThe name of the package.
" + } + }, + "originConfiguration": { + "target": "com.amazonaws.codeartifact#PackageOriginConfiguration", + "traits": { + "smithy.api#documentation": "The package origin configuration for the package.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a package.
" + } + }, "com.amazonaws.codeartifact#PackageFormat": { "type": "string", "traits": { @@ -3416,7 +3626,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^[^!#/\\s]+$" + "smithy.api#pattern": "^[^#/\\s]+$" } }, "com.amazonaws.codeartifact#PackageNamespace": { @@ -3426,7 +3636,43 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^[^!#/\\s]+$" + "smithy.api#pattern": "^[^#/\\s]+$" + } + }, + "com.amazonaws.codeartifact#PackageOriginConfiguration": { + "type": "structure", + "members": { + "restrictions": { + "target": "com.amazonaws.codeartifact#PackageOriginRestrictions", + "traits": { + "smithy.api#documentation": "A PackageOriginRestrictions object that contains information \n about the upstream and publish package origin configuration for the package.
Details about the package origin configuration of a package.
" + } + }, + "com.amazonaws.codeartifact#PackageOriginRestrictions": { + "type": "structure", + "members": { + "publish": { + "target": "com.amazonaws.codeartifact#AllowPublish", + "traits": { + "smithy.api#documentation": "The package origin configuration that determines if new versions of the package can be published directly to the repository.
", + "smithy.api#required": {} + } + }, + "upstream": { + "target": "com.amazonaws.codeartifact#AllowUpstream", + "traits": { + "smithy.api#documentation": "The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the origin restrictions set on the package. \n The package origin restrictions determine how new versions of a package \n can be added to a specific repository.
" } }, "com.amazonaws.codeartifact#PackageSummary": { @@ -3441,7 +3687,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package. The package component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n Python and NuGet packages do not contain a corresponding component, packages \n of those formats do not have a namespace.\n
\n\n The name of the package.\n
" } + }, + "originConfiguration": { + "target": "com.amazonaws.codeartifact#PackageOriginConfiguration", + "traits": { + "smithy.api#documentation": "A PackageOriginConfiguration \n object that contains a PackageOriginRestrictions object \n that contains information about the upstream and publish package origin restrictions.
" + } } }, "traits": { @@ -3468,7 +3720,7 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^[^!#/\\s]+$" + "smithy.api#pattern": "^[^#/\\s]+$" } }, "com.amazonaws.codeartifact#PackageVersionDescription": { @@ -3483,7 +3735,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\n\n A string that contains the status of the package version.\n
" } + }, + "origin": { + "target": "com.amazonaws.codeartifact#PackageVersionOrigin", + "traits": { + "smithy.api#documentation": "A PackageVersionOrigin object that contains \n information about how the package version was added to the repository.
" + } } }, "traits": { @@ -3568,7 +3826,7 @@ } }, "traits": { - "smithy.api#documentation": "\n An error associated with package.\n
" + "smithy.api#documentation": "l\n An error associated with package.\n
" } }, "com.amazonaws.codeartifact#PackageVersionErrorCode": { @@ -3623,6 +3881,45 @@ } } }, + "com.amazonaws.codeartifact#PackageVersionOrigin": { + "type": "structure", + "members": { + "domainEntryPoint": { + "target": "com.amazonaws.codeartifact#DomainEntryPoint", + "traits": { + "smithy.api#documentation": "A DomainEntryPoint object that contains \n information about from which repository or external connection the package version was added to the domain.
" + } + }, + "originType": { + "target": "com.amazonaws.codeartifact#PackageVersionOriginType", + "traits": { + "smithy.api#documentation": "Describes how the package version was originally added to the domain. An INTERNAL origin type means the package version was published \n directly to a repository in the domain. An EXTERNAL origin type means the package version was ingested from an external connection.
Information about how a package version was added to a repository.
" + } + }, + "com.amazonaws.codeartifact#PackageVersionOriginType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INTERNAL", + "name": "INTERNAL" + }, + { + "value": "EXTERNAL", + "name": "EXTERNAL" + }, + { + "value": "UNKNOWN", + "name": "UNKNOWN" + } + ] + } + }, "com.amazonaws.codeartifact#PackageVersionRevision": { "type": "string", "traits": { @@ -3706,6 +4003,12 @@ "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": {} } + }, + "origin": { + "target": "com.amazonaws.codeartifact#PackageVersionOrigin", + "traits": { + "smithy.api#documentation": "A PackageVersionOrigin object that contains information \n about how the package version was added to the repository.
" + } } }, "traits": { @@ -3733,8 +4036,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5120 - } + "max": 7168 + }, + "smithy.api#pattern": "^[\\P{C}\\s]+$" } }, "com.amazonaws.codeartifact#PolicyRevision": { @@ -3829,6 +4133,109 @@ } } }, + "com.amazonaws.codeartifact#PutPackageOriginConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.codeartifact#PutPackageOriginConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.codeartifact#PutPackageOriginConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.codeartifact#AccessDeniedException" + }, + { + "target": "com.amazonaws.codeartifact#InternalServerException" + }, + { + "target": "com.amazonaws.codeartifact#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codeartifact#ThrottlingException" + }, + { + "target": "com.amazonaws.codeartifact#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sets the package origin configuration for a package.
\nThe package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct \n publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. \n For more information about package origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.
\n\n PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called \n on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. \n This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block \n publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.
The name of the domain that contains the repository that contains the package.
", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + }, + "domainOwner": { + "target": "com.amazonaws.codeartifact#AccountId", + "traits": { + "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" + } + }, + "repository": { + "target": "com.amazonaws.codeartifact#RepositoryName", + "traits": { + "smithy.api#documentation": "The name of the repository that contains the package.
", + "smithy.api#httpQuery": "repository", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.codeartifact#PackageFormat", + "traits": { + "smithy.api#documentation": "A format that specifies the type of the package to be updated.
", + "smithy.api#httpQuery": "format", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.codeartifact#PackageNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the package to be updated. The package component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n Python and NuGet packages do not contain a corresponding component, packages \n of those formats do not have a namespace.\n
\nThe name of the package to be updated.
", + "smithy.api#httpQuery": "package", + "smithy.api#required": {} + } + }, + "restrictions": { + "target": "com.amazonaws.codeartifact#PackageOriginRestrictions", + "traits": { + "smithy.api#documentation": "A PackageOriginRestrictions \n object that contains information about the upstream and publish package origin restrictions. \n The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. \n The publish restriction determines if new package versions can be published directly to the repository.
You must include both the desired upstream and publish restrictions.
A PackageOriginConfiguration \n object that describes the origin configuration set for the package. It contains a \n PackageOriginRestrictions \n object that describes how new versions of the package can be introduced to the repository.
" + } + } + } + }, "com.amazonaws.codeartifact#PutRepositoryPermissionsPolicy": { "type": "operation", "input": { @@ -4253,7 +4660,8 @@ "smithy.api#length": { "min": 1, "max": 128 - } + }, + "smithy.api#pattern": "^\\P{C}+$" } }, "com.amazonaws.codeartifact#TagKeyList": { @@ -4344,7 +4752,8 @@ "smithy.api#length": { "min": 0, "max": 256 - } + }, + "smithy.api#pattern": "^\\P{C}*$" } }, "com.amazonaws.codeartifact#ThrottlingException": { @@ -4502,7 +4911,7 @@ "namespace": { "target": "com.amazonaws.codeartifact#PackageNamespace", "traits": { - "smithy.api#documentation": "\n The namespace of the package. The package component that specifies its \n namespace depends on its type. For example:\n
\n\n The namespace of a Maven package is its groupId.\n
\n The namespace of an npm package is its scope.\n
\n A Python package does not contain a corresponding component, so \n Python packages do not have a namespace.\n
\nThe namespace of the package version to be updated. The package version component that specifies its \n namespace depends on its type. For example:
\n \n\n The namespace of a Maven package version is its groupId.\n
\n The namespace of an npm package version is its scope.\n
\n Python and NuGet package versions do not contain a corresponding component, package versions \n of those formats do not have a namespace.\n
\nAdds or updates an Config rule for evaluating whether your\n\t\t\tAmazon Web Services resources comply with your desired configurations.
\n\t\tYou can use this action for Config custom rules and Config\n\t\t\tmanaged rules. A Config custom rule is a rule that you\n\t\t\tdevelop and maintain. An Config managed rule is a customizable,\n\t\t\tpredefined rule that Config provides.
\n\t\tIf you are adding a new Config custom rule, you must first\n\t\t\tcreate the Lambda function that the rule invokes to evaluate\n\t\t\tyour resources. When you use the PutConfigRule action\n\t\t\tto add the rule to Config, you must specify the Amazon Resource\n\t\t\tName (ARN) that Lambda assigns to the function. Specify the ARN\n\t\t\tfor the SourceIdentifier key. This key is part of the\n\t\t\t\tSource object, which is part of the\n\t\t\t\tConfigRule object.
If you are adding an Config managed rule, specify the\n\t\t\trule's identifier for the SourceIdentifier key. To\n\t\t\treference Config managed rule identifiers, see About Config managed rules.
For any new rule that you add, specify the\n\t\t\t\tConfigRuleName in the ConfigRule\n\t\t\tobject. Do not specify the ConfigRuleArn or the\n\t\t\tConfigRuleId. These values are generated by Config for new rules.
If you are updating a rule that you added previously, you can\n\t\t\tspecify the rule by ConfigRuleName,\n\t\t\t\tConfigRuleId, or ConfigRuleArn in the\n\t\t\t\tConfigRule data type that you use in this\n\t\t\trequest.
The maximum number of rules that Config supports is 150.
\n\n\t\tFor information about requesting a rule limit increase, see\n\t\t\t\tConfig Limits in the Amazon Web Services General\n\t\t\t\tReference Guide.
\n\n\t\tFor more information about developing and using Config\n\t\t\trules, see Evaluating Amazon Web Services resource Configurations with Config\n\t\t\tin the Config Developer Guide.
" + "smithy.api#documentation": "Adds or updates an Config rule for evaluating whether your\n\t\t\tAmazon Web Services resources comply with your desired configurations.
\n\t\tYou can use this action for Config custom rules and Config\n\t\t\tmanaged rules. A Config custom rule is a rule that you\n\t\t\tdevelop and maintain. An Config managed rule is a customizable,\n\t\t\tpredefined rule that Config provides.
\n\t\tIf you are adding a new Config custom rule, you must first\n\t\t\tcreate the Lambda function that the rule invokes to evaluate\n\t\t\tyour resources. When you use the PutConfigRule action\n\t\t\tto add the rule to Config, you must specify the Amazon Resource\n\t\t\tName (ARN) that Lambda assigns to the function. Specify the ARN\n\t\t\tfor the SourceIdentifier key. This key is part of the\n\t\t\t\tSource object, which is part of the\n\t\t\t\tConfigRule object.
If you are adding an Config managed rule, specify the\n\t\t\trule's identifier for the SourceIdentifier key. To\n\t\t\treference Config managed rule identifiers, see About Config managed rules.
For any new rule that you add, specify the\n\t\t\t\tConfigRuleName in the ConfigRule\n\t\t\tobject. Do not specify the ConfigRuleArn or the\n\t\t\tConfigRuleId. These values are generated by Config for new rules.
If you are updating a rule that you added previously, you can\n\t\t\tspecify the rule by ConfigRuleName,\n\t\t\t\tConfigRuleId, or ConfigRuleArn in the\n\t\t\t\tConfigRule data type that you use in this\n\t\t\trequest.
For information on how many Config rules you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.
\n\n\t\tFor more information about developing and using Config\n\t\t\trules, see Evaluating Amazon Web Services resource Configurations with Config\n\t\t\tin the Config Developer Guide.
" } }, "com.amazonaws.configservice#PutConfigRuleRequest": { @@ -8783,7 +8783,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across Amazon Web Services Organization.
\n\t\tThis API creates a service linked role AWSServiceRoleForConfigConforms in your account. \n\t\tThe service linked role is created only when the role does not exist in your account.
You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. \n\t\t\tIf you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across Amazon Web Services Organization.\n\t\t\tFor information on how many conformance packs you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.
\n\t\tThis API creates a service linked role AWSServiceRoleForConfigConforms in your account. \n\t\tThe service linked role is created only when the role does not exist in your account.
You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. \n\t\t\tIf you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.
Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your \n\t\t\tdesired configurations.
\n\t Only a master account and a delegated administrator can create or update an organization Config rule.\n\t\tWhen calling this API with a delegated administrator, you must ensure Organizations \n\t\tListDelegatedAdministrator permissions are added.
This API enables organization service access through the EnableAWSServiceAccess action and creates a service linked \n\t\t\trole AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. \n\t\t\tThe service linked role is created only when the role does not exist in the caller account. \n\t\t\tConfig verifies the existence of role with GetRole action.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization\n\t\t\tregister-delegated-administrator for config-multiaccountsetup.amazonaws.com.
You can use this action to create both Config custom rules and Config managed rules. \n\t\t\tIf you are adding a new Config custom rule, you must first create Lambda function in the master account or a delegated \n\t\t\tadministrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function.\n\t\t\tWhen you use the PutOrganizationConfigRule action to add the rule to Config, you must \n\t\t\tspecify the Amazon Resource Name (ARN) that Lambda assigns to the function. \n\t\t\tIf you are adding an Config managed rule, specify the rule's identifier for the RuleIdentifier key.
The maximum number of organization Config rules that Config supports is 150 and 3 delegated administrator per organization.
\n\t\tPrerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.
Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.
Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your \n\t\t\tdesired configurations. For information on how many organization Config rules you can have per account, \n\t\t\tsee \n Service Limits\n in the Config Developer Guide.
\n\t Only a master account and a delegated administrator can create or update an organization Config rule.\n\t\tWhen calling this API with a delegated administrator, you must ensure Organizations \n\t\tListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access through the EnableAWSServiceAccess action and creates a service linked \n\t\t\trole AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. \n\t\t\tThe service linked role is created only when the role does not exist in the caller account. \n\t\t\tConfig verifies the existence of role with GetRole action.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization\n\t\t\tregister-delegated-administrator for config-multiaccountsetup.amazonaws.com.
You can use this action to create both Config custom rules and Config managed rules. \n\t\t\tIf you are adding a new Config custom rule, you must first create Lambda function in the master account or a delegated \n\t\t\tadministrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function.\n\t\t\tWhen you use the PutOrganizationConfigRule action to add the rule to Config, you must \n\t\t\tspecify the Amazon Resource Name (ARN) that Lambda assigns to the function. \n\t\t\tIf you are adding an Config managed rule, specify the rule's identifier for the RuleIdentifier key.
Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.
Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.
Migrates 10 active and enabled Amazon SNS subscriptions at a time and converts them to corresponding Amazon EventBridge rules.\n By default, this operation migrates subscriptions only when all your replication instance versions are 3.4.6 or higher.\n If any replication instances are from versions earlier than 3.4.6, the operation raises an error and tells you\n to upgrade these instances to version 3.4.6 or higher. To enable migration regardless of version, set the Force\n option to true. However, if you don't upgrade instances earlier than version 3.4.6, some types of events might not be\n available when you use Amazon EventBridge.
To call this operation, make sure that you have certain permissions added to your user account.\n For more information, see Migrating event subscriptions to Amazon EventBridge\n in the Amazon Web Services Database Migration Service User Guide.
" + } + }, + "com.amazonaws.databasemigrationservice#UpdateSubscriptionsToEventBridgeMessage": { + "type": "structure", + "members": { + "ForceMove": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "When set to true, this operation migrates DMS subscriptions for Amazon SNS\n notifications no matter what your replication instance version is. If not set or set to\n false, this operation runs only when all your replication instances are from DMS\n version 3.4.6 or higher.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, + "com.amazonaws.databasemigrationservice#UpdateSubscriptionsToEventBridgeResponse": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "A string that indicates how many event subscriptions were migrated and how many remain to be migrated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "" + } + }, "com.amazonaws.databasemigrationservice#UpgradeDependencyFailureFault": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index 7e0e58aa2cb..13ffbe43367 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -1713,6 +1713,9 @@ { "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomain" }, + { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTable" + }, { "target": "com.amazonaws.ec2#AssociateTransitGatewayRouteTable" }, @@ -1959,6 +1962,9 @@ { "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachment" }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTable" + }, { "target": "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference" }, @@ -1968,6 +1974,9 @@ { "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTable" }, + { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncement" + }, { "target": "com.amazonaws.ec2#CreateTransitGatewayVpcAttachment" }, @@ -2145,6 +2154,9 @@ { "target": "com.amazonaws.ec2#DeleteTransitGatewayPeeringAttachment" }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTable" + }, { "target": "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference" }, @@ -2154,6 +2166,9 @@ { "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTable" }, + { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement" + }, { "target": "com.amazonaws.ec2#DeleteTransitGatewayVpcAttachment" }, @@ -2541,6 +2556,12 @@ { "target": "com.amazonaws.ec2#DescribeTransitGatewayPeeringAttachments" }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTables" + }, + { + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncements" + }, { "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTables" }, @@ -2673,6 +2694,9 @@ { "target": "com.amazonaws.ec2#DisassociateTransitGatewayMulticastDomain" }, + { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTable" + }, { "target": "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable" }, @@ -2817,6 +2841,12 @@ { "target": "com.amazonaws.ec2#GetTransitGatewayMulticastDomainAssociations" }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociations" + }, + { + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntries" + }, { "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences" }, @@ -4467,6 +4497,56 @@ } } }, + "com.amazonaws.ec2#AssociateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "Associates the specified transit gateway attachment with a transit gateway policy table.
" + } + }, + "com.amazonaws.ec2#AssociateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway policy table to associate with the transit gateway attachment.
", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway attachment to associate with the policy table.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Describes the association of a transit gateway and a transit gateway policy table.
", + "smithy.api#xmlName": "association" + } + } + } + }, "com.amazonaws.ec2#AssociateTransitGatewayRouteTable": { "type": "operation", "input": { @@ -11085,8 +11165,7 @@ "TrafficType": { "target": "com.amazonaws.ec2#TrafficType", "traits": { - "smithy.api#documentation": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
", - "smithy.api#required": {} + "smithy.api#documentation": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
" } }, "LogDestinationType": { @@ -14424,7 +14503,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult" }, "traits": { - "smithy.api#documentation": "Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The peer transit gateway can be in \n your account or a different Amazon Web Services account.
\nAfter you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.
" + "smithy.api#documentation": "Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The transit gateways must be in\n different Regions. The peer transit gateway can be in your account or a different \n Amazon Web Services account.
\nAfter you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.
" } }, "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest": { @@ -14458,6 +14537,9 @@ "smithy.api#required": {} } }, + "Options": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequestOptions" + }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -14473,6 +14555,14 @@ } } }, + "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequestOptions": { + "type": "structure", + "members": { + "DynamicRouting": { + "target": "com.amazonaws.ec2#DynamicRoutingValue" + } + } + }, "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult": { "type": "structure", "members": { @@ -14486,6 +14576,55 @@ } } }, + "com.amazonaws.ec2#CreateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "Creates a transit gateway policy table.
" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway used for the policy table.
", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The tags specification for the transit gateway policy table created during the request.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Describes the created transit gateway policy table.
", + "smithy.api#xmlName": "transitGatewayPolicyTable" + } + } + } + }, "com.amazonaws.ec2#CreateTransitGatewayPrefixListReference": { "type": "operation", "input": { @@ -14665,6 +14804,63 @@ "smithy.api#documentation": "Creates a route table for the specified transit gateway.
" } }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncement": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementResult" + }, + "traits": { + "smithy.api#documentation": "Advertises a new transit gateway route table.
" + } + }, + "com.amazonaws.ec2#CreateTransitGatewayRouteTableAnnouncementRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway route table.
", + "smithy.api#required": {} + } + }, + "PeeringAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "The ID of the peering attachment.
", + "smithy.api#required": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The tags specifications applied to the transit gateway route table announcement.
", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Provides details about the transit gateway route table announcement.
", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncement" + } + } + } + }, "com.amazonaws.ec2#CreateTransitGatewayRouteTableRequest": { "type": "structure", "members": { @@ -18224,6 +18420,49 @@ } } }, + "com.amazonaws.ec2#DeleteTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "Deletes the specified transit gateway policy table.
" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#documentation": "The transit gateway policy table to delete.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Provides details about the deleted transit gateway policy table.
", + "smithy.api#xmlName": "transitGatewayPolicyTable" + } + } + } + }, "com.amazonaws.ec2#DeleteTransitGatewayPrefixListReference": { "type": "operation", "input": { @@ -18367,6 +18606,49 @@ "smithy.api#documentation": "Deletes the specified transit gateway route table. You must disassociate the route table from any\n transit gateway route tables before you can delete it.
" } }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncement": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementResult" + }, + "traits": { + "smithy.api#documentation": "Advertises to the transit gateway that a transit gateway route table is deleted.
" + } + }, + "com.amazonaws.ec2#DeleteTransitGatewayRouteTableAnnouncementRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#documentation": "The transit gateway route table ID that's being deleted.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Provides details about a deleted transit gateway route table.
", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncement" + } + } + } + }, "com.amazonaws.ec2#DeleteTransitGatewayRouteTableRequest": { "type": "structure", "members": { @@ -28850,37 +29132,37 @@ } } }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTables": { + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTables": { "type": "operation", "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest" + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesRequest" }, "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult" + "target": "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesResult" }, "traits": { - "smithy.api#documentation": "Describes one or more transit gateway route tables. By default, all transit gateway route tables are described.\n Alternatively, you can filter the results.
", + "smithy.api#documentation": "Describes one or more transit gateway route policy tables.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "TransitGatewayRouteTables", + "items": "TransitGatewayPolicyTables", "pageSize": "MaxResults" } } }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest": { + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesRequest": { "type": "structure", "members": { - "TransitGatewayRouteTableIds": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList", + "TransitGatewayPolicyTableIds": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the transit gateway route tables.
" + "smithy.api#documentation": "The IDs of the transit gateway policy tables.
" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. The possible values are:
\n\n default-association-route-table - Indicates whether this is the default\n association route table for the transit gateway (true | false).
\n default-propagation-route-table - Indicates whether this is the default\n propagation route table for the transit gateway (true | false).
\n state - The state of the route table (available | deleting | deleted | pending).
\n transit-gateway-id - The ID of the transit gateway.
\n transit-gateway-route-table-id - The ID of the transit gateway route table.
The filters associated with the transit gateway policy table.
", "smithy.api#xmlName": "Filter" } }, @@ -28904,58 +29186,58 @@ } } }, - "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult": { + "com.amazonaws.ec2#DescribeTransitGatewayPolicyTablesResult": { "type": "structure", "members": { - "TransitGatewayRouteTables": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableList", + "TransitGatewayPolicyTables": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableList", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayRouteTables", - "smithy.api#documentation": "Information about the transit gateway route tables.
", - "smithy.api#xmlName": "transitGatewayRouteTables" + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTables", + "smithy.api#documentation": "Describes the transit gateway policy tables.
", + "smithy.api#xmlName": "transitGatewayPolicyTables" } }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
", "smithy.api#xmlName": "nextToken" } } } }, - "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachments": { + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncements": { "type": "operation", "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest" + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsRequest" }, "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult" + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsResult" }, "traits": { - "smithy.api#documentation": "Describes one or more VPC attachments. By default, all VPC attachments are described.\n Alternatively, you can filter the results.
", + "smithy.api#documentation": "Describes one or more transit gateway route table advertisements.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "TransitGatewayVpcAttachments", + "items": "TransitGatewayRouteTableAnnouncements", "pageSize": "MaxResults" } } }, - "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest": { + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsRequest": { "type": "structure", "members": { - "TransitGatewayAttachmentIds": { - "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "TransitGatewayRouteTableAnnouncementIds": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the attachments.
" + "smithy.api#documentation": "The IDs of the transit gateway route tables that are being advertised.
" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. The possible values are:
\n\n state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
\n transit-gateway-attachment-id - The ID of the attachment.
\n transit-gateway-id - The ID of the transit gateway.
\n vpc-id - The ID of the VPC.
The filters associated with the transit gateway policy table.
", "smithy.api#xmlName": "Filter" } }, @@ -28979,58 +29261,208 @@ } } }, - "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsResult": { + "com.amazonaws.ec2#DescribeTransitGatewayRouteTableAnnouncementsResult": { "type": "structure", "members": { - "TransitGatewayVpcAttachments": { - "target": "com.amazonaws.ec2#TransitGatewayVpcAttachmentList", + "TransitGatewayRouteTableAnnouncements": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementList", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayVpcAttachments", - "smithy.api#documentation": "Information about the VPC attachments.
", - "smithy.api#xmlName": "transitGatewayVpcAttachments" + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncements", + "smithy.api#documentation": "Describes the transit gateway route table announcement.
", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncements" } }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
", "smithy.api#xmlName": "nextToken" } } } }, - "com.amazonaws.ec2#DescribeTransitGateways": { + "com.amazonaws.ec2#DescribeTransitGatewayRouteTables": { "type": "operation", "input": { - "target": "com.amazonaws.ec2#DescribeTransitGatewaysRequest" + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest" }, "output": { - "target": "com.amazonaws.ec2#DescribeTransitGatewaysResult" + "target": "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesResult" }, "traits": { - "smithy.api#documentation": "Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can\n filter the results.
", + "smithy.api#documentation": "Describes one or more transit gateway route tables. By default, all transit gateway route tables are described.\n Alternatively, you can filter the results.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "TransitGateways", + "items": "TransitGatewayRouteTables", "pageSize": "MaxResults" } } }, - "com.amazonaws.ec2#DescribeTransitGatewaysRequest": { + "com.amazonaws.ec2#DescribeTransitGatewayRouteTablesRequest": { "type": "structure", "members": { - "TransitGatewayIds": { - "target": "com.amazonaws.ec2#TransitGatewayIdStringList", + "TransitGatewayRouteTableIds": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableIdStringList", "traits": { - "smithy.api#documentation": "The IDs of the transit gateways.
" + "smithy.api#documentation": "The IDs of the transit gateway route tables.
" } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. The possible values are:
\n\n options.propagation-default-route-table-id - The ID of the default propagation route table.
\n options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
\n options.association-default-route-table-id - The ID of the default association route table.
\n options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
\n options.default-route-table-association - Indicates whether resource attachments are automatically \n associated with the default association route table (enable | disable).
\n options.default-route-table-propagation - Indicates whether resource attachments automatically propagate \n routes to the default propagation route table (enable | disable).
\n options.dns-support - Indicates whether DNS support is enabled (enable | disable).
\n options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
\n owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
\n state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
\n transit-gateway-id - The ID of the transit gateway.
One or more filters. The possible values are:
\n\n default-association-route-table - Indicates whether this is the default\n association route table for the transit gateway (true | false).
\n default-propagation-route-table - Indicates whether this is the default\n propagation route table for the transit gateway (true | false).
\n state - The state of the route table (available | deleting | deleted | pending).
\n transit-gateway-id - The ID of the transit gateway.
\n transit-gateway-route-table-id - The ID of the transit gateway route table.
The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the transit gateway route tables.
", + "smithy.api#xmlName": "transitGatewayRouteTables" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes one or more VPC attachments. By default, all VPC attachments are described.\n Alternatively, you can filter the results.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayVpcAttachments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewayVpcAttachmentsRequest": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentIdStringList", + "traits": { + "smithy.api#documentation": "The IDs of the attachments.
" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "One or more filters. The possible values are:
\n\n state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
\n transit-gateway-attachment-id - The ID of the attachment.
\n transit-gateway-id - The ID of the transit gateway.
\n vpc-id - The ID of the VPC.
The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the VPC attachments.
", + "smithy.api#xmlName": "transitGatewayVpcAttachments" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can\n filter the results.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGateways", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeTransitGatewaysRequest": { + "type": "structure", + "members": { + "TransitGatewayIds": { + "target": "com.amazonaws.ec2#TransitGatewayIdStringList", + "traits": { + "smithy.api#documentation": "The IDs of the transit gateways.
" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "One or more filters. The possible values are:
\n\n options.propagation-default-route-table-id - The ID of the default propagation route table.
\n options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
\n options.association-default-route-table-id - The ID of the default association route table.
\n options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
\n options.default-route-table-association - Indicates whether resource attachments are automatically \n associated with the default association route table (enable | disable).
\n options.default-route-table-propagation - Indicates whether resource attachments automatically propagate \n routes to the default propagation route table (enable | disable).
\n options.dns-support - Indicates whether DNS support is enabled (enable | disable).
\n options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
\n owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
\n state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
\n transit-gateway-id - The ID of the transit gateway.
The ID of the attachment.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the attachment.
" } }, "DryRun": { @@ -31656,6 +32087,12 @@ "traits": { "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the route table announcement.
" + } } } }, @@ -32161,6 +32598,56 @@ } } }, + "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableResult" + }, + "traits": { + "smithy.api#documentation": "Removes the association between an an attachment and a policy table.
" + } + }, + "com.amazonaws.ec2#DisassociateTransitGatewayPolicyTableRequest": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#documentation": "The ID of the disassociated policy table.
", + "smithy.api#required": {} + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway attachment to disassociate from the policy table.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Returns details about the transit gateway policy table disassociation.
", + "smithy.api#xmlName": "association" + } + } + } + }, "com.amazonaws.ec2#DisassociateTransitGatewayRouteTable": { "type": "operation", "input": { @@ -32710,6 +33197,21 @@ } } }, + "com.amazonaws.ec2#DynamicRoutingValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "enable", + "name": "enable" + }, + { + "value": "disable", + "name": "disable" + } + ] + } + }, "com.amazonaws.ec2#EbsBlockDevice": { "type": "structure", "members": { @@ -33996,8 +34498,7 @@ "TransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { - "smithy.api#documentation": "The ID of the attachment.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the attachment.
" } }, "DryRun": { @@ -34005,6 +34506,12 @@ "traits": { "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the transit gateway route table announcement.
" + } } } }, @@ -36782,6 +37289,14 @@ { "value": "NetworkInterface", "name": "NetworkInterface" + }, + { + "value": "TransitGateway", + "name": "TransitGateway" + }, + { + "value": "TransitGatewayAttachment", + "name": "TransitGatewayAttachment" } ] } @@ -39302,7 +39817,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. The possible values are:
\n\n resource-id - The ID of the resource.
\n resource-type - The type of resource. The valid value is: vpc.
\n state - The state of the subnet association. Valid values are\n associated | associating |\n disassociated | disassociating.
\n subnet-id - The ID of the subnet.
\n transit-gateway-attachment-id - The id of the transit gateway attachment.
One or more filters. The possible values are:
\n\n resource-id - The ID of the resource.
\n resource-type - The type of resource. The valid value is: vpc.
\n state - The state of the subnet association. Valid values are\n associated |\n associating\n | disassociated | disassociating.
\n subnet-id - The ID of the subnet.
\n transit-gateway-attachment-id - The id of the transit gateway attachment.
Gets information about the prefix list references in a specified transit gateway route table.
", + "smithy.api#documentation": "Gets a list of the transit gateway policy table associations.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "TransitGatewayPrefixListReferences", + "items": "Associations", "pageSize": "MaxResults" } } }, - "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest": { + "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsRequest": { "type": "structure", "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", "traits": { - "smithy.api#documentation": "The ID of the transit gateway route table.
", + "smithy.api#documentation": "The ID of the transit gateway policy table.
", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. The possible values are:
\n\n attachment.resource-id - The ID of the resource for the attachment.
\n attachment.resource-type - The type of resource for the\n attachment. Valid values are vpc | vpn |\n direct-connect-gateway | peering.
\n attachment.transit-gateway-attachment-id - The ID of the attachment.
\n is-blackhole - Whether traffic matching the route is blocked (true | false).
\n prefix-list-id - The ID of the prefix list.
\n prefix-list-owner-id - The ID of the owner of the prefix list.
\n state - The state of the prefix list reference (pending | available | modifying | deleting).
The filters associated with the transit gateway policy table.
", "smithy.api#xmlName": "Filter" } }, @@ -39402,59 +39917,53 @@ } } }, - "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult": { + "com.amazonaws.ec2#GetTransitGatewayPolicyTableAssociationsResult": { "type": "structure", "members": { - "TransitGatewayPrefixListReferences": { - "target": "com.amazonaws.ec2#TransitGatewayPrefixListReferenceSet", + "Associations": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociationList", "traits": { - "aws.protocols#ec2QueryName": "TransitGatewayPrefixListReferenceSet", - "smithy.api#documentation": "Information about the prefix list references.
", - "smithy.api#xmlName": "transitGatewayPrefixListReferenceSet" + "aws.protocols#ec2QueryName": "Associations", + "smithy.api#documentation": "Returns details about the transit gateway policy table association.
", + "smithy.api#xmlName": "associations" } }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
", "smithy.api#xmlName": "nextToken" } } } }, - "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociations": { + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntries": { "type": "operation", "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest" + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesRequest" }, "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult" + "target": "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesResult" }, "traits": { - "smithy.api#documentation": "Gets information about the associations for the specified transit gateway route table.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Associations", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "Returns a list of transit gateway policy table entries.
" } }, - "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest": { + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesRequest": { "type": "structure", "members": { - "TransitGatewayRouteTableId": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", "traits": { - "smithy.api#documentation": "The ID of the transit gateway route table.
", + "smithy.api#documentation": "The ID of the transit gateway policy table.
", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. The possible values are:
\n\n resource-id - The ID of the resource.
\n resource-type - The resource type. Valid values are vpc\n | vpn | direct-connect-gateway | peering\n | connect.
\n transit-gateway-attachment-id - The ID of the attachment.
The filters associated with the transit gateway policy table.
", "smithy.api#xmlName": "Filter" } }, @@ -39478,46 +39987,38 @@ } } }, - "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsResult": { + "com.amazonaws.ec2#GetTransitGatewayPolicyTableEntriesResult": { "type": "structure", "members": { - "Associations": { - "target": "com.amazonaws.ec2#TransitGatewayRouteTableAssociationList", + "TransitGatewayPolicyTableEntries": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableEntryList", "traits": { - "aws.protocols#ec2QueryName": "Associations", - "smithy.api#documentation": "Information about the associations.
", - "smithy.api#xmlName": "associations" - } - }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The entries for the transit gateway policy table.
", + "smithy.api#xmlName": "transitGatewayPolicyTableEntries" } } } }, - "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagations": { + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferences": { "type": "operation", "input": { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest" + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest" }, "output": { - "target": "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsResult" + "target": "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesResult" }, "traits": { - "smithy.api#documentation": "Gets information about the route table propagations for the specified transit gateway route table.
", + "smithy.api#documentation": "Gets information about the prefix list references in a specified transit gateway route table.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", - "items": "TransitGatewayRouteTablePropagations", + "items": "TransitGatewayPrefixListReferences", "pageSize": "MaxResults" } } }, - "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest": { + "com.amazonaws.ec2#GetTransitGatewayPrefixListReferencesRequest": { "type": "structure", "members": { "TransitGatewayRouteTableId": { @@ -39530,7 +40031,159 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. The possible values are:
\n\n resource-id - The ID of the resource.
\n resource-type - The resource type. Valid values are vpc\n | vpn | direct-connect-gateway | peering\n | connect.
\n transit-gateway-attachment-id - The ID of the attachment.
One or more filters. The possible values are:
\n\n attachment.resource-id - The ID of the resource for the attachment.
\n attachment.resource-type - The type of resource for the\n attachment. Valid values are vpc | vpn |\n direct-connect-gateway | peering.
\n attachment.transit-gateway-attachment-id - The ID of the attachment.
\n is-blackhole - Whether traffic matching the route is blocked (true | false).
\n prefix-list-id - The ID of the prefix list.
\n prefix-list-owner-id - The ID of the owner of the prefix list.
\n state - The state of the prefix list reference (pending | available | modifying | deleting).
The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the prefix list references.
", + "smithy.api#xmlName": "transitGatewayPrefixListReferenceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Gets information about the associations for the specified transit gateway route table.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Associations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTableAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway route table.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "One or more filters. The possible values are:
\n\n resource-id - The ID of the resource.
\n resource-type - The resource type. Valid values are vpc\n | vpn | direct-connect-gateway | peering\n | connect.
\n transit-gateway-attachment-id - The ID of the attachment.
The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the associations.
", + "smithy.api#xmlName": "associations" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Gets information about the route table propagations for the specified transit gateway route table.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TransitGatewayRouteTablePropagations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#GetTransitGatewayRouteTablePropagationsRequest": { + "type": "structure", + "members": { + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway route table.
", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "One or more filters. The possible values are:
\n\n resource-id - The ID of the resource.
\n resource-type - The resource type. Valid values are vpc\n | vpn | direct-connect-gateway | peering\n | connect.
\n transit-gateway-attachment-id - The ID of the attachment.
The ID of the default propagation route table.
" } + }, + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "A private Autonomous System Number (ASN) for the Amazon side of a BGP session. \n The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
" + } } }, "traits": { @@ -60351,6 +61010,13 @@ "smithy.api#xmlName": "transitGatewayId" } }, + "CoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkId", + "smithy.api#xmlName": "coreNetworkId" + } + }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -66424,10 +67090,18 @@ "value": "transit-gateway-multicast-domain", "name": "transit_gateway_multicast_domain" }, + { + "value": "transit-gateway-policy-table", + "name": "transit_gateway_policy_table" + }, { "value": "transit-gateway-route-table", "name": "transit_gateway_route_table" }, + { + "value": "transit-gateway-route-table-announcement", + "name": "transit_gateway_route_table_announcement" + }, { "value": "volume", "name": "volume" @@ -76034,6 +76708,14 @@ "smithy.api#xmlName": "transitGatewayAttachmentId" } }, + "AccepterTransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AccepterTransitGatewayAttachmentId", + "smithy.api#documentation": "The ID of the accepter transit gateway attachment.
", + "smithy.api#xmlName": "accepterTransitGatewayAttachmentId" + } + }, "RequesterTgwInfo": { "target": "com.amazonaws.ec2#PeeringTgwInfo", "traits": { @@ -76050,6 +76732,13 @@ "smithy.api#xmlName": "accepterTgwInfo" } }, + "Options": { + "target": "com.amazonaws.ec2#TransitGatewayPeeringAttachmentOptions", + "traits": { + "aws.protocols#ec2QueryName": "Options", + "smithy.api#xmlName": "options" + } + }, "Status": { "target": "com.amazonaws.ec2#PeeringAttachmentStatus", "traits": { @@ -76096,6 +76785,288 @@ } } }, + "com.amazonaws.ec2#TransitGatewayPeeringAttachmentOptions": { + "type": "structure", + "members": { + "DynamicRouting": { + "target": "com.amazonaws.ec2#DynamicRoutingValue", + "traits": { + "aws.protocols#ec2QueryName": "DynamicRouting", + "smithy.api#xmlName": "dynamicRouting" + } + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyRule": { + "type": "structure", + "members": { + "SourceCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceCidrBlock", + "smithy.api#documentation": "The source CIDR block for the transit gateway policy rule.
", + "smithy.api#xmlName": "sourceCidrBlock" + } + }, + "SourcePortRange": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourcePortRange", + "smithy.api#documentation": "The port range for the transit gateway policy rule. Currently this is set to * (all).
", + "smithy.api#xmlName": "sourcePortRange" + } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "The destination CIDR block for the transit gateway policy rule.
", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationPortRange": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationPortRange", + "smithy.api#documentation": "The port range for the transit gateway policy rule. Currently this is set to * (all).
", + "smithy.api#xmlName": "destinationPortRange" + } + }, + "Protocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Protocol", + "smithy.api#documentation": "The protocol used by the transit gateway policy rule.
", + "smithy.api#xmlName": "protocol" + } + }, + "MetaData": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyRuleMetaData", + "traits": { + "aws.protocols#ec2QueryName": "MetaData", + "smithy.api#documentation": "The meta data tags used for the transit gateway policy rule.
", + "smithy.api#xmlName": "metaData" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a rule associated with a transit gateway policy.
" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyRuleMetaData": { + "type": "structure", + "members": { + "MetaDataKey": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MetaDataKey", + "smithy.api#documentation": "The key name for the transit gateway policy rule meta data tag.
", + "smithy.api#xmlName": "metaDataKey" + } + }, + "MetaDataValue": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "MetaDataValue", + "smithy.api#documentation": "The value of the key for the transit gateway policy rule meta data tag.
", + "smithy.api#xmlName": "metaDataValue" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the meta data tags associated with a transit gateway policy rule.
" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTable": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableId", + "smithy.api#documentation": "The ID of the transit gateway policy table.
", + "smithy.api#xmlName": "transitGatewayPolicyTableId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "The ID of the transit gateway.
", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The state of the transit gateway policy table
", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "The timestamp when the transit gateway policy table was created.
", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "he key-value pairs associated with the transit gateway policy table.
", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a transit gateway policy table.
" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation": { + "type": "structure", + "members": { + "TransitGatewayPolicyTableId": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayPolicyTableId", + "smithy.api#documentation": "The ID of the transit gateway policy table.
", + "smithy.api#xmlName": "transitGatewayPolicyTableId" + } + }, + "TransitGatewayAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayAttachmentId", + "smithy.api#documentation": "The ID of the transit gateway attachment.
", + "smithy.api#xmlName": "transitGatewayAttachmentId" + } + }, + "ResourceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ResourceId", + "smithy.api#documentation": "The resource ID of the transit gateway attachment.
", + "smithy.api#xmlName": "resourceId" + } + }, + "ResourceType": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentResourceType", + "traits": { + "aws.protocols#ec2QueryName": "ResourceType", + "smithy.api#documentation": "The resource type for the transit gateway policy table association.
", + "smithy.api#xmlName": "resourceType" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayAssociationState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The state of the transit gateway policy table association.
", + "smithy.api#xmlName": "state" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a transit gateway policy table association.
" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableAssociation", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableEntry": { + "type": "structure", + "members": { + "PolicyRuleNumber": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PolicyRuleNumber", + "smithy.api#documentation": "The rule number for the transit gateway policy table entry.
", + "smithy.api#xmlName": "policyRuleNumber" + } + }, + "PolicyRule": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyRule", + "traits": { + "aws.protocols#ec2QueryName": "PolicyRule", + "smithy.api#documentation": "The policy rule associated with the transit gateway policy table.
", + "smithy.api#xmlName": "policyRule" + } + }, + "TargetRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TargetRouteTableId", + "smithy.api#documentation": "The ID of the target route table.
", + "smithy.api#xmlName": "targetRouteTableId" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a transit gateway policy table entry
" + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableEntry", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTableId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayPolicyTable", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayPolicyTableState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "pending", + "name": "pending" + }, + { + "value": "available", + "name": "available" + }, + { + "value": "deleting", + "name": "deleting" + }, + { + "value": "deleted", + "name": "deleted" + } + ] + } + }, "com.amazonaws.ec2#TransitGatewayPrefixListAttachment": { "type": "structure", "members": { @@ -76258,6 +77229,14 @@ "smithy.api#documentation": "The state.
", "smithy.api#xmlName": "state" } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "The ID of the transit gateway route table announcement.
", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } } }, "traits": { @@ -76362,6 +77341,13 @@ "smithy.api#xmlName": "prefixListId" } }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + }, "TransitGatewayAttachments": { "target": "com.amazonaws.ec2#TransitGatewayRouteAttachmentList", "traits": { @@ -76532,6 +77518,167 @@ "smithy.api#documentation": "Describes a transit gateway route table.
" } }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "The ID of the transit gateway route table announcement.
", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } + }, + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayId", + "smithy.api#documentation": "The ID of the transit gateway.
", + "smithy.api#xmlName": "transitGatewayId" + } + }, + "CoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkId", + "smithy.api#xmlName": "coreNetworkId" + } + }, + "PeerTransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "PeerTransitGatewayId", + "smithy.api#documentation": "The ID of the peer transit gateway.
", + "smithy.api#xmlName": "peerTransitGatewayId" + } + }, + "PeerCoreNetworkId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerCoreNetworkId", + "smithy.api#xmlName": "peerCoreNetworkId" + } + }, + "PeeringAttachmentId": { + "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", + "traits": { + "aws.protocols#ec2QueryName": "PeeringAttachmentId", + "smithy.api#documentation": "The ID of the peering attachment.
", + "smithy.api#xmlName": "peeringAttachmentId" + } + }, + "AnnouncementDirection": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementDirection", + "traits": { + "aws.protocols#ec2QueryName": "AnnouncementDirection", + "smithy.api#documentation": "The direction for the route table announcement.
", + "smithy.api#xmlName": "announcementDirection" + } + }, + "TransitGatewayRouteTableId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableId", + "smithy.api#documentation": "The ID of the transit gateway route table.
", + "smithy.api#xmlName": "transitGatewayRouteTableId" + } + }, + "State": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The state of the transit gateway announcement.
", + "smithy.api#xmlName": "state" + } + }, + "CreationTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreationTime", + "smithy.api#documentation": "The timestamp when the transit gateway route table announcement was created.
", + "smithy.api#xmlName": "creationTime" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The key-value pairs associated with the route table announcement.
", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a transit gateway route table announcement.
" + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementDirection": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "outgoing", + "name": "outgoing" + }, + { + "value": "incoming", + "name": "incoming" + } + ] + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId": { + "type": "string" + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementIdStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementList": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncement", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "available", + "name": "available" + }, + { + "value": "pending", + "name": "pending" + }, + { + "value": "failing", + "name": "failing" + }, + { + "value": "failed", + "name": "failed" + }, + { + "value": "deleting", + "name": "deleting" + }, + { + "value": "deleted", + "name": "deleted" + } + ] + } + }, "com.amazonaws.ec2#TransitGatewayRouteTableAssociation": { "type": "structure", "members": { @@ -76636,6 +77783,14 @@ "smithy.api#documentation": "The state of the resource.
", "smithy.api#xmlName": "state" } + }, + "TransitGatewayRouteTableAnnouncementId": { + "target": "com.amazonaws.ec2#TransitGatewayRouteTableAnnouncementId", + "traits": { + "aws.protocols#ec2QueryName": "TransitGatewayRouteTableAnnouncementId", + "smithy.api#documentation": "The ID of the transit gateway route table announcement.
", + "smithy.api#xmlName": "transitGatewayRouteTableAnnouncementId" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/fms.json b/codegen/sdk/aws-models/fms.json index 48e4261cf01..9bfbcf7646f 100644 --- a/codegen/sdk/aws-models/fms.json +++ b/codegen/sdk/aws-models/fms.json @@ -327,6 +327,9 @@ "input": { "target": "com.amazonaws.fms#AssociateAdminAccountRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" @@ -601,6 +604,9 @@ "input": { "target": "com.amazonaws.fms#DeleteAppsListRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" @@ -633,6 +639,9 @@ "input": { "target": "com.amazonaws.fms#DeleteNotificationChannelRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" @@ -657,6 +666,9 @@ "input": { "target": "com.amazonaws.fms#DeletePolicyRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" @@ -701,6 +713,9 @@ "input": { "target": "com.amazonaws.fms#DeleteProtocolsListRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" @@ -785,6 +800,9 @@ "input": { "target": "com.amazonaws.fms#DisassociateAdminAccountRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" @@ -1866,7 +1884,7 @@ "MarketplaceOnboardingStatus": { "target": "com.amazonaws.fms#MarketplaceSubscriptionOnboardingStatus", "traits": { - "smithy.api#documentation": "The status for subscribing to the third-party firewall vendor in the AWS Marketplace.
\n\n NO_SUBSCRIPTION - The Firewall Manager policy administrator isn't subscribed to the third-party firewall service in the AWS Marketplace.
\n NOT_COMPLETE - The Firewall Manager policy administrator is in the process of subscribing to the third-party firewall service in the Amazon Web Services Marketplace, but doesn't yet have an active subscription.
\n COMPLETE - The Firewall Manager policy administrator has an active subscription to the third-party firewall service in the Amazon Web Services Marketplace.
The status for subscribing to the third-party firewall vendor in the Amazon Web Services Marketplace.
\n\n NO_SUBSCRIPTION - The Firewall Manager policy administrator isn't subscribed to the third-party firewall service in the Amazon Web Services Marketplace.
\n NOT_COMPLETE - The Firewall Manager policy administrator is in the process of subscribing to the third-party firewall service in the Amazon Web Services Marketplace, but doesn't yet have an active subscription.
\n COMPLETE - The Firewall Manager policy administrator has an active subscription to the third-party firewall service in the Amazon Web Services Marketplace.
The stateful rule groups that are used in the Network Firewall firewall policy.
" } + }, + "StatefulDefaultActions": { + "target": "com.amazonaws.fms#NetworkFirewallActionList", + "traits": { + "smithy.api#documentation": "The default actions to take on a packet that doesn't match any stateful rules. The stateful default\naction is optional, and is only valid when using the strict rule order.
\n\n Valid values of the stateful default action:\n
\naws:drop_strict
\naws:drop_established
\naws:alert_strict
\naws:alert_established
\nAdditional options governing how Network Firewall handles stateful rules. The stateful rule groups\nthat you use in your policy must have stateful rule options settings that are compatible with these\nsettings.
" + } } }, "traits": { @@ -3357,7 +3387,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the Network Firewall firewall policy options to configure a centralized deployment\n model.
" + "smithy.api#documentation": "Contains the Network Firewall firewall policy options to configure the policy's deployment model and third-party firewall policy settings.
" } }, "com.amazonaws.fms#PolicySummary": { @@ -3507,6 +3537,12 @@ "target": "com.amazonaws.fms#ProtocolsList" } }, + "com.amazonaws.fms#PriorityNumber": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.fms#ProtectionData": { "type": "string" }, @@ -3685,6 +3721,9 @@ "input": { "target": "com.amazonaws.fms#PutNotificationChannelRequest" }, + "output": { + "target": "smithy.api#Unit" + }, "errors": [ { "target": "com.amazonaws.fms#InternalErrorException" @@ -4352,6 +4391,21 @@ "target": "com.amazonaws.fms#Route" } }, + "com.amazonaws.fms#RuleOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STRICT_ORDER", + "name": "STRICT_ORDER" + }, + { + "value": "DEFAULT_ACTION_ORDER", + "name": "DEFAULT_ACTION_ORDER" + } + ] + } + }, "com.amazonaws.fms#SecurityGroupRemediationAction": { "type": "structure", "members": { @@ -4447,7 +4501,7 @@ "ManagedServiceData": { "target": "com.amazonaws.fms#ManagedServiceData", "traits": { - "smithy.api#documentation": "Details about the service that are specific to the service type, in JSON format.
\nExample: DNS_FIREWALL\n
\n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n
Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.
Example: DNS_FIREWALL\n
\n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n
Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.
Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration. With automatic Availbility Zone\n configuration, Firewall Manager chooses which Availability Zones to create the endpoints in.
\n \"{ \\\"type\\\": \\\"NETWORK_FIREWALL\\\",\n \\\"networkFirewallStatelessRuleGroupReferences\\\": [ { \\\"resourceARN\\\":\n \\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\n \\\"priority\\\": 1 } ], \\\"networkFirewallStatelessDefaultActions\\\": [\n \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ],\n \\\"networkFirewallStatelessFragmentDefaultActions\\\": [ \\\"aws:forward_to_sfe\\\",\n \\\"customActionName\\\" ], \\\"networkFirewallStatelessCustomActions\\\": [ {\n \\\"actionName\\\": \\\"customActionName\\\", \\\"actionDefinition\\\": {\n \\\"publishMetricAction\\\": { \\\"dimensions\\\": [ { \\\"value\\\": \\\"metricdimensionvalue\\\"\n } ] } } } ], \\\"networkFirewallStatefulRuleGroupReferences\\\": [ { \\\"resourceARN\\\":\n \\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\" } ],\n \\\"networkFirewallOrchestrationConfig\\\": { \\\"singleFirewallEndpointPerVPC\\\": false,\n \\\"allowedIPV4CidrList\\\": [ \\\"10.0.0.0/28\\\", \\\"192.168.0.0/28\\\" ],\n \\\"routeManagementAction\\\": \\\"OFF\\\" }, \\\"networkFirewallLoggingConfiguration\\\": {\n \\\"logDestinationConfigs\\\": [ { \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\":\n \\\"ALERT\\\", \\\"logDestination\\\": { \\\"bucketName\\\": \\\"s3-bucket-name\\\" } }, {\n \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\": \\\"FLOW\\\", \\\"logDestination\\\": {\n \\\"bucketName\\\": \\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\": true }\n }\"\n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration, and route management.
\n \"{ \\\"type\\\": \\\"NETWORK_FIREWALL\\\",\n \\\"networkFirewallStatelessRuleGroupReferences\\\": [ { \\\"resourceARN\\\":\n \\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\n \\\"priority\\\": 1 } ], \\\"networkFirewallStatelessDefaultActions\\\": [\n \\\"aws:forward_to_sfe\\\", \\\"customActionName\\\" ],\n \\\"networkFirewallStatelessFragmentDefaultActions\\\": [ \\\"aws:forward_to_sfe\\\",\n \\\"customActionName\\\" ], \\\"networkFirewallStatelessCustomActions\\\": [ {\n \\\"actionName\\\": \\\"customActionName\\\", \\\"actionDefinition\\\": {\n \\\"publishMetricAction\\\": { \\\"dimensions\\\": [ { \\\"value\\\": \\\"metricdimensionvalue\\\"\n } ] } } } ], \\\"networkFirewallStatefulRuleGroupReferences\\\": [ { \\\"resourceARN\\\":\n \\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\" } ],\n \\\"networkFirewallOrchestrationConfig\\\": { \\\"singleFirewallEndpointPerVPC\\\": false,\n \\\"allowedIPV4CidrList\\\": [ \\\"10.0.0.0/28\\\", \\\"192.168.0.0/28\\\" ],\n \\\"routeManagementAction\\\": \\\"MONITOR\\\", \\\"routeManagementTargetTypes\\\": [\n \\\"InternetGateway\\\" ] }, \\\"networkFirewallLoggingConfiguration\\\": {\n \\\"logDestinationConfigs\\\": [ { \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\":\n \\\"ALERT\\\", \\\"logDestination\\\": { \\\"bucketName\\\": \\\"s3-bucket-name\\\" } }, {\n \\\"logDestinationType\\\": \\\"S3\\\", \\\"logType\\\": \\\"FLOW\\\", \\\"logDestination\\\": {\n \\\"bucketName\\\": \\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\": true }\n }\"\n
Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration. With custom Availability Zone configuration,\n you define which specific Availability Zones to create endpoints in by configuring\n firewallCreationConfig.
\n \"{\n \\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\n \\\"networkFirewallStatelessDefaultActions\\\":[ \\\"aws:forward_to_sfe\\\",\n \\\"customActionName\\\" ], \\\"networkFirewallStatelessFragmentDefaultActions\\\":[\n \\\"aws:forward_to_sfe\\\", \\\"fragmentcustomactionname\\\" ],\n \\\"networkFirewallStatelessCustomActions\\\":[ { \\\"actionName\\\":\\\"customActionName\\\",\n \\\"actionDefinition\\\":{ \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ {\n \\\"value\\\":\\\"metricdimensionvalue\\\" } ] } } }, {\n \\\"actionName\\\":\\\"fragmentcustomactionname\\\", \\\"actionDefinition\\\":{\n \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ {\n \\\"value\\\":\\\"fragmentmetricdimensionvalue\\\" } ] } } } ],\n \\\"networkFirewallStatefulRuleGroupReferences\\\":[ {\n \\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"\n } ], \\\"networkFirewallOrchestrationConfig\\\":{ \\\"firewallCreationConfig\\\":{\n \\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ {\n \\\"availabilityZoneId\\\":null, \\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\n \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\" ] }, { ¯\\\"availabilityZoneId\\\":null,\n \\\"availabilityZoneName\\\":\\\"us-east-1b\\\", \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"\n ] } ] } }, \\\"singleFirewallEndpointPerVPC\\\":false, \\\"allowedIPV4CidrList\\\":null,\n \\\"routeManagementAction\\\":\\\"OFF\\\", \\\"networkFirewallLoggingConfiguration\\\":{\n \\\"logDestinationConfigs\\\":[ { \\\"logDestinationType\\\":\\\"S3\\\",\n \\\"logType\\\":\\\"ALERT\\\", \\\"logDestination\\\":{ \\\"bucketName\\\":\\\"s3-bucket-name\\\" } },\n { \\\"logDestinationType\\\":\\\"S3\\\", \\\"logType\\\":\\\"FLOW\\\", \\\"logDestination\\\":{\n \\\"bucketName\\\":\\\"s3-bucket-name\\\" } } ], \\\"overrideExistingConfig\\\":boolean }\n }\"\n
Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration, and route management.
\n \"{\n \\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\n \\\"networkFirewallStatelessDefaultActions\\\":[ \\\"aws:forward_to_sfe\\\",\n \\\"customActionName\\\" ], \\\"networkFirewallStatelessFragmentDefaultActions\\\":[\n \\\"aws:forward_to_sfe\\\", \\\"fragmentcustomactionname\\\" ],\n \\\"networkFirewallStatelessCustomActions\\\":[ { \\\"actionName\\\":\\\"customActionName\\\",\n \\\"actionDefinition\\\":{ \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ {\n \\\"value\\\":\\\"metricdimensionvalue\\\" } ] } } }, {\n \\\"actionName\\\":\\\"fragmentcustomactionname\\\", \\\"actionDefinition\\\":{\n \\\"publishMetricAction\\\":{ \\\"dimensions\\\":[ {\n \\\"value\\\":\\\"fragmentmetricdimensionvalue\\\" } ] } } } ],\n \\\"networkFirewallStatefulRuleGroupReferences\\\":[ {\n \\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"\n } ], \\\"networkFirewallOrchestrationConfig\\\":{ \\\"firewallCreationConfig\\\":{\n \\\"endpointLocation\\\":{ \\\"availabilityZoneConfigList\\\":[ {\n \\\"availabilityZoneId\\\":null, \\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\n \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\" ] }, { ¯\\\"availabilityZoneId\\\":null,\n \\\"availabilityZoneName\\\":\\\"us-east-1b\\\", \\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"\n ] } ] } }, \\\"singleFirewallEndpointPerVPC\\\":false, \\\"allowedIPV4CidrList\\\":null,\n \\\"routeManagementAction\\\":\\\"MONITOR\\\", \\\"routeManagementTargetTypes\\\":[\n \\\"InternetGateway\\\" ], \\\"routeManagementConfig\\\":{\n \\\"allowCrossAZTrafficIfNoEndpoint\\\":true } },\n \\\"networkFirewallLoggingConfiguration\\\":{ \\\"logDestinationConfigs\\\":[ {\n \\\"logDestinationType\\\":\\\"S3\\\", \\\"logType\\\":\\\"ALERT\\\", \\\"logDestination\\\":{\n \\\"bucketName\\\":\\\"s3-bucket-name\\\" } }, { \\\"logDestinationType\\\":\\\"S3\\\",\n \\\"logType\\\":\\\"FLOW\\\", \\\"logDestination\\\":{ \\\"bucketName\\\":\\\"s3-bucket-name\\\" } }\n ], \\\"overrideExistingConfig\\\":boolean } }\"\n
Example: PARTNER_FIREWALL for Firewall Manager
\n \"{\\\"type\\\":\\\"THIRD_PARTY_FIREWALL\\\",\\\"thirdPartyrFirewall\\\":\\\"PALO_ALTO_NETWORKS_CLOUD_NGFW\\\",\\\"thirdPartyFirewallConfig\\\":{\\\"thirdPartyFirewallPolicyList\\\":[\\\"global-123456789012-1\\\"],\\\"networkFirewallLoggingConfiguration\\\":null},\\\"firewallDeploymentModel\\\":{\\\"distributedFirewallDeploymentModel\\\":{\\\"distributedFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.1.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":null},\\\"distributedRouteManagementConfig\\\":null},\\\"centralizedFirewallDeploymentModel\\\":null}}\"\"\n
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions
\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\",\n \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"},\n \\\"overrideCustomerWebaclClassic\\\":true|false}\"\n
For example:\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"\n
The default value for automaticResponseStatus is\n IGNORED. The value for automaticResponseAction is only\n required when automaticResponseStatus is set to ENABLED.\n The default value for overrideCustomerWebaclClassic is\n false.
For other resource types that you can protect with a Shield Advanced policy, this\n ManagedServiceData configuration is an empty string.
Example: WAFV2\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"\n
In the loggingConfiguration, you can specify one\n logDestinationConfigs, you can optionally provide up to 20\n redactedFields, and the RedactedFieldType must be one of\n URI, QUERY_STRING, HEADER, or\n METHOD.
Example: WAF Classic\n
\n \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\":\n [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\":\n \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"\n
Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":true,\\\"version\\\":\\\"Version_2.0\\\",\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesCommonRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"\n
\n To use a specific version of a WAF managed rule group in your Firewall Manager policy, you must set versionEnabled to true, and set version to the version you'd like to use. If you don't set versionEnabled to true, or if you omit versionEnabled, then Firewall Manager uses the default version of the WAF managed rule group.\n
Example: SECURITY_GROUPS_COMMON\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n
Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as\n well as to those in VPCs that the account owns
\n\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n
Example: SECURITY_GROUPS_CONTENT_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n
The security group action for content audit can be ALLOW or\n DENY. For ALLOW, all in-scope security group rules must\n be within the allowed range of the policy's security group rules. For\n DENY, all in-scope security group rules must not contain a value or a\n range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"\n
Details about the service that are specific to the service type, in JSON format.
\nExample: DNS_FIREWALL\n
\n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n
Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.
Example: NETWORK_FIREWALL - Centralized deployment\n model
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}},\\\"firewallDeploymentModel\\\":{\\\"centralizedFirewallDeploymentModel\\\":{\\\"centralizedFirewallOrchestrationConfig\\\":{\\\"inspectionVpcIds\\\":[{\\\"resourceId\\\":\\\"vpc-1234\\\",\\\"accountId\\\":\\\"123456789011\\\"}],\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneId\\\":null,\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"allowedIPV4CidrList\\\":[]}}}}\"\n
To use the centralized deployment model, you must set PolicyOption to\n CENTRALIZED.
Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration
\n \n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"OFF\\\"},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"\n \n
With automatic Availbility Zone configuration, Firewall Manager chooses which Availability Zones to create the endpoints in. To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration and route management
\n \n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\",\\\"192.168.0.0/28\\\"],\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"]},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\": \\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":true}}\"\n \n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\", \\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{ \\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[ \\\"10.0.0.0/28\\\"]}]} },\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"OFF\\\",\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"\n \n
\n With custom Availability Zone configuration,\n you define which specific Availability Zones to create endpoints in by configuring\n firewallCreationConfig. To configure the Availability Zones in firewallCreationConfig, specify either the availabilityZoneName or availabilityZoneId parameter, not both parameters.\n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: NETWORK_FIREWALL - Distributed deployment model with\n custom Availability Zone configuration and route management
\n \"{\\\"type\\\":\\\"NETWORK_FIREWALL\\\",\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateless-rulegroup/test\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"customActionName\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:forward_to_sfe\\\",\\\"fragmentcustomactionname\\\"],\\\"networkFirewallStatelessCustomActions\\\":[{\\\"actionName\\\":\\\"customActionName\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"metricdimensionvalue\\\"}]}}},{\\\"actionName\\\":\\\"fragmentcustomactionname\\\",\\\"actionDefinition\\\":{\\\"publishMetricAction\\\":{\\\"dimensions\\\":[{\\\"value\\\":\\\"fragmentmetricdimensionvalue\\\"}]}}}],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-east-1:123456789011:stateful-rulegroup/test\\\"}],\\\"networkFirewallOrchestrationConfig\\\":{\\\"firewallCreationConfig\\\":{\\\"endpointLocation\\\":{\\\"availabilityZoneConfigList\\\":[{\\\"availabilityZoneName\\\":\\\"us-east-1a\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]},{\\\"availabilityZoneName\\\":\\\"us-east-1b\\\",\\\"allowedIPV4CidrList\\\":[\\\"10.0.0.0/28\\\"]}]}},\\\"singleFirewallEndpointPerVPC\\\":false,\\\"allowedIPV4CidrList\\\":null,\\\"routeManagementAction\\\":\\\"MONITOR\\\",\\\"routeManagementTargetTypes\\\":[\\\"InternetGateway\\\"],\\\"routeManagementConfig\\\":{\\\"allowCrossAZTrafficIfNoEndpoint\\\":true}},\\\"networkFirewallLoggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"ALERT\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}},{\\\"logDestinationType\\\":\\\"S3\\\",\\\"logType\\\":\\\"FLOW\\\",\\\"logDestination\\\":{\\\"bucketName\\\":\\\"s3-bucket-name\\\"}}],\\\"overrideExistingConfig\\\":boolean}}\"\n \n
To use the distributed deployment model, you must set PolicyOption to\n NULL.
Example: THIRD_PARTY_FIREWALL\n
\n \"{\n \"type\":\"THIRD_PARTY_FIREWALL\",\n \"thirdPartyFirewall\":\"PALO_ALTO_NETWORKS_CLOUD_NGFW\",\n \"thirdPartyFirewallConfig\":{\n \"thirdPartyFirewallPolicyList\":[\"global-1\"]\n },\n\t \"firewallDeploymentModel\":{\n \"distributedFirewallDeploymentModel\":{\n \"distributedFirewallOrchestrationConfig\":{\n \"firewallCreationConfig\":{\n \"endpointLocation\":{\n \"availabilityZoneConfigList\":[\n {\n \"availabilityZoneName\":\"${AvailabilityZone}\"\n }\n ]\n }\n },\n \"allowedIPV4CidrList\":[\n ]\n }\n }\n }\n }\"\n
Specification for SHIELD_ADVANCED for Amazon CloudFront distributions
\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\",\n \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"},\n \\\"overrideCustomerWebaclClassic\\\":true|false}\"\n
For example:\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"\n
The default value for automaticResponseStatus is\n IGNORED. The value for automaticResponseAction is only\n required when automaticResponseStatus is set to ENABLED.\n The default value for overrideCustomerWebaclClassic is\n false.
For other resource types that you can protect with a Shield Advanced policy, this\n ManagedServiceData configuration is an empty string.
Example: WAFV2\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAmazonIpReputationList\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"\n
In the loggingConfiguration, you can specify one\n logDestinationConfigs, you can optionally provide up to 20\n redactedFields, and the RedactedFieldType must be one of\n URI, QUERY_STRING, HEADER, or\n METHOD.
Example: WAF Classic\n
\n \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\":\n [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\":\n \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"\n
Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning\n
\n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":true,\\\"version\\\":\\\"Version_2.0\\\",\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesCommonRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[{\\\"name\\\":\\\"NoUserAgent_HEADER\\\"}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\":[\\\"arn:aws:firehose:us-west-2:12345678912:deliverystream/aws-waf-logs-fms-admin-destination\\\"],\\\"redactedFields\\\":[{\\\"redactedFieldType\\\":\\\"SingleHeader\\\",\\\"redactedFieldValue\\\":\\\"Cookies\\\"},{\\\"redactedFieldType\\\":\\\"Method\\\"}]}}\"\n
\n To use a specific version of a WAF managed rule group in your Firewall Manager policy, you must set versionEnabled to true, and set version to the version you'd like to use. If you don't set versionEnabled to true, or if you omit versionEnabled, then Firewall Manager uses the default version of the WAF managed rule group.\n
Example: SECURITY_GROUPS_COMMON\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n
Example: SECURITY_GROUPS_COMMON - Security group tag distribution\n
\n \"\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"revertManualSecurityGroupChanges\\\":true,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":false,\\\"enableTagDistribution\\\":true}\"\"\n
\n Firewall Manager automatically distributes tags from the primary group to the security groups created by this policy. To use security group tag distribution, you must also set revertManualSecurityGroupChanges to true, otherwise Firewall Manager won't be able to create the policy. When you enable revertManualSecurityGroupChanges, Firewall Manager identifies and reports when the security groups created by this policy become non-compliant.\n
\n Firewall Manager won't distrubute system tags added by Amazon Web Services services into the replica security groups. System tags begin with the aws: prefix.\n
Example: Shared VPCs. Apply the preceding policy to resources in shared VPCs as\n well as to those in VPCs that the account owns
\n\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n
Example: SECURITY_GROUPS_CONTENT_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n
The security group action for content audit can be ALLOW or\n DENY. For ALLOW, all in-scope security group rules must\n be within the allowed range of the policy's security group rules. For\n DENY, all in-scope security group rules must not contain a value or a\n range that matches a rule value or range in the policy security group.
Example: SECURITY_GROUPS_USAGE_AUDIT\n
\n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"\n
Indicates how to manage the order of stateful rule evaluation for the policy.\nDEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine\nas Suricata compatible strings, and Suricata evaluates them based on certain settings. For more\ninformation, see Evaluation order for stateful rules in the Network Firewall Developer Guide.
Configuration settings for the handling of the stateful rule groups in a Network Firewall firewall policy.
" + } + }, "com.amazonaws.fms#StatefulRuleGroup": { "type": "structure", "members": { @@ -4518,6 +4586,12 @@ "traits": { "smithy.api#documentation": "The resource ID of the rule group.
" } + }, + "Priority": { + "target": "com.amazonaws.fms#PriorityNumber", + "traits": { + "smithy.api#documentation": "An integer setting that indicates the order in which to run the stateful rule groups in a single\nNetwork Firewall firewall policy. This setting only applies to firewall policies that specify the STRICT_ORDER\nrule order in the stateful engine options settings.
\n Network Firewall evalutes each stateful rule group against a packet starting with the group that has\nthe lowest priority setting. You must ensure that the priority settings are unique within each policy. For information about\n
\n\n You can change the priority settings of your rule groups at any time. To make it easier to insert rule\ngroups later, number them so there's a wide range in between, for example use 100, 200, and so on.\n
" + } } }, "traits": { @@ -4813,7 +4887,7 @@ } }, "traits": { - "smithy.api#documentation": "Configures the firewall policy deployment model for a third-party firewall. The deployment model can either be distributed or centralized.
" + "smithy.api#documentation": "Configures the third-party firewall's firewall policy.
" } }, "com.amazonaws.fms#ThirdPartyFirewallMissingExpectedRouteTableViolation": { @@ -4924,12 +4998,12 @@ "FirewallDeploymentModel": { "target": "com.amazonaws.fms#FirewallDeploymentModel", "traits": { - "smithy.api#documentation": "Defines the deployment model to use for the third-party firewall.
" + "smithy.api#documentation": "Defines the deployment model to use for the third-party firewall policy.
" } } }, "traits": { - "smithy.api#documentation": "Configures the policy for the third-party firewall.
" + "smithy.api#documentation": "Configures the deployment model for the third-party firewall.
" } }, "com.amazonaws.fms#TimeStamp": { diff --git a/codegen/sdk/aws-models/glue.json b/codegen/sdk/aws-models/glue.json index b6db3ce2e55..952d894c971 100644 --- a/codegen/sdk/aws-models/glue.json +++ b/codegen/sdk/aws-models/glue.json @@ -2686,7 +2686,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels the statement..
" + "smithy.api#documentation": "Cancels the statement.
" } }, "com.amazonaws.glue#CancelStatementRequest": { @@ -5891,7 +5891,7 @@ "DefaultArguments": { "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "The default arguments for this job.
\nYou can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.
\nFor information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
\nFor information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + "smithy.api#documentation": "The default arguments for this job.
\nYou can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.
\nJob arguments may be logged. Do not pass plaintext secrets as arguments.\n Retrieve secrets from a Glue Connection, Secrets Manager or\n other secret management mechanism if you intend to keep them within the Job.\n
\nFor information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
\n\t \nFor information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" } }, "NonOverridableArguments": { @@ -5918,7 +5918,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "This parameter is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this Job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.
" + "smithy.api#documentation": "This parameter is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this Job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.
" } }, "Timeout": { @@ -5930,7 +5930,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\t\t \n\tDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\") or Apache \n Spark streaming ETL job (JobCommand.Name=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. \n The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\t\t \n\tDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\") or Apache \n Spark streaming ETL job (JobCommand.Name=\"gluestreaming\"), you can allocate a minimum of 2 DPUs. \n The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. \n A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
" + "smithy.api#documentation": "The number of Glue data processing units (DPUs) that can be allocated when the job runs. \n A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
" } }, "NumberOfWorkers": { "target": "com.amazonaws.glue#NullableInteger", "traits": { - "smithy.api#documentation": "The number of workers to use for the session.
" + "smithy.api#documentation": "The number of workers of a defined WorkerType to use for the session.
The Worker Type. Can be one of G.1X, G.2X, Standard
" + "smithy.api#documentation": "The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The Glue version determines the versions of Apache Spark and Python that AWS Glue supports. \n The GlueVersion must be greater than 2.0.
" + "smithy.api#documentation": "The Glue version determines the versions of Apache Spark and Python that Glue supports. \n The GlueVersion must be greater than 2.0.
" } }, "Tags": { @@ -9620,7 +9620,7 @@ } }, "traits": { - "smithy.api#documentation": "An edge represents a directed connection between two components\n on a workflow graph.
" + "smithy.api#documentation": "An edge represents a directed connection between two Glue components that are part of the workflow the\n edge belongs to.
" } }, "com.amazonaws.glue#EdgeList": { @@ -15107,10 +15107,14 @@ "type": "structure", "members": { "Message": { - "target": "com.amazonaws.glue#MessageString" + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } } }, "traits": { + "smithy.api#documentation": "The blueprint is in an invalid state to perform a requested operation.
", "smithy.api#error": "client" } }, @@ -15725,7 +15729,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.
\n\t " + "smithy.api#documentation": "This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.
\n\t " } }, "Timeout": { @@ -15737,19 +15741,19 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\t \n\tDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\") or Apache \n Spark streaming ETL job (JobCommand.Name=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. \n The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\t \n\tDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL\n job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\") or Apache \n Spark streaming ETL job (JobCommand.Name=\"gluestreaming\"), you can allocate a minimum of 2 DPUs. \n The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\nDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\nDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
\nFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
\nFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this job. You can\n allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.
" + "smithy.api#documentation": "This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this job. You can\n allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing\n power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information,\n see the Glue pricing\n page.
" } }, "Timeout": { @@ -16186,19 +16190,19 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
\n \n\tDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\") or Apache \n Spark streaming ETL job (JobCommand.Name=\"gluestreaming\"), you can allocate from 2 to 100 DPUs. \n The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
\n \n\tDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\") or Apache \n Spark streaming ETL job (JobCommand.Name=\"gluestreaming\"), you can allocate a minimum of 2 DPUs. \n The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
For Glue version 2.0 jobs, you cannot instead specify a Maximum capacity. Instead, you should specify a Worker type and the Number of workers.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
\n\tFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
Retrieve a session..
", + "smithy.api#documentation": "Retrieve a list of sessions.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -17595,7 +17599,7 @@ "Ids": { "target": "com.amazonaws.glue#SessionIdList", "traits": { - "smithy.api#documentation": "Returns the Id of the session.
" + "smithy.api#documentation": "Returns the ID of the session.
" } }, "Sessions": { @@ -17661,7 +17665,10 @@ } }, "NextToken": { - "target": "com.amazonaws.glue#OrchestrationToken" + "target": "com.amazonaws.glue#OrchestrationToken", + "traits": { + "smithy.api#documentation": "A continuation token, if this is a continuation call.
" + } } } }, @@ -17675,7 +17682,10 @@ } }, "NextToken": { - "target": "com.amazonaws.glue#OrchestrationToken" + "target": "com.amazonaws.glue#OrchestrationToken", + "traits": { + "smithy.api#documentation": "A continuation token, if not all statements have yet been returned.
" + } } } }, @@ -22464,7 +22474,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "The number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. \n A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
" + "smithy.api#documentation": "The number of Glue data processing units (DPUs) that can be allocated when the job runs. \n A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
" } }, "SecurityConfiguration": { @@ -22476,7 +22486,7 @@ "GlueVersion": { "target": "com.amazonaws.glue#GlueVersionString", "traits": { - "smithy.api#documentation": "The Glue version determines the versions of Apache Spark and Python that AWS Glue supports. \n The GlueVersion must be greater than 2.0.
" + "smithy.api#documentation": "The Glue version determines the versions of Apache Spark and Python that Glue supports. \n The GlueVersion must be greater than 2.0.
" } } }, @@ -22490,7 +22500,7 @@ "Name": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "Specifies the name of the SessionCommand.Can be 'glueetl' or 'gluestreaming'.
" + "smithy.api#documentation": "Specifies the name of the SessionCommand. Can be 'glueetl' or 'gluestreaming'.
" } }, "PythonVersion": { @@ -23208,7 +23218,7 @@ "Arguments": { "target": "com.amazonaws.glue#GenericMap", "traits": { - "smithy.api#documentation": "The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.
\nYou can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.
\nFor information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
\nFor information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" + "smithy.api#documentation": "The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.
\nYou can specify arguments here that your own job-execution script\n consumes, as well as arguments that Glue itself consumes.
\nJob arguments may be logged. Do not pass plaintext secrets as arguments.\n Retrieve secrets from a Glue Connection, Secrets Manager or\n other secret management mechanism if you intend to keep them within the Job.\n
\nFor information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
\nFor information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
" } }, "AllocatedCapacity": { @@ -23217,7 +23227,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use MaxCapacity instead." }, - "smithy.api#documentation": "This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun.\n From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
" + "smithy.api#documentation": "This field is deprecated. Use MaxCapacity instead.
The number of Glue data processing units (DPUs) to allocate to this JobRun.\n You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
" } }, "Timeout": { @@ -23229,7 +23239,7 @@ "MaxCapacity": { "target": "com.amazonaws.glue#NullableDouble", "traits": { - "smithy.api#documentation": "The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\nDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure\n of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.\n For more information, see the Glue\n pricing page.
\n\nDo not set Max Capacity if using WorkerType and NumberOfWorkers.
The value that can be allocated for MaxCapacity depends on whether you are\n running a Python shell job, or an Apache Spark ETL job:
When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can\n allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
\nFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
\nFor the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
The number of workers of a defined workerType that are allocated when a job runs.
The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
The number of workers of a defined workerType that are allocated when a job runs.
Updates an existing job definition.
" + "smithy.api#documentation": "Updates an existing job definition. The previous job definition is completely overwritten by this information.
" } }, "com.amazonaws.glue#UpdateJobRequest": { @@ -26222,7 +26232,7 @@ "JobUpdate": { "target": "com.amazonaws.glue#JobUpdate", "traits": { - "smithy.api#documentation": "Specifies the values with which to update the job definition.
", + "smithy.api#documentation": "Specifies the values with which to update the job definition. Unspecified configuration is removed or reset to default values.
", "smithy.api#required": {} } } @@ -27130,6 +27140,10 @@ { "value": "G.2X", "name": "G_2X" + }, + { + "value": "G.025X", + "name": "G_025X" } ] } diff --git a/codegen/sdk/aws-models/inspector2.json b/codegen/sdk/aws-models/inspector2.json index 6fda5a17db9..921f67db439 100644 --- a/codegen/sdk/aws-models/inspector2.json +++ b/codegen/sdk/aws-models/inspector2.json @@ -514,9 +514,9 @@ "traits": { "smithy.api#documentation": "Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/members/associate", - "code": 200 + "uri": "/members/associate" } } }, @@ -857,9 +857,9 @@ "traits": { "smithy.api#documentation": "Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/status/batch/get", - "code": 200 + "uri": "/status/batch/get" } } }, @@ -917,9 +917,9 @@ "traits": { "smithy.api#documentation": "Gets free trial status for multiple Amazon Web Services accounts.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/freetrialinfo/batchget", - "code": 200 + "uri": "/freetrialinfo/batchget" } } }, @@ -986,9 +986,9 @@ "traits": { "smithy.api#documentation": "Cancels the given findings report.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/reporting/cancel", - "code": 200 + "uri": "/reporting/cancel" } } }, @@ -1123,7 +1123,7 @@ "resourceType": { "target": "com.amazonaws.inspector2#CoverageStringFilterList", "traits": { - "smithy.api#documentation": "An array of Amazon Web Services resource types to return coverage statistics for.
" + "smithy.api#documentation": "An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY.
Creates a filter resource using specified filter criteria.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/filters/create", - "code": 200 + "uri": "/filters/create" } } }, @@ -1409,6 +1409,12 @@ "traits": { "smithy.api#documentation": "A list of tags for the filter.
" } + }, + "reason": { + "target": "com.amazonaws.inspector2#FilterReason", + "traits": { + "smithy.api#documentation": "The reason for creating the filter.
" + } } } }, @@ -1452,9 +1458,9 @@ "traits": { "smithy.api#documentation": "Creates a finding report.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/reporting/create", - "code": 200 + "uri": "/reporting/create" } } }, @@ -1499,8 +1505,8 @@ "traits": { "smithy.api#enum": [ { - "value": "USD", - "name": "USD" + "name": "USD", + "value": "USD" } ] } @@ -1753,9 +1759,9 @@ "traits": { "smithy.api#documentation": "Deletes a filter resource.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/filters/delete", - "code": 200 + "uri": "/filters/delete" } } }, @@ -1808,9 +1814,9 @@ "traits": { "smithy.api#documentation": "Describe Amazon Inspector configuration settings for an Amazon Web Services organization
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/organizationconfiguration/describe", - "code": 200 + "uri": "/organizationconfiguration/describe" } } }, @@ -1891,9 +1897,9 @@ "traits": { "smithy.api#documentation": "Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account\n disables the Amazon Inspector service.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/disable", - "code": 200 + "uri": "/disable" } } }, @@ -1928,9 +1934,9 @@ "traits": { "smithy.api#documentation": "Disables the Amazon Inspector delegated administrator for your organization.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/delegatedadminaccounts/disable", - "code": 200 + "uri": "/delegatedadminaccounts/disable" } } }, @@ -2029,9 +2035,9 @@ "traits": { "smithy.api#documentation": "Disassociates a member account from an Amazon Inspector delegated administrator.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/members/disassociate", - "code": 200 + "uri": "/members/disassociate" } } }, @@ -2222,6 +2228,35 @@ ] } }, + "com.amazonaws.inspector2#EcrConfiguration": { + "type": "structure", + "members": { + "rescanDuration": { + "target": "com.amazonaws.inspector2#EcrRescanDuration", + "traits": { + "smithy.api#documentation": "The ECR automated re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the automated re-scan duration the monitoring state of that image becomes inactive and all associated findings are scheduled for closure.
Details about the ECR automated re-scan duration setting for your environment
" + } + }, + "com.amazonaws.inspector2#EcrConfigurationState": { + "type": "structure", + "members": { + "rescanDurationState": { + "target": "com.amazonaws.inspector2#EcrRescanDurationState", + "traits": { + "smithy.api#documentation": "An object that contains details about the state of the ECR automated re-scan setting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the state of the ECR scans for your environment.
" + } + }, "com.amazonaws.inspector2#EcrContainerImageMetadata": { "type": "structure", "members": { @@ -2256,6 +2291,70 @@ "smithy.api#documentation": "Information on the Amazon ECR repository metadata associated with a finding.
" } }, + "com.amazonaws.inspector2#EcrRescanDuration": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "LIFETIME", + "name": "LIFETIME" + }, + { + "value": "DAYS_30", + "name": "DAYS_30" + }, + { + "value": "DAYS_180", + "name": "DAYS_180" + } + ] + } + }, + "com.amazonaws.inspector2#EcrRescanDurationState": { + "type": "structure", + "members": { + "rescanDuration": { + "target": "com.amazonaws.inspector2#EcrRescanDuration", + "traits": { + "smithy.api#documentation": "The ECR automated re-scan duration defines how long an ECR image will be actively scanned by Amazon Inspector. When the number of days since an image was last pushed exceeds the automated re-scan duration the monitoring state of that image becomes inactive and all associated findings are scheduled for closure.
The status of changes to the ECR automated re-scan duration.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "A timestamp representing when the last time the ECR scan duration setting was changed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the state of any changes to the ECR automated re-scan duration setting.
" + } + }, + "com.amazonaws.inspector2#EcrRescanDurationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, "com.amazonaws.inspector2#EcrScanFrequency": { "type": "string", "traits": { @@ -2303,9 +2402,9 @@ "traits": { "smithy.api#documentation": "Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/enable", - "code": 200 + "uri": "/enable" } } }, @@ -2340,9 +2439,9 @@ "traits": { "smithy.api#documentation": "Enables the Amazon Inspector delegated administrator for your Organizations organization.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/delegatedadminaccounts/enable", - "code": 200 + "uri": "/delegatedadminaccounts/enable" } } }, @@ -2487,6 +2586,10 @@ { "value": "DISASSOCIATE_ALL_MEMBERS", "name": "DISASSOCIATE_ALL_MEMBERS" + }, + { + "value": "ACCOUNT_IS_ISOLATED", + "name": "ACCOUNT_IS_ISOLATED" } ] } @@ -3266,12 +3369,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ACCESS_DENIED", - "name": "ACCESS_DENIED" + "name": "ACCESS_DENIED", + "value": "ACCESS_DENIED" }, { - "value": "INTERNAL_ERROR", - "name": "INTERNAL_ERROR" + "name": "INTERNAL_ERROR", + "value": "INTERNAL_ERROR" } ] } @@ -3293,12 +3396,12 @@ "traits": { "smithy.api#enum": [ { - "value": "ACTIVE", - "name": "ACTIVE" + "name": "ACTIVE", + "value": "ACTIVE" }, { - "value": "INACTIVE", - "name": "INACTIVE" + "name": "INACTIVE", + "value": "INACTIVE" } ] } @@ -3308,16 +3411,59 @@ "traits": { "smithy.api#enum": [ { - "value": "EC2", - "name": "EC2" + "name": "EC2", + "value": "EC2" }, { - "value": "ECR", - "name": "ECR" + "name": "ECR", + "value": "ECR" } ] } }, + "com.amazonaws.inspector2#GetConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#GetConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#GetConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves setting configurations for Inspector scans.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configuration/get" + } + } + }, + "com.amazonaws.inspector2#GetConfigurationRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.inspector2#GetConfigurationResponse": { + "type": "structure", + "members": { + "ecrConfiguration": { + "target": "com.amazonaws.inspector2#EcrConfigurationState", + "traits": { + "smithy.api#documentation": "Specifies how the ECR automated re-scan duration is currently configured for your environment.
" + } + } + } + }, "com.amazonaws.inspector2#GetDelegatedAdminAccount": { "type": "operation", "input": { @@ -3346,9 +3492,9 @@ "traits": { "smithy.api#documentation": "Retrieves information about the Amazon Inspector delegated administrator for your\n organization.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/delegatedadminaccounts/get", - "code": 200 + "uri": "/delegatedadminaccounts/get" } } }, @@ -3395,9 +3541,9 @@ "traits": { "smithy.api#documentation": "Gets the status of a findings report.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/reporting/status/get", - "code": 200 + "uri": "/reporting/status/get" } } }, @@ -3481,9 +3627,9 @@ "traits": { "smithy.api#documentation": "Gets member information for your organization.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/members/get", - "code": 200 + "uri": "/members/get" } } }, @@ -3658,9 +3804,8 @@ "aws.api#service": { "sdkId": "Inspector2", "arnNamespace": "inspector2", - "cloudFormationName": "Inspector2", "cloudTrailEventSource": "inspector2.amazon.aws", - "endpointPrefix": "inspector2" + "cloudFormationName": "Inspector2" }, "aws.auth#sigv4": { "name": "inspector2" @@ -3715,6 +3860,9 @@ { "target": "com.amazonaws.inspector2#EnableDelegatedAdminAccount" }, + { + "target": "com.amazonaws.inspector2#GetConfiguration" + }, { "target": "com.amazonaws.inspector2#GetDelegatedAdminAccount" }, @@ -3760,6 +3908,9 @@ { "target": "com.amazonaws.inspector2#UntagResource" }, + { + "target": "com.amazonaws.inspector2#UpdateConfiguration" + }, { "target": "com.amazonaws.inspector2#UpdateFilter" }, @@ -3862,15 +4013,15 @@ "traits": { "smithy.api#documentation": "Lists the permissions an account has to configure Amazon Inspector.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/accountpermissions/list", - "code": 200 + "uri": "/accountpermissions/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "permissions", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "permissions" } } }, @@ -3947,15 +4098,15 @@ "traits": { "smithy.api#documentation": "Lists coverage details for you environment.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/coverage/list", - "code": 200 + "uri": "/coverage/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "coveredResources", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "coveredResources" } } }, @@ -4031,9 +4182,9 @@ "traits": { "smithy.api#documentation": "Lists Amazon Inspector coverage statistics for your environment.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/coverage/statistics/list", - "code": 200 + "uri": "/coverage/statistics/list" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -4114,15 +4265,15 @@ "traits": { "smithy.api#documentation": "Lists information about the Amazon Inspector delegated administrator of your\n organization.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/delegatedadminaccounts/list", - "code": 200 + "uri": "/delegatedadminaccounts/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "delegatedAdminAccounts", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "delegatedAdminAccounts" } } }, @@ -4205,15 +4356,15 @@ "traits": { "smithy.api#documentation": "Lists the filters associated with your account.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/filters/list", - "code": 200 + "uri": "/filters/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "filters", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "filters" } } }, @@ -4286,15 +4437,15 @@ "traits": { "smithy.api#documentation": "Lists aggregated finding data for your environment based on specific criteria.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/findings/aggregation/list", - "code": 200 + "uri": "/findings/aggregation/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "responses", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "responses" } } }, @@ -4390,15 +4541,15 @@ "traits": { "smithy.api#documentation": "Lists findings for your environment.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/findings/list", - "code": 200 + "uri": "/findings/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "findings", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "findings" } } }, @@ -4483,15 +4634,15 @@ "traits": { "smithy.api#documentation": "List members associated with the Amazon Inspector delegated administrator for your\n organization.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/members/list", - "code": 200 + "uri": "/members/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "members", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "members" } } }, @@ -4570,9 +4721,8 @@ "traits": { "smithy.api#documentation": "Lists all tags attached to a given resource.
", "smithy.api#http": { - "method": "GET", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "GET" }, "smithy.api#readonly": {} } @@ -4626,15 +4776,15 @@ "traits": { "smithy.api#documentation": "Lists the Amazon Inspector usage totals over the last 30 days.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/usage/list", - "code": 200 + "uri": "/usage/list" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "totals", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "totals" } } }, @@ -5145,6 +5295,22 @@ { "value": "OS", "name": "OS" + }, + { + "value": "PIP", + "name": "PIP" + }, + { + "value": "PYTHONPKG", + "name": "PYTHONPKG" + }, + { + "value": "NODEPKG", + "name": "NODEPKG" + }, + { + "value": "POM", + "name": "POM" } ] } @@ -5494,6 +5660,22 @@ { "value": "INVALID_PERMISSIONS", "name": "INVALID_PERMISSIONS" + }, + { + "value": "NO_FINDINGS_FOUND", + "name": "NO_FINDINGS_FOUND" + }, + { + "value": "BUCKET_NOT_FOUND", + "name": "BUCKET_NOT_FOUND" + }, + { + "value": "INCOMPATIBLE_BUCKET_REGION", + "name": "INCOMPATIBLE_BUCKET_REGION" + }, + { + "value": "MALFORMED_KMS_KEY", + "name": "MALFORMED_KMS_KEY" } ] } @@ -5880,6 +6062,10 @@ { "value": "EC2_INSTANCE_STOPPED", "name": "EC2_INSTANCE_STOPPED" + }, + { + "value": "PENDING_DISABLE", + "name": "PENDING_DISABLE" } ] } @@ -6345,9 +6531,8 @@ "traits": { "smithy.api#documentation": "Adds tags to a resource.
", "smithy.api#http": { - "method": "POST", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "POST" }, "smithy.api#idempotent": {} } @@ -6507,9 +6692,8 @@ "traits": { "smithy.api#documentation": "Removes tags from a resource.
", "smithy.api#http": { - "method": "DELETE", "uri": "/tags/{resourceArn}", - "code": 200 + "method": "DELETE" } } }, @@ -6538,6 +6722,53 @@ "type": "structure", "members": {} }, + "com.amazonaws.inspector2#UpdateConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.inspector2#UpdateConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.inspector2#UpdateConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.inspector2#AccessDeniedException" + }, + { + "target": "com.amazonaws.inspector2#InternalServerException" + }, + { + "target": "com.amazonaws.inspector2#ThrottlingException" + }, + { + "target": "com.amazonaws.inspector2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates setting configurations for your Amazon Inspector account. When you use this API as an Amazon Inspector delegated administrator this updates the setting for all accounts you manage. Member accounts in an organization cannot update this setting.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configuration/update" + } + } + }, + "com.amazonaws.inspector2#UpdateConfigurationRequest": { + "type": "structure", + "members": { + "ecrConfiguration": { + "target": "com.amazonaws.inspector2#EcrConfiguration", + "traits": { + "smithy.api#documentation": "Specifies how the ECR automated re-scan will be updated for your environment.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.inspector2#UpdateConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.inspector2#UpdateFilter": { "type": "operation", "input": { @@ -6566,9 +6797,9 @@ "traits": { "smithy.api#documentation": "Specifies the action that is to be applied to the findings that match the filter.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/filters/update", - "code": 200 + "uri": "/filters/update" } } }, @@ -6605,6 +6836,12 @@ "smithy.api#documentation": "The Amazon Resource Number (ARN) of the filter to update.
", "smithy.api#required": {} } + }, + "reason": { + "target": "com.amazonaws.inspector2#FilterReason", + "traits": { + "smithy.api#documentation": "The reason the filter was updated.
" + } } } }, @@ -6645,9 +6882,9 @@ "traits": { "smithy.api#documentation": "Updates the configurations for your Amazon Inspector organization.
", "smithy.api#http": { + "code": 200, "method": "POST", - "uri": "/organizationconfiguration/update", - "code": 200 + "uri": "/organizationconfiguration/update" } } }, @@ -6762,16 +6999,16 @@ "traits": { "smithy.api#enum": [ { - "value": "EC2_INSTANCE_HOURS", - "name": "EC2_INSTANCE_HOURS" + "name": "EC2_INSTANCE_HOURS", + "value": "EC2_INSTANCE_HOURS" }, { - "value": "ECR_INITIAL_SCAN", - "name": "ECR_INITIAL_SCAN" + "name": "ECR_INITIAL_SCAN", + "value": "ECR_INITIAL_SCAN" }, { - "value": "ECR_RESCAN", - "name": "ECR_RESCAN" + "name": "ECR_RESCAN", + "value": "ECR_RESCAN" } ] } @@ -6865,7 +7102,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 64 + "max": 128 } } }, diff --git a/codegen/sdk/aws-models/iot-wireless.json b/codegen/sdk/aws-models/iot-wireless.json index d56e7f7bbee..3880872550b 100644 --- a/codegen/sdk/aws-models/iot-wireless.json +++ b/codegen/sdk/aws-models/iot-wireless.json @@ -97,6 +97,26 @@ "com.amazonaws.iotwireless#AccountLinked": { "type": "boolean" }, + "com.amazonaws.iotwireless#Accuracy": { + "type": "structure", + "members": { + "HorizontalAccuracy": { + "target": "com.amazonaws.iotwireless#HorizontalAccuracy", + "traits": { + "smithy.api#documentation": "The horizontal accuracy of the estimated position in meters.
" + } + }, + "VerticalAccuracy": { + "target": "com.amazonaws.iotwireless#VerticalAccuracy", + "traits": { + "smithy.api#documentation": "The vertical accuracy of the estimated position in meters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The accuracy of the estimated position in meters. An empty value indicates that no position data is available. \n A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information\n that you specified instead of the position computed by solver.
" + } + }, "com.amazonaws.iotwireless#AddGwMetadata": { "type": "boolean" }, @@ -804,7 +824,7 @@ "WirelessGatewayIdEventTopic": { "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", "traits": { - "smithy.api#documentation": "Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled\n .
" + "smithy.api#documentation": "Enum to denote whether the wireless gateway ID connection status event topic is enabled or disabled.
" } } }, @@ -3251,6 +3271,12 @@ }, "ClockSync": { "target": "com.amazonaws.iotwireless#FPort" + }, + "Positioning": { + "target": "com.amazonaws.iotwireless#Positioning", + "traits": { + "smithy.api#documentation": "FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
" + } } }, "traits": { @@ -3632,7 +3658,7 @@ } ], "traits": { - "smithy.api#documentation": "Get the event configuration by resource types.
", + "smithy.api#documentation": "Get the event configuration based on resource types.
", "smithy.api#http": { "method": "GET", "uri": "/event-configurations-resource-types", @@ -3650,25 +3676,25 @@ "DeviceRegistrationState": { "target": "com.amazonaws.iotwireless#DeviceRegistrationStateResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Resource type event configuration for the device registration state event
" + "smithy.api#documentation": "Resource type event configuration for the device registration state event.
" } }, "Proximity": { "target": "com.amazonaws.iotwireless#ProximityResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Resource type event configuration for the proximity event
" + "smithy.api#documentation": "Resource type event configuration for the proximity event.
" } }, "Join": { "target": "com.amazonaws.iotwireless#JoinResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Resource type event configuration for the join event
" + "smithy.api#documentation": "Resource type event configuration for the join event.
" } }, "ConnectionStatus": { "target": "com.amazonaws.iotwireless#ConnectionStatusResourceTypeEventConfiguration", "traits": { - "smithy.api#documentation": "Resource type event configuration for the connection status event
" + "smithy.api#documentation": "Resource type event configuration for the connection status event.
" } } } @@ -4076,6 +4102,174 @@ } } }, + "com.amazonaws.iotwireless#GetPosition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetPositionRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetPositionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the position information for a given resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/positions/{ResourceIdentifier}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetPositionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetPositionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetPositionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get position configuration for a given resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/position-configurations/{ResourceIdentifier}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetPositionConfigurationRequest": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.iotwireless#PositionResourceIdentifier", + "traits": { + "smithy.api#documentation": "Resource identifier used in a position configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.iotwireless#PositionResourceType", + "traits": { + "smithy.api#documentation": "Resource type of the resource for which position configuration is retrieved.
", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetPositionConfigurationResponse": { + "type": "structure", + "members": { + "Solvers": { + "target": "com.amazonaws.iotwireless#PositionSolverDetails", + "traits": { + "smithy.api#documentation": "The wrapper for the solver configuration details object.
" + } + }, + "Destination": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "The position data destination that describes the AWS IoT rule that processes the device's position data for use by\n AWS IoT Core for LoRaWAN.
" + } + } + } + }, + "com.amazonaws.iotwireless#GetPositionRequest": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.iotwireless#PositionResourceIdentifier", + "traits": { + "smithy.api#documentation": "Resource identifier used to retrieve the position information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.iotwireless#PositionResourceType", + "traits": { + "smithy.api#documentation": "Resource type of the resource for which position information is retrieved.
", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetPositionResponse": { + "type": "structure", + "members": { + "Position": { + "target": "com.amazonaws.iotwireless#PositionCoordinate", + "traits": { + "smithy.api#documentation": "The position information of the resource.
" + } + }, + "Accuracy": { + "target": "com.amazonaws.iotwireless#Accuracy", + "traits": { + "smithy.api#documentation": "The accuracy of the estimated position in meters. An empty value indicates that no position data is available. \n A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information\n that you specified instead of the position computed by solver.
" + } + }, + "SolverType": { + "target": "com.amazonaws.iotwireless#PositionSolverType", + "traits": { + "smithy.api#documentation": "The type of solver used to identify the position of the resource.
" + } + }, + "SolverProvider": { + "target": "com.amazonaws.iotwireless#PositionSolverProvider", + "traits": { + "smithy.api#documentation": "The vendor of the positioning solver.
" + } + }, + "SolverVersion": { + "target": "com.amazonaws.iotwireless#PositionSolverVersion", + "traits": { + "smithy.api#documentation": "The version of the positioning solver.
" + } + }, + "Timestamp": { + "target": "com.amazonaws.iotwireless#ISODateTimeString", + "traits": { + "smithy.api#documentation": "The timestamp at which the device's position was determined.
" + } + } + } + }, "com.amazonaws.iotwireless#GetResourceEventConfiguration": { "type": "operation", "input": { @@ -4132,7 +4326,7 @@ "PartnerType": { "target": "com.amazonaws.iotwireless#EventNotificationPartnerType", "traits": { - "smithy.api#documentation": "Partner type of the resource if the identifier type is PartnerAccountId.
", + "smithy.api#documentation": "Partner type of the resource if the identifier type is PartnerAccountId.
Event configuration for the device registration state event
" + "smithy.api#documentation": "Event configuration for the device registration state event.
" } }, "Proximity": { "target": "com.amazonaws.iotwireless#ProximityEventConfiguration", "traits": { - "smithy.api#documentation": "Event configuration for the Proximity event
" + "smithy.api#documentation": "Event configuration for the proximity event.
" } }, "Join": { @@ -5019,6 +5213,15 @@ } } }, + "com.amazonaws.iotwireless#HorizontalAccuracy": { + "type": "float", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.iotwireless#HrAllowed": { "type": "boolean" }, @@ -5728,6 +5931,84 @@ } } }, + "com.amazonaws.iotwireless#ListPositionConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListPositionConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListPositionConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List position configurations for a given resource, such as positioning solvers.
", + "smithy.api#http": { + "method": "GET", + "uri": "/position-configurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListPositionConfigurationsRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.iotwireless#PositionResourceType", + "traits": { + "smithy.api#documentation": "Resource type for which position configurations are listed.
", + "smithy.api#httpQuery": "resourceType" + } + }, + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "To retrieve the next set of results, the nextToken value from a previous response; otherwise null \n to receive the first set of results.
A list of position configurations.
" + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to get the next set of results, or null if there are no additional results.
" + } + } + } + }, "com.amazonaws.iotwireless#ListQueuedMessages": { "type": "operation", "input": { @@ -6212,7 +6493,7 @@ "GatewayEuiEventTopic": { "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", "traits": { - "smithy.api#documentation": "Enum to denote whether the gateway eui connection status event topic is enabled or disabled.
" + "smithy.api#documentation": "Enum to denote whether the gateway EUI connection status event topic is enabled or disabled.
" } } }, @@ -6707,7 +6988,7 @@ "DevEuiEventTopic": { "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", "traits": { - "smithy.api#documentation": "Enum to denote whether the dev eui join event topic is enabled or disabled.
" + "smithy.api#documentation": "Enum to denote whether the Dev EUI join event topic is enabled or disabled.
" } } }, @@ -6870,6 +7151,12 @@ "traits": { "smithy.api#documentation": "ABP device object for update APIs for v1.0.x
" } + }, + "FPorts": { + "target": "com.amazonaws.iotwireless#UpdateFPorts", + "traits": { + "smithy.api#documentation": "FPorts object for the positioning information of the device.
" + } } }, "traits": { @@ -7401,45 +7688,222 @@ } } }, - "com.amazonaws.iotwireless#PrAllowed": { - "type": "boolean" - }, - "com.amazonaws.iotwireless#PresetFreq": { - "type": "integer", + "com.amazonaws.iotwireless#PositionConfigurationFec": { + "type": "string", "traits": { - "smithy.api#range": { - "min": 1000000, - "max": 16700000 - } + "smithy.api#enum": [ + { + "value": "ROSE", + "name": "ROSE" + }, + { + "value": "NONE", + "name": "NONE" + } + ] } }, - "com.amazonaws.iotwireless#ProximityEventConfiguration": { + "com.amazonaws.iotwireless#PositionConfigurationItem": { "type": "structure", "members": { - "Sidewalk": { - "target": "com.amazonaws.iotwireless#SidewalkEventNotificationConfigurations", + "ResourceIdentifier": { + "target": "com.amazonaws.iotwireless#PositionResourceIdentifier", "traits": { - "smithy.api#documentation": "Proximity event configuration object for enabling or disabling Sidewalk related event topics.
" + "smithy.api#documentation": "Resource identifier for the position configuration.
" } }, - "WirelessDeviceIdEventTopic": { - "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "ResourceType": { + "target": "com.amazonaws.iotwireless#PositionResourceType", "traits": { - "smithy.api#documentation": "Enum to denote whether the wireless device id proximity event topic is enabled or disabled.
" + "smithy.api#documentation": "Resource type of the resource for the position configuration.
" } - } - }, - "traits": { - "smithy.api#documentation": "Proximity event configuration object for enabling and disabling relevant topics.
" - } - }, - "com.amazonaws.iotwireless#ProximityResourceTypeEventConfiguration": { - "type": "structure", - "members": { - "Sidewalk": { - "target": "com.amazonaws.iotwireless#SidewalkResourceTypeEventConfiguration", + }, + "Solvers": { + "target": "com.amazonaws.iotwireless#PositionSolverDetails", "traits": { - "smithy.api#documentation": "Proximity resource type event configuration object for enabling and disabling wireless device topic.
" + "smithy.api#documentation": "The details of the positioning solver object used to compute the location.
" + } + }, + "Destination": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "The position data destination that describes the AWS IoT rule that processes the device's position data for use by\n AWS IoT Core for LoRaWAN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The wrapper for a position configuration.
" + } + }, + "com.amazonaws.iotwireless#PositionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#PositionConfigurationItem" + } + }, + "com.amazonaws.iotwireless#PositionConfigurationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, + "com.amazonaws.iotwireless#PositionCoordinate": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#PositionCoordinateValue" + } + }, + "com.amazonaws.iotwireless#PositionCoordinateValue": { + "type": "float", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iotwireless#PositionResourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + }, + "com.amazonaws.iotwireless#PositionResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WirelessDevice", + "name": "WirelessDevice" + }, + { + "value": "WirelessGateway", + "name": "WirelessGateway" + } + ] + } + }, + "com.amazonaws.iotwireless#PositionSolverConfigurations": { + "type": "structure", + "members": { + "SemtechGnss": { + "target": "com.amazonaws.iotwireless#SemtechGnssConfiguration", + "traits": { + "smithy.api#documentation": "The Semtech GNSS solver configuration object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The wrapper for position solver configurations.
" + } + }, + "com.amazonaws.iotwireless#PositionSolverDetails": { + "type": "structure", + "members": { + "SemtechGnss": { + "target": "com.amazonaws.iotwireless#SemtechGnssDetail", + "traits": { + "smithy.api#documentation": "The Semtech GNSS solver object details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The wrapper for position solver details.
" + } + }, + "com.amazonaws.iotwireless#PositionSolverProvider": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Semtech", + "name": "SEMTECH" + } + ] + } + }, + "com.amazonaws.iotwireless#PositionSolverType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GNSS", + "name": "GNSS" + } + ] + } + }, + "com.amazonaws.iotwireless#PositionSolverVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.iotwireless#Positioning": { + "type": "structure", + "members": { + "ClockSync": { + "target": "com.amazonaws.iotwireless#FPort" + }, + "Stream": { + "target": "com.amazonaws.iotwireless#FPort" + }, + "Gnss": { + "target": "com.amazonaws.iotwireless#FPort" + } + }, + "traits": { + "smithy.api#documentation": "The FPorts for the position information.
" + } + }, + "com.amazonaws.iotwireless#PrAllowed": { + "type": "boolean" + }, + "com.amazonaws.iotwireless#PresetFreq": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1000000, + "max": 16700000 + } + } + }, + "com.amazonaws.iotwireless#ProximityEventConfiguration": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkEventNotificationConfigurations", + "traits": { + "smithy.api#documentation": "Proximity event configuration object for enabling or disabling Sidewalk related event topics.
" + } + }, + "WirelessDeviceIdEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "Enum to denote whether the wireless device id proximity event topic is enabled or disabled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Proximity event configuration object for enabling and disabling relevant topics.
" + } + }, + "com.amazonaws.iotwireless#ProximityResourceTypeEventConfiguration": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkResourceTypeEventConfiguration", + "traits": { + "smithy.api#documentation": "Proximity resource type event configuration object for enabling and disabling wireless device topic.
" } } }, @@ -7447,6 +7911,77 @@ "smithy.api#documentation": "Proximity resource type event configuration object for enabling or disabling topic.
" } }, + "com.amazonaws.iotwireless#PutPositionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#PutPositionConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#PutPositionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Put position configuration for a given resource.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/position-configurations/{ResourceIdentifier}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#PutPositionConfigurationRequest": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.iotwireless#PositionResourceIdentifier", + "traits": { + "smithy.api#documentation": "Resource identifier used to update the position configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.iotwireless#PositionResourceType", + "traits": { + "smithy.api#documentation": "Resource type of the resource for which you want to update the position configuration.
", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + }, + "Solvers": { + "target": "com.amazonaws.iotwireless#PositionSolverConfigurations", + "traits": { + "smithy.api#documentation": "The positioning solvers used to update the position configuration of the resource.
" + } + }, + "Destination": { + "target": "com.amazonaws.iotwireless#DestinationName", + "traits": { + "smithy.api#documentation": "The position data destination that describes the AWS IoT rule that processes the device's position data for use by\n AWS IoT Core for LoRaWAN.
" + } + } + } + }, + "com.amazonaws.iotwireless#PutPositionConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#PutResourceLogLevel": { "type": "operation", "input": { @@ -7754,6 +8289,60 @@ "smithy.api#pattern": "^[a-fA-F0-9]{32}$" } }, + "com.amazonaws.iotwireless#SemtechGnssConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.iotwireless#PositionConfigurationStatus", + "traits": { + "smithy.api#documentation": "The status indicating whether the solver is enabled.
", + "smithy.api#required": {} + } + }, + "Fec": { + "target": "com.amazonaws.iotwireless#PositionConfigurationFec", + "traits": { + "smithy.api#documentation": "Whether forward error correction is enabled.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Semtech GNSS solver configuration.
" + } + }, + "com.amazonaws.iotwireless#SemtechGnssDetail": { + "type": "structure", + "members": { + "Provider": { + "target": "com.amazonaws.iotwireless#PositionSolverProvider", + "traits": { + "smithy.api#documentation": "The vendor of the solver object.
" + } + }, + "Type": { + "target": "com.amazonaws.iotwireless#PositionSolverType", + "traits": { + "smithy.api#documentation": "The type of positioning solver used.
" + } + }, + "Status": { + "target": "com.amazonaws.iotwireless#PositionConfigurationStatus", + "traits": { + "smithy.api#documentation": "The status indicating whether the solver is enabled.
" + } + }, + "Fec": { + "target": "com.amazonaws.iotwireless#PositionConfigurationFec", + "traits": { + "smithy.api#documentation": "Whether forward error correction is enabled.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the Semtech GNSS solver object.
" + } + }, "com.amazonaws.iotwireless#SendDataToMulticastGroup": { "type": "operation", "input": { @@ -8154,7 +8743,7 @@ } }, "traits": { - "smithy.api#documentation": "SidewalkEventNotificationConfigurations object\n Event configuration object for Sidewalk related event topics.
" + "smithy.api#documentation": "\n SidewalkEventNotificationConfigurations object, which is the event configuration\n object for Sidewalk-related event topics.
Update the event configuration by resource types.
", + "smithy.api#documentation": "Update the event configuration based on resource types.
", "smithy.api#http": { "method": "PATCH", "uri": "/event-configurations-resource-types", @@ -9090,6 +9679,20 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#UpdateFPorts": { + "type": "structure", + "members": { + "Positioning": { + "target": "com.amazonaws.iotwireless#Positioning", + "traits": { + "smithy.api#documentation": "Positioning FPorts for the ClockSync, Stream, and GNSS functions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Object for updating the FPorts information.
" + } + }, "com.amazonaws.iotwireless#UpdateFuotaTask": { "type": "operation", "input": { @@ -9418,6 +10021,72 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#UpdatePosition": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdatePositionRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdatePositionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Update the position information of a resource.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/positions/{ResourceIdentifier}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdatePositionRequest": { + "type": "structure", + "members": { + "ResourceIdentifier": { + "target": "com.amazonaws.iotwireless#PositionResourceIdentifier", + "traits": { + "smithy.api#documentation": "Resource identifier of the resource for which position is updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.iotwireless#PositionResourceType", + "traits": { + "smithy.api#documentation": "Resource type of the resource for which position is updated.
", + "smithy.api#httpQuery": "resourceType", + "smithy.api#required": {} + } + }, + "Position": { + "target": "com.amazonaws.iotwireless#PositionCoordinate", + "traits": { + "smithy.api#documentation": "The position information of the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#UpdatePositionResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#UpdateResourceEventConfiguration": { "type": "operation", "input": { @@ -9477,32 +10146,32 @@ "PartnerType": { "target": "com.amazonaws.iotwireless#EventNotificationPartnerType", "traits": { - "smithy.api#documentation": "Partner type of the resource if the identifier type is PartnerAccountId
", + "smithy.api#documentation": "Partner type of the resource if the identifier type is PartnerAccountId\n
Event configuration for the device registration state event
" + "smithy.api#documentation": "Event configuration for the device registration state event.
" } }, "Proximity": { "target": "com.amazonaws.iotwireless#ProximityEventConfiguration", "traits": { - "smithy.api#documentation": "Event configuration for the Proximity event
" + "smithy.api#documentation": "Event configuration for the proximity event.
" } }, "Join": { "target": "com.amazonaws.iotwireless#JoinEventConfiguration", "traits": { - "smithy.api#documentation": "Event configuration for the join event
" + "smithy.api#documentation": "Event configuration for the join event.
" } }, "ConnectionStatus": { "target": "com.amazonaws.iotwireless#ConnectionStatusEventConfiguration", "traits": { - "smithy.api#documentation": "Event configuration for the connection status event
" + "smithy.api#documentation": "Event configuration for the connection status event.
" } } } @@ -9729,6 +10398,15 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.iotwireless#VerticalAccuracy": { + "type": "float", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.iotwireless#WirelessDeviceArn": { "type": "string" }, @@ -9792,7 +10470,7 @@ "com.amazonaws.iotwireless#WirelessDeviceFrameInfo": { "type": "string", "traits": { - "smithy.api#documentation": "FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug\n the communication between your LoRaWAN end devices and the network server.
", + "smithy.api#documentation": "\n FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug\n the communication between your LoRaWAN end devices and the network server.
When the CA certificate is valid.
" } + }, + "certificateMode": { + "target": "com.amazonaws.iot#CertificateMode", + "traits": { + "smithy.api#documentation": "The mode of the CA.
\nAll the device certificates that are registered using this CA will be registered \n in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.
" + } } }, "traits": { @@ -4093,7 +4099,7 @@ "certificateMode": { "target": "com.amazonaws.iot#CertificateMode", "traits": { - "smithy.api#documentation": "The mode of the certificate.
" + "smithy.api#documentation": "The mode of the certificate.
\n\n DEFAULT: A certificate in DEFAULT mode is either generated by\n Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with\n certificates in DEFAULT mode aren't required to send the Server Name\n Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as\n custom domains and VPC endpoints, we recommend that you use the SNI extension when\n connecting to Amazon Web Services IoT Core.
\n SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates \n in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.
The mode of the certificate.
" + "smithy.api#documentation": "The mode of the certificate.
\n\n DEFAULT: A certificate in DEFAULT mode is either generated by\n Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with\n certificates in DEFAULT mode aren't required to send the Server Name\n Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as\n custom domains and VPC endpoints, we recommend that you use the SNI extension when\n connecting to Amazon Web Services IoT Core.
\n SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates \n in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.
For more information about the value for SNI extension, see Transport security in IoT.
" } } }, @@ -15982,7 +15988,10 @@ } }, "isConcurrent": { - "target": "com.amazonaws.iot#BooleanWrapperObject" + "target": "com.amazonaws.iot#BooleanWrapperObject", + "traits": { + "smithy.api#documentation": "Indicates whether a job is concurrent. Will be true when a job is \n rolling out new job executions or canceling previously created executions,\n otherwise false.
" + } } }, "traits": { @@ -16448,7 +16457,10 @@ } }, "isConcurrent": { - "target": "com.amazonaws.iot#BooleanWrapperObject" + "target": "com.amazonaws.iot#BooleanWrapperObject", + "traits": { + "smithy.api#documentation": "Indicates whether a job is concurrent. Will be true when a job is \n rolling out new job executions or canceling previously created executions,\n otherwise false.
" + } } }, "traits": { @@ -23120,7 +23132,7 @@ "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job\n data/updates are stored. The role must also grant permission for IoT to download the files.
" + "smithy.api#documentation": "The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job\n data/updates are stored. The role must also grant permission for IoT to download the files.
\nFor information about addressing the confused deputy problem, see cross-service\n confused deputy prevention in the Amazon Web Services IoT Core developer guide.
\nRegisters a CA certificate with IoT. This CA certificate can then be used to sign\n device certificates, which can be then registered with IoT. You can register up to 10\n CA certificates per Amazon Web Services account that have the same subject field. This enables you to have\n up to 10 certificate authorities sign your device certificates. If you have more than one\n CA certificate registered, make sure you pass the CA certificate when you register your\n device certificates with the RegisterCertificate action.
\nRequires permission to access the RegisterCACertificate action.
", + "smithy.api#documentation": "Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA\n certificates you can register in your Amazon Web Services account. You can register up to 10 CA\n certificates with the same CA subject field per Amazon Web Services account.
Requires permission to access the RegisterCACertificate action.
", "smithy.api#http": { "method": "POST", "uri": "/cacertificate", @@ -23627,8 +23639,7 @@ "verificationCertificate": { "target": "com.amazonaws.iot#CertificatePem", "traits": { - "smithy.api#documentation": "The private key verification certificate.
", - "smithy.api#required": {} + "smithy.api#documentation": "The private key verification certificate. If certificateMode is\n SNI_ONLY, the verificationCertificate field must be empty. If\n certificateMode is DEFAULT or not provided, the\n verificationCertificate field must not be empty.
Metadata which can be used to manage the CA certificate.
\nFor URI Request parameters use format: ...key1=value1&key2=value2...
\nFor the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"
\nFor the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"
\nDescribes the certificate mode in which the Certificate Authority (CA) will be\n registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY.\n If the verificationCertificate field is provided, set certificateMode to be DEFAULT.\n When certificateMode is not provided, it defaults to DEFAULT.\n All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA.\n For more information about certificate mode for device certificates, see \n \n certificate mode.\n
Registers a device certificate with IoT. If you have more than one CA certificate\n that has the same subject field, you must specify the CA certificate that was used to sign\n the device certificate being registered.
\nRequires permission to access the RegisterCertificate action.
", + "smithy.api#documentation": "Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must\n specify the CA certificate that was used to sign the device certificate being\n registered.
\nRequires permission to access the RegisterCertificate action.
", "smithy.api#http": { "method": "POST", "uri": "/certificate/register", @@ -25012,7 +25029,7 @@ "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { - "smithy.api#documentation": "The search query string.
", + "smithy.api#documentation": "The search query string. For more information about the search query syntax, see Query\n syntax.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/kendra.json b/codegen/sdk/aws-models/kendra.json index e53712a0e27..03288c8b7fc 100644 --- a/codegen/sdk/aws-models/kendra.json +++ b/codegen/sdk/aws-models/kendra.json @@ -66,6 +66,9 @@ { "target": "com.amazonaws.kendra#ClearQuerySuggestions" }, + { + "target": "com.amazonaws.kendra#CreateAccessControlConfiguration" + }, { "target": "com.amazonaws.kendra#CreateDataSource" }, @@ -84,6 +87,9 @@ { "target": "com.amazonaws.kendra#CreateThesaurus" }, + { + "target": "com.amazonaws.kendra#DeleteAccessControlConfiguration" + }, { "target": "com.amazonaws.kendra#DeleteDataSource" }, @@ -105,6 +111,9 @@ { "target": "com.amazonaws.kendra#DeleteThesaurus" }, + { + "target": "com.amazonaws.kendra#DescribeAccessControlConfiguration" + }, { "target": "com.amazonaws.kendra#DescribeDataSource" }, @@ -141,6 +150,9 @@ { "target": "com.amazonaws.kendra#GetSnapshots" }, + { + "target": "com.amazonaws.kendra#ListAccessControlConfigurations" + }, { "target": "com.amazonaws.kendra#ListDataSources" }, @@ -195,6 +207,9 @@ { "target": "com.amazonaws.kendra#UntagResource" }, + { + "target": "com.amazonaws.kendra#UpdateAccessControlConfiguration" + }, { "target": "com.amazonaws.kendra#UpdateDataSource" }, @@ -215,6 +230,47 @@ } ] }, + "com.amazonaws.kendra#AccessControlConfigurationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.kendra#AccessControlConfigurationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.kendra#AccessControlConfigurationSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.kendra#AccessControlConfigurationId", + "traits": { + "smithy.api#documentation": "The identifier of the access control configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information on an access control configuration that you created for \n your documents in an index.
" + } + }, + "com.amazonaws.kendra#AccessControlConfigurationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.kendra#AccessControlConfigurationSummary" + } + }, "com.amazonaws.kendra#AccessControlListConfiguration": { "type": "structure", "members": { @@ -357,7 +413,7 @@ "CrawlComments": { "target": "com.amazonaws.kendra#Boolean", "traits": { - "smithy.api#documentation": "\n TRUE to index comments of wikis and blogs.
\n TRUE to index comments of blogs and other content.
Provides the configuration information to connect to Alfresco as your \n data source.
" + "smithy.api#documentation": "Provides the configuration information to connect to Alfresco as your \n data source.
\nAlfresco data source connector is currently in preview mode. Basic \n authentication is currently supported. If you would like to use Alfresco \n connector in production, contact Support.
\nThe Amazon Resource Name (ARN) of an Secrets Manager secret\n that contains the user name and password required to connect to the\n Confluence instance. If you use Confluence cloud, you use a \n generated API token as the password. For more information, see \n Using a \n Confluemce data source.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Secrets Manager secret\n that contains the user name and password required to connect to the\n Confluence instance. If you use Confluence cloud, you use a \n generated API token as the password. For more information, see \n Using a \n Confluence data source.
", "smithy.api#required": {} } }, "Version": { "target": "com.amazonaws.kendra#ConfluenceVersion", "traits": { - "smithy.api#documentation": "The version or the type of the Confluence installation to connect to.
", + "smithy.api#documentation": "The version or the type of Confluence installation to connect to.
", "smithy.api#required": {} } }, @@ -2027,6 +2083,97 @@ } } }, + "com.amazonaws.kendra#CreateAccessControlConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#CreateAccessControlConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.kendra#CreateAccessControlConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#ConflictException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an access configuration for your documents. This includes \n user and group access information for your documents. This is useful \n for user context filtering, where search results are filtered based \n on the user or their group access to documents.
\nYou can use this to re-configure your existing document level access \n control without indexing all of your documents again. For example, your \n index contains top-secret company documents that only certain employees \n or users should access. One of these users leaves the company or switches \n to a team that should be blocked from access to top-secret documents. \n Your documents in your index still give this user access to top-secret \n documents due to the user having access at the time your documents were \n indexed. You can create a specific access control configuration for this \n user with deny access. You can later update the access control \n configuration to allow access in the case the user returns to the company \n and re-joins the 'top-secret' team. You can re-configure access control \n for your documents circumstances change.
\nTo apply your access control configuration to certain documents, you call \n the BatchPutDocument \n API with the AccessControlConfigurationId included in the \n Document \n object. If you use an S3 bucket as a data source, you update the \n .metadata.json with the AccessControlConfigurationId \n and synchronize your data source. Amazon Kendra currently only supports \n access control configuration for S3 data sources and documents indexed using the \n BatchPutDocument API.
The identifier of the index to create an access control configuration for \n your documents.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.kendra#AccessControlConfigurationName", + "traits": { + "smithy.api#documentation": "A name for the access control configuration.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.kendra#Description", + "traits": { + "smithy.api#documentation": "A description for the access control configuration.
" + } + }, + "AccessControlList": { + "target": "com.amazonaws.kendra#PrincipalList", + "traits": { + "smithy.api#documentation": "Information on principals (users and/or groups) and which documents they \n should have access to. This is useful for user context filtering, where \n search results are filtered based on the user or their group access to \n documents.
" + } + }, + "HierarchicalAccessControlList": { + "target": "com.amazonaws.kendra#HierarchicalPrincipalList", + "traits": { + "smithy.api#documentation": "The list of principal lists that \n define the hierarchy for which documents users should have access to.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.kendra#ClientTokenName", + "traits": { + "smithy.api#documentation": "A token that you provide to identify the request to create an access control \n configuration. Multiple calls to the CreateAccessControlConfiguration \n API with the same client token will create only one access control configuration.
The identifier of the access control configuration for your documents in an index.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.kendra#CreateDataSource": { "type": "operation", "input": { @@ -2071,71 +2218,71 @@ "Name": { "target": "com.amazonaws.kendra#DataSourceName", "traits": { - "smithy.api#documentation": "A unique name for the data source. A data source name can't be changed\n without deleting and recreating the data source.
", + "smithy.api#documentation": "A unique name for the data source connector. A data source name can't be changed\n without deleting and recreating the data source connector.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that should be associated with this data\n source.
", + "smithy.api#documentation": "The identifier of the index you want to use with the data source connector.
", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.kendra#DataSourceType", "traits": { - "smithy.api#documentation": "The type of repository that contains the data source.
", + "smithy.api#documentation": "The type of data source repository. For example, SHAREPOINT.
Configuration information that is required to access the data source \n repository.
\nYou can't specify the Configuration parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The Configuration parameter is required for all other\n data sources.
Configuration information to connect to your data source repository.
\nYou can't specify the Configuration parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The Configuration parameter is required for all other\n data sources.
A description for the data source.
" + "smithy.api#documentation": "A description for the data source connector.
" } }, "Schedule": { "target": "com.amazonaws.kendra#ScanSchedule", "traits": { - "smithy.api#documentation": "Sets the frequency for Amazon Kendra to check the documents in your\n repository and update the index. If you don't set a schedule Amazon Kendra\n will not periodically update the index. You can call the\n StartDataSourceSyncJob API to update the\n index.
You can't specify the Schedule parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
Sets the frequency for Amazon Kendra to check the documents in your\n data source repository and update the index. If you don't set a schedule \n Amazon Kendra will not periodically update the index. You can call the\n StartDataSourceSyncJob API to update the\n index.
You can't specify the Schedule parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The Amazon Resource Name (ARN) of a role with permission to access the\n data source. For more information, see IAM Roles for\n Amazon Kendra.
\nYou can't specify the RoleArn parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The RoleArn parameter is required for all other data\n sources.
The Amazon Resource Name (ARN) of a role with permission to access the\n data source connector. For more information, see IAM Roles for\n Amazon Kendra.
\nYou can't specify the RoleArn parameter when the\n Type parameter is set to CUSTOM. If you do,\n you receive a ValidationException exception.
The RoleArn parameter is required for all other data\n sources.
A list of key-value pairs that identify the data source. You can use\n the tags to identify and organize your resources and to control access to\n resources.
" + "smithy.api#documentation": "A list of key-value pairs that identify the data source connector. You can use\n the tags to identify and organize your resources and to control access to\n resources.
" } }, "ClientToken": { "target": "com.amazonaws.kendra#ClientTokenName", "traits": { - "smithy.api#documentation": "A token that you provide to identify the request to create a data\n source. Multiple calls to the CreateDataSource API with\n the same client token will create only one data source.
A token that you provide to identify the request to create a data\n source connector. Multiple calls to the CreateDataSource API \n with the same client token will create only one data source connector.
The code for a language. This allows you to support a language for all \n documents when creating the data source. English is supported \n by default. For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" + "smithy.api#documentation": "The code for a language. This allows you to support a language for all \n documents when creating the data source connector. English is supported \n by default. For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" } }, "CustomDocumentEnrichmentConfiguration": { "target": "com.amazonaws.kendra#CustomDocumentEnrichmentConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for altering document metadata and content during the\n document ingestion process when you create a data source.
\nFor more information on how to create, modify and delete document metadata, or make\n other content alterations when you ingest documents into Amazon Kendra, see \n Customizing \n document metadata during the ingestion process.
" + "smithy.api#documentation": "Configuration information for altering document metadata and content during the\n document ingestion process.
\nFor more information on how to create, modify and delete document metadata, or make\n other content alterations when you ingest documents into Amazon Kendra, see \n Customizing \n document metadata during the ingestion process.
" } } } @@ -2146,7 +2293,7 @@ "Id": { "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "A unique identifier for the data source.
", + "smithy.api#documentation": "The identifier of the data source connector.
", "smithy.api#required": {} } } @@ -2275,7 +2422,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an new set of frequently asked question (FAQ) questions and answers.
\nAdding FAQs to an index is an asynchronous operation.
\nFor an example of adding an FAQ to an index using Python and Java SDKs, \n see Using you \n FAQ file.
" + "smithy.api#documentation": "Creates an new set of frequently asked question (FAQ) questions and answers.
\nAdding FAQs to an index is an asynchronous operation.
\nFor an example of adding an FAQ to an index using Python and Java SDKs, \n see Using your \n FAQ file.
" } }, "com.amazonaws.kendra#CreateFaqRequest": { @@ -2284,27 +2431,27 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the FAQ.
", + "smithy.api#documentation": "The identifier of the index for the FAQ.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.kendra#FaqName", "traits": { - "smithy.api#documentation": "The name that should be associated with the FAQ.
", + "smithy.api#documentation": "A name for the FAQ.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "A description of the FAQ.
" + "smithy.api#documentation": "A description for the FAQ.
" } }, "S3Path": { "target": "com.amazonaws.kendra#S3Path", "traits": { - "smithy.api#documentation": "The S3 location of the FAQ input data.
", + "smithy.api#documentation": "The path to the FAQ file in S3.
", "smithy.api#required": {} } }, @@ -2324,7 +2471,7 @@ "FileFormat": { "target": "com.amazonaws.kendra#FaqFileFormat", "traits": { - "smithy.api#documentation": "The format of the input file. You can choose between a basic CSV format, a CSV format\n that includes customs attributes in a header, and a JSON format that includes custom\n attributes.
\nThe format must match the format of the file stored in the S3 bucket identified in the\n S3Path parameter.
For more information, see Adding questions and\n answers.
" + "smithy.api#documentation": "The format of the FAQ input file. You can choose between a basic CSV format, a CSV format\n that includes customs attributes in a header, and a JSON format that includes custom\n attributes.
\nThe format must match the format of the file stored in the S3 bucket identified in the\n S3Path parameter.
For more information, see Adding questions and\n answers.
" } }, "ClientToken": { @@ -2385,7 +2532,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new Amazon Kendra index. Index creation is an asynchronous\n API. To determine if index creation has completed, check the\n Status field returned from a call to\n DescribeIndex. The Status field is set to\n ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the\n BatchPutDocument API or using one of the supported\n data sources.
For an example of creating an index and data source using the Python SDK, \n see Getting \n started with Python SDK. For an example of creating an index and data \n source using the Java SDK, see Getting started with Java SDK.
" + "smithy.api#documentation": "Creates an Amazon Kendra index. Index creation is an asynchronous\n API. To determine if index creation has completed, check the\n Status field returned from a call to\n DescribeIndex. The Status field is set to\n ACTIVE when the index is ready to use.
Once the index is active you can index your documents using the\n BatchPutDocument API or using one of the supported\n data sources.
For an example of creating an index and data source using the Python SDK, \n see Getting \n started with Python SDK. For an example of creating an index and data \n source using the Java SDK, see Getting started with Java SDK.
" } }, "com.amazonaws.kendra#CreateIndexRequest": { @@ -2394,7 +2541,7 @@ "Name": { "target": "com.amazonaws.kendra#IndexName", "traits": { - "smithy.api#documentation": "The name for the new index.
", + "smithy.api#documentation": "A name for the index.
", "smithy.api#required": {} } }, @@ -2606,21 +2753,21 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The unique identifier of the index for the new thesaurus.\n
", + "smithy.api#documentation": "The identifier of the index for the thesaurus.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.kendra#ThesaurusName", "traits": { - "smithy.api#documentation": "The name for the new thesaurus.
", + "smithy.api#documentation": "A name for the thesaurus.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "The description for the new thesaurus.
" + "smithy.api#documentation": "A description for the thesaurus.
" } }, "RoleArn": { @@ -2639,7 +2786,7 @@ "SourceS3Path": { "target": "com.amazonaws.kendra#S3Path", "traits": { - "smithy.api#documentation": "The thesaurus file Amazon S3 source path.\n
", + "smithy.api#documentation": "The path to the thesaurus file in S3.
", "smithy.api#required": {} } }, @@ -3395,6 +3542,61 @@ } } }, + "com.amazonaws.kendra#DeleteAccessControlConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#DeleteAccessControlConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.kendra#DeleteAccessControlConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#ConflictException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an access control configuration that you created for your \n documents in an index. This includes user and group access information \n for your documents. This is useful for user context filtering, where search \n results are filtered based on the user or their group access to documents.
" + } + }, + "com.amazonaws.kendra#DeleteAccessControlConfigurationRequest": { + "type": "structure", + "members": { + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for an access control configuration.
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.kendra#AccessControlConfigurationId", + "traits": { + "smithy.api#documentation": "The identifier of the access control configuration you want to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kendra#DeleteAccessControlConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.kendra#DeleteDataSource": { "type": "operation", "input": { @@ -3433,14 +3635,14 @@ "Id": { "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "The unique identifier of the data source to delete.
", + "smithy.api#documentation": "The identifier of the data source you want to delete.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The unique identifier of the index associated with the data\n source.
", + "smithy.api#documentation": "The identifier of the index used with the data source.
", "smithy.api#required": {} } } @@ -3491,7 +3693,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience you want to delete.
", + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", "smithy.api#required": {} } } @@ -3539,14 +3741,14 @@ "Id": { "target": "com.amazonaws.kendra#FaqId", "traits": { - "smithy.api#documentation": "The identifier of the FAQ to remove.
", + "smithy.api#documentation": "The identifier of the FAQ you want to remove.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The index to remove the FAQ from.
", + "smithy.api#documentation": "The identifier of the index for the FAQ.
", "smithy.api#required": {} } } @@ -3590,7 +3792,7 @@ "Id": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index to delete.
", + "smithy.api#documentation": "The identifier of the index you want to delete.
", "smithy.api#required": {} } } @@ -3641,7 +3843,7 @@ "DataSourceId": { "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "The identifier of the data source you want to delete a group from.
\nThis is useful if a group is tied to multiple data sources and you want \n to delete a group from accessing documents in a certain data source. For example, \n the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to \n the company's documents stored in the data sources Confluence and Salesforce. \n You want to delete \"Research\" and \"Engineering\" groups from Salesforce, so that\n these groups cannot access customer-related documents stored in Salesforce. \n Only \"Sales and Marketing\" should access documents in the Salesforce data source.
" + "smithy.api#documentation": "The identifier of the data source you want to delete a group from.
\nA group can be tied to multiple data sources. You can \n delete a group from accessing documents in a certain data source. For example, \n the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to \n the company's documents stored in the data sources Confluence and Salesforce. \n You want to delete \"Research\" and \"Engineering\" groups from Salesforce, so that\n these groups cannot access customer-related documents stored in Salesforce. \n Only \"Sales and Marketing\" should access documents in the Salesforce data source.
" } }, "GroupId": { @@ -3697,14 +3899,14 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the you want to delete a block list from.
", + "smithy.api#documentation": "The identifier of the index for the block list.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.kendra#QuerySuggestionsBlockListId", "traits": { - "smithy.api#documentation": "The unique identifier of the block list that needs to be deleted.
", + "smithy.api#documentation": "The identifier of the block list you want to delete.
", "smithy.api#required": {} } } @@ -3748,19 +3950,103 @@ "Id": { "target": "com.amazonaws.kendra#ThesaurusId", "traits": { - "smithy.api#documentation": "The identifier of the thesaurus to delete.
", + "smithy.api#documentation": "The identifier of the thesaurus you want to delete.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index associated with the thesaurus to delete.
", + "smithy.api#documentation": "The identifier of the index for the thesaurus.
", "smithy.api#required": {} } } } }, + "com.amazonaws.kendra#DescribeAccessControlConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#DescribeAccessControlConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.kendra#DescribeAccessControlConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about an access control configuration that you created for your \n documents in an index. This includes user and group access information for your \n documents. This is useful for user context filtering, where search results are \n filtered based on the user or their group access to documents.
" + } + }, + "com.amazonaws.kendra#DescribeAccessControlConfigurationRequest": { + "type": "structure", + "members": { + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for an access control configuration.
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.kendra#AccessControlConfigurationId", + "traits": { + "smithy.api#documentation": "The identifier of the access control configuration you want to get information on.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.kendra#DescribeAccessControlConfigurationResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.kendra#AccessControlConfigurationName", + "traits": { + "smithy.api#documentation": "The name for the access control configuration.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.kendra#Description", + "traits": { + "smithy.api#documentation": "The description for the access control configuration.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.kendra#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message containing details if there are issues processing the access \n control configuration.
" + } + }, + "AccessControlList": { + "target": "com.amazonaws.kendra#PrincipalList", + "traits": { + "smithy.api#documentation": "Information on principals (users and/or groups) and which documents they \n should have access to. This is useful for user context filtering, where search \n results are filtered based on the user or their group access to documents.
" + } + }, + "HierarchicalAccessControlList": { + "target": "com.amazonaws.kendra#HierarchicalPrincipalList", + "traits": { + "smithy.api#documentation": "The list of principal lists that \n define the hierarchy for which documents users should have access to.
" + } + } + } + }, "com.amazonaws.kendra#DescribeDataSource": { "type": "operation", "input": { @@ -3796,14 +4082,14 @@ "Id": { "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "The unique identifier of the data source to describe.
", + "smithy.api#documentation": "The identifier of the data source.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the data source.
", + "smithy.api#documentation": "The identifier of the index used with the data source.
", "smithy.api#required": {} } } @@ -3839,7 +4125,7 @@ "Configuration": { "target": "com.amazonaws.kendra#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "Describes how the data source is configured. The specific information in the description\n depends on the data source provider.
" + "smithy.api#documentation": "Configuration details for the data source. This shows how the \n data source is configured. The configuration options for a data \n source depend on the data source provider.
" } }, "CreatedAt": { @@ -3857,7 +4143,7 @@ "Description": { "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "The description of the data source.
" + "smithy.api#documentation": "The description for the data source.
" } }, "Status": { @@ -3940,7 +4226,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience you want to get \n information on.
", + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", "smithy.api#required": {} } } @@ -4052,14 +4338,14 @@ "Id": { "target": "com.amazonaws.kendra#FaqId", "traits": { - "smithy.api#documentation": "The unique identifier of the FAQ.
", + "smithy.api#documentation": "The identifier of the FAQ you want to get information on.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the FAQ.
", + "smithy.api#documentation": "The identifier of the index for the FAQ.
", "smithy.api#required": {} } } @@ -4077,7 +4363,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the FAQ.
" + "smithy.api#documentation": "The identifier of the index for the FAQ.
" } }, "Name": { @@ -4165,7 +4451,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an existing Amazon Kendra index.
" + "smithy.api#documentation": "Gets information about an existing Amazon Kendra index.
" } }, "com.amazonaws.kendra#DescribeIndexRequest": { @@ -4174,7 +4460,7 @@ "Id": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index to describe.
", + "smithy.api#documentation": "The identifier of the index you want to get information on.
", "smithy.api#required": {} } } @@ -4240,7 +4526,7 @@ "DocumentMetadataConfigurations": { "target": "com.amazonaws.kendra#DocumentMetadataConfigurationList", "traits": { - "smithy.api#documentation": "Configuration settings for any metadata applied to the documents in\n the index.
" + "smithy.api#documentation": "Configuration information for document metadata or fields. Document metadata \n are fields or attributes associated with your documents. For example, the company \n department name associated with each document.
" } }, "IndexStatistics": { @@ -4276,7 +4562,7 @@ "UserGroupResolutionConfiguration": { "target": "com.amazonaws.kendra#UserGroupResolutionConfiguration", "traits": { - "smithy.api#documentation": "Shows whether you have enabled the configuration for fetching access \n levels of groups and users from an Amazon Web Services Single Sign On identity source.
" + "smithy.api#documentation": "Whether you have enabled the configuration for fetching access \n levels of groups and users from an Amazon Web Services Single Sign On identity source.
" } } } @@ -4390,7 +4676,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes a block list used for query suggestions for an index.
\nThis is used to check the current settings that are applied to a \n block list.
\n\n DescribeQuerySuggestionsBlockList is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Gets information about a block list used for query suggestions for \n an index.
\nThis is used to check the current settings that are applied to a \n block list.
\n\n DescribeQuerySuggestionsBlockList is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
The unique identifier of the block list.
", + "smithy.api#documentation": "The identifier of the block list you want to get information on.
", "smithy.api#required": {} } } @@ -4418,49 +4704,49 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "Shows the identifier of the index for the block list.
" + "smithy.api#documentation": "The identifier of the index for the block list.
" } }, "Id": { "target": "com.amazonaws.kendra#QuerySuggestionsBlockListId", "traits": { - "smithy.api#documentation": "Shows the unique identifier of the block list.
" + "smithy.api#documentation": "The identifier of the block list.
" } }, "Name": { "target": "com.amazonaws.kendra#QuerySuggestionsBlockListName", "traits": { - "smithy.api#documentation": "Shows the name of the block list.
" + "smithy.api#documentation": "The name of the block list.
" } }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "Shows the description for the block list.
" + "smithy.api#documentation": "The description for the block list.
" } }, "Status": { "target": "com.amazonaws.kendra#QuerySuggestionsBlockListStatus", "traits": { - "smithy.api#documentation": "Shows whether the current status of the block list is \n ACTIVE or INACTIVE.
The current status of the block list. When the value is \n ACTIVE, the block list is ready for use.
Shows the error message with details when there are issues in \n processing the block list.
" + "smithy.api#documentation": "The error message containing details if there are issues processing \n the block list.
" } }, "CreatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "Shows the date-time a block list for query suggestions was created.
" + "smithy.api#documentation": "The date-time a block list for query suggestions was created.
" } }, "UpdatedAt": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "Shows the date-time a block list for query suggestions was last updated.
" + "smithy.api#documentation": "The date-time a block list for query suggestions was last updated.
" } }, "SourceS3Path": { @@ -4472,19 +4758,19 @@ "ItemCount": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "Shows the current number of valid, non-empty words or phrases in \n the block list text file.
" + "smithy.api#documentation": "The current number of valid, non-empty words or phrases in \n the block list text file.
" } }, "FileSizeBytes": { "target": "com.amazonaws.kendra#Long", "traits": { - "smithy.api#documentation": "Shows the current size of the block list text file in S3.
" + "smithy.api#documentation": "The current size of the block list text file in S3.
" } }, "RoleArn": { "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "Shows the current IAM (Identity and Access Management) role used by \n Amazon Kendra to access the block list text file in S3.
\nThe role needs S3 read permissions to your file in S3 and needs to \n give STS (Security Token Service) assume role permissions to \n Amazon Kendra.
" + "smithy.api#documentation": "The IAM (Identity and Access Management) role used by \n Amazon Kendra to access the block list text file in S3.
\nThe role needs S3 read permissions to your file in S3 and needs to \n give STS (Security Token Service) assume role permissions to \n Amazon Kendra.
" } } } @@ -4515,7 +4801,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the settings of query suggestions for an index.
\nThis is used to check the current settings applied \n to query suggestions.
\n\n DescribeQuerySuggestionsConfig is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Gets information on the settings of query suggestions for an index.
\nThis is used to check the current settings applied \n to query suggestions.
\n\n DescribeQuerySuggestionsConfig is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
The identifier of the index you want to describe query suggestions \n settings for.
", + "smithy.api#documentation": "The identifier of the index with query suggestions that you want to get \n information on.
", "smithy.api#required": {} } } @@ -4536,55 +4822,55 @@ "Mode": { "target": "com.amazonaws.kendra#Mode", "traits": { - "smithy.api#documentation": "Shows whether query suggestions are currently in \n ENABLED mode or LEARN_ONLY mode.
By default, Amazon Kendra enables query suggestions.LEARN_ONLY \n turns off query suggestions for your users. You can change the mode using \n the UpdateQuerySuggestionsConfig \n API.
Whether query suggestions are currently in \n ENABLED mode or LEARN_ONLY mode.
By default, Amazon Kendra enables query suggestions.LEARN_ONLY \n turns off query suggestions for your users. You can change the mode using \n the UpdateQuerySuggestionsConfig \n API.
Shows whether the status of query suggestions settings is currently \n Active or Updating.
\nActive means the current settings apply and Updating means your \n changed settings are in the process of applying.
" + "smithy.api#documentation": "Whether the status of query suggestions settings is currently \n ACTIVE or UPDATING.
Active means the current settings apply and Updating means your \n changed settings are in the process of applying.
" } }, "QueryLogLookBackWindowInDays": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "Shows how recent your queries are in your query log time \n window (in days).
" + "smithy.api#documentation": "How recent your queries are in your query log time \n window (in days).
" } }, "IncludeQueriesWithoutUserInformation": { "target": "com.amazonaws.kendra#ObjectBoolean", "traits": { - "smithy.api#documentation": "Shows whether Amazon Kendra uses all queries or only uses queries that \n include user information to generate query suggestions.
" + "smithy.api#documentation": "\n TRUE to use all queries, otherwise use only queries that include \n user information to generate the query suggestions.
Shows the minimum number of unique users who must search a query in \n order for the query to be eligible to suggest to your users.
" + "smithy.api#documentation": "The minimum number of unique users who must search a query in \n order for the query to be eligible to suggest to your users.
" } }, "MinimumQueryCount": { "target": "com.amazonaws.kendra#MinimumQueryCount", "traits": { - "smithy.api#documentation": "Shows the minimum number of times a query must be searched in order for \n the query to be eligible to suggest to your users.
" + "smithy.api#documentation": "The minimum number of times a query must be searched in order for \n the query to be eligible to suggest to your users.
" } }, "LastSuggestionsBuildTime": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "Shows the date-time query suggestions for an index was last updated.
" + "smithy.api#documentation": "The date-time query suggestions for an index was last updated.
" } }, "LastClearTime": { "target": "com.amazonaws.kendra#Timestamp", "traits": { - "smithy.api#documentation": "Shows the date-time query suggestions for an index was last cleared.
\nAfter you clear suggestions, Amazon Kendra learns new suggestions based \n on new queries added to the query log from the time you cleared suggestions. \n Amazon Kendra only considers re-occurences of a query from the time you cleared \n suggestions.
" + "smithy.api#documentation": "The date-time query suggestions for an index was last cleared.
\nAfter you clear suggestions, Amazon Kendra learns new suggestions based \n on new queries added to the query log from the time you cleared suggestions. \n Amazon Kendra only considers re-occurences of a query from the time you cleared \n suggestions.
" } }, "TotalSuggestionsCount": { "target": "com.amazonaws.kendra#Integer", "traits": { - "smithy.api#documentation": "Shows the current total count of query suggestions for an index.
\nThis count can change when you update your query suggestions settings, \n if you filter out certain queries from suggestions using a block list, \n and as the query log accumulates more queries for Amazon Kendra to learn from.
" + "smithy.api#documentation": "The current total count of query suggestions for an index.
\nThis count can change when you update your query suggestions settings, \n if you filter out certain queries from suggestions using a block list, \n and as the query log accumulates more queries for Amazon Kendra to learn from.
" } } } @@ -4615,7 +4901,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an existing Amazon Kendra thesaurus.
" + "smithy.api#documentation": "Gets information about an existing Amazon Kendra thesaurus.
" } }, "com.amazonaws.kendra#DescribeThesaurusRequest": { @@ -4624,14 +4910,14 @@ "Id": { "target": "com.amazonaws.kendra#ThesaurusId", "traits": { - "smithy.api#documentation": "The identifier of the thesaurus to describe.
", + "smithy.api#documentation": "The identifier of the thesaurus you want to get information on.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index associated with the thesaurus to describe.
", + "smithy.api#documentation": "The identifier of the index for the thesaurus.
", "smithy.api#required": {} } } @@ -4649,7 +4935,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index associated with the thesaurus to describe.
" + "smithy.api#documentation": "The identifier of the index for the thesaurus.
" } }, "Name": { @@ -4905,7 +5191,7 @@ "AccessControlList": { "target": "com.amazonaws.kendra#PrincipalList", "traits": { - "smithy.api#documentation": "Information on user and group access rights, which is used for \n user context filtering.
" + "smithy.api#documentation": "Information on principals (users and/or groups) and which documents \n they should have access to. This is useful for user context filtering, \n where search results are filtered based on the user or their group \n access to documents.
" } }, "HierarchicalAccessControlList": { @@ -4919,6 +5205,12 @@ "traits": { "smithy.api#documentation": "The file type of the document in the Blob\n field.
The identifier of the access control configuration that you want \n to apply to the document.
" + } } }, "traits": { @@ -5223,7 +5515,7 @@ "Relevance": { "target": "com.amazonaws.kendra#Relevance", "traits": { - "smithy.api#documentation": "Provides manual tuning parameters to determine how the field\n affects the search results.
" + "smithy.api#documentation": "Provides tuning parameters to determine how the field\n affects the search results.
" } }, "Search": { @@ -5234,7 +5526,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the properties of a custom index field.
" + "smithy.api#documentation": "Specifies the properties, such as relevance tuning \n and searchability, of an index field.
" } }, "com.amazonaws.kendra#DocumentMetadataConfigurationList": { @@ -5264,13 +5556,14 @@ "Name": { "target": "com.amazonaws.kendra#DocumentMetadataConfigurationName", "traits": { - "smithy.api#documentation": "The name of the tuning configuration to override document relevance \n at the index level.
", + "smithy.api#documentation": "The name of the index field.
", "smithy.api#required": {} } }, "Relevance": { "target": "com.amazonaws.kendra#Relevance", "traits": { + "smithy.api#documentation": "Provides information for tuning the relevance of a field\n in a search. When a query includes terms that match the field, the\n results are given a boost in the response based on these tuning\n parameters.
", "smithy.api#required": {} } } @@ -6014,7 +6307,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about a frequently asked questions and answer\n contained in an index.
" + "smithy.api#documentation": "Summary information for frequently asked questions and answers \n included in an index.
" } }, "com.amazonaws.kendra#FaqSummaryItems": { @@ -6582,7 +6875,7 @@ } }, "traits": { - "smithy.api#documentation": "A list of users or sub groups that belong to a group. Users and groups \n are useful for filtering search results to different users based on their \n group's access to documents.
" + "smithy.api#documentation": "A list of users or sub groups that belong to a group. This is useful for \n user context filtering, where search results are filtered based on the user \n or their group access to documents.
" } }, "com.amazonaws.kendra#GroupOrderingIdSummaries": { @@ -6632,7 +6925,7 @@ } }, "traits": { - "smithy.api#documentation": "Information on the processing of PUT and DELETE actions \n for mapping users to their groups.
Summary information on the processing of PUT and DELETE actions \n for mapping users to their groups.
\n The identifier of the group you want group summary information on.\n
" + "smithy.api#documentation": "The identifier of the group you want group summary information on.
" } }, "OrderingId": { "target": "com.amazonaws.kendra#PrincipalOrderingId", "traits": { - "smithy.api#documentation": "\n The timestamp identifier used for the latest PUT or DELETE \n action.\n
The timestamp identifier used for the latest PUT or DELETE \n action.
\n Group summary information.\n
" + "smithy.api#documentation": "Summary information for groups.
" } }, "com.amazonaws.kendra#Groups": { @@ -6852,7 +7145,7 @@ } }, "traits": { - "smithy.api#documentation": "A summary of information on the configuration of an index.
" + "smithy.api#documentation": "Summary information on the configuration of an index.
" } }, "com.amazonaws.kendra#IndexConfigurationSummaryList": { @@ -7366,6 +7659,82 @@ "smithy.api#pattern": "^[a-zA-Z-]*$" } }, + "com.amazonaws.kendra#ListAccessControlConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.kendra#ListAccessControlConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.kendra#ListAccessControlConfigurationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kendra#AccessDeniedException" + }, + { + "target": "com.amazonaws.kendra#InternalServerException" + }, + { + "target": "com.amazonaws.kendra#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kendra#ThrottlingException" + }, + { + "target": "com.amazonaws.kendra#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists one or more access control configurations for an index. This \n includes user and group access information for your documents. This \n is useful for user context filtering, where search results are filtered \n based on the user or their group access to documents.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kendra#ListAccessControlConfigurationsRequest": { + "type": "structure", + "members": { + "IndexId": { + "target": "com.amazonaws.kendra#IndexId", + "traits": { + "smithy.api#documentation": "The identifier of the index for the access control configuration.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.kendra#String", + "traits": { + "smithy.api#documentation": "If the previous response was incomplete (because there is more data \n to retrieve), Amazon Kendra returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of access \n control configurations.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.kendra#MaxResultsIntegerForListAccessControlConfigurationsRequest", + "traits": { + "smithy.api#documentation": "The maximum number of access control configurations to return.
" + } + } + } + }, + "com.amazonaws.kendra#ListAccessControlConfigurationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.kendra#String", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon Kendra returns this token \n that you can use in the subsequent request to retrieve the next set of \n access control configurations.
" + } + }, + "AccessControlConfigurations": { + "target": "com.amazonaws.kendra#AccessControlConfigurationSummaryList", + "traits": { + "smithy.api#documentation": "The details of your access control configurations.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.kendra#ListDataSourceSyncJobs": { "type": "operation", "input": { @@ -7416,7 +7785,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the data source.
", + "smithy.api#documentation": "The identifier of the index used with the data source.
", "smithy.api#required": {} } }, @@ -7503,7 +7872,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the data source.
", + "smithy.api#documentation": "The identifier of the index used with one or more data sources.
", "smithy.api#required": {} } }, @@ -8160,7 +8529,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon Kendra thesauri associated with an index.
", + "smithy.api#documentation": "Lists the thesauri for an index.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8174,7 +8543,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index associated with the thesaurus to list.
", + "smithy.api#documentation": "The identifier of the index with one or more thesauri.
", "smithy.api#required": {} } }, @@ -8245,6 +8614,16 @@ } } }, + "com.amazonaws.kendra#MaxResultsIntegerForListAccessControlConfigurationsRequest": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.kendra#MaxResultsIntegerForListDataSourceSyncJobsRequest": { "type": "integer", "traits": { @@ -8755,7 +9134,7 @@ "Access": { "target": "com.amazonaws.kendra#ReadAccessType", "traits": { - "smithy.api#documentation": "Whether to allow or deny access to the principal.
", + "smithy.api#documentation": "Whether to allow or deny document access to the principal.
", "smithy.api#required": {} } }, @@ -8767,7 +9146,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides user and group information for document access\n filtering.
" + "smithy.api#documentation": "Provides user and group information for user context filtering.
" } }, "com.amazonaws.kendra#PrincipalList": { @@ -8916,7 +9295,7 @@ } ], "traits": { - "smithy.api#documentation": "Maps users to their groups so that you only need to provide \n the user ID when you issue the query.
\nYou can also map sub groups to groups. \n For example, the group \"Company Intellectual Property Teams\" includes \n sub groups \"Research\" and \"Engineering\". These sub groups include their\n own list of users or people who work in these teams. Only users who work \n in research and engineering, and therefore belong in the intellectual \n property group, can see top-secret company documents in their search \n results.
\nYou map users to their groups when you want to filter search results \n for different users based on their group’s access to documents. For more \n information on filtering search results for different users, see \n Filtering \n on user context.
\nIf more than five PUT actions for a group are currently \n processing, a validation exception is thrown.
\n PutPrincipalMapping is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
Maps users to their groups so that you only need to provide \n the user ID when you issue the query.
\nYou can also map sub groups to groups. \n For example, the group \"Company Intellectual Property Teams\" includes \n sub groups \"Research\" and \"Engineering\". These sub groups include their\n own list of users or people who work in these teams. Only users who work \n in research and engineering, and therefore belong in the intellectual \n property group, can see top-secret company documents in their search \n results.
\nThis is useful for user context filtering, where search results are \n filtered based on the user or their group access to documents. For more \n information, see \n Filtering \n on user context.
\nIf more than five PUT actions for a group are currently \n processing, a validation exception is thrown.
\n PutPrincipalMapping is currently not supported in the \n Amazon Web Services GovCloud (US-West) region.
The identifier of the Quip folders you want to index.
" + "smithy.api#documentation": "The identifiers of the Quip folders you want to index.
" } }, "ThreadFieldMappings": { @@ -9516,7 +9895,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information for manually tuning the relevance of a field\n in a search. When a query includes terms that match the field, the\n results are given a boost in the response based on these tuning\n parameters.
" + "smithy.api#documentation": "Provides information for tuning the relevance of a field\n in a search. When a query includes terms that match the field, the\n results are given a boost in the response based on these tuning\n parameters.
" } }, "com.amazonaws.kendra#RelevanceFeedback": { @@ -10385,7 +10764,7 @@ "AuthenticationType": { "target": "com.amazonaws.kendra#ServiceNowAuthenticationType", "traits": { - "smithy.api#documentation": "The type of authentication used to connect to the\n ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is\n authenticated using the user name and password provided in the \n Secrets Manager secret in the SecretArn field. When you\n choose OAUTH2, Amazon Kendra is authenticated using the OAuth\n token and secret provided in the Secrets Manager secret, and the\n user name and password are used to determine which information Amazon Kendra\n has access to.
When you use OAUTH2 authentication, you must generate\n a token and a client secret using the ServiceNow console. For more\n information, see Using a\n ServiceNow data source.
The type of authentication used to connect to the\n ServiceNow instance. If you choose HTTP_BASIC, Amazon Kendra is\n authenticated using the user name and password provided in the \n Secrets Manager secret in the SecretArn field. If you\n choose OAUTH2, Amazon Kendra is authenticated using the \n credentials of client ID, client secret, user name and password.
When you use OAUTH2 authentication, you must generate\n a token and a client secret using the ServiceNow console. For more\n information, see Using a\n ServiceNow data source.
Indicates whether Amazon Kendra should index attachments to knowledge\n articles.
" + "smithy.api#documentation": "\n TRUE to index attachments to knowledge articles.
Indicates whether Amazon Kendra should crawl attachments to the service\n catalog items.
" + "smithy.api#documentation": "\n TRUE to index attachments to service catalog items.
Updates an access control configuration for your documents in an index. This \n includes user and group access information for your documents. This is useful \n for user context filtering, where search results are filtered based on the user \n or their group access to documents.
\nYou can update an access control configuration you created without indexing all \n of your documents again. For example, your index contains top-secret company \n documents that only certain employees or users should access. You created an 'allow' \n access control configuration for one user who recently joined the 'top-secret' team, \n switching from a team with 'deny' access to top-secret documents. However, the user \n suddenly returns to their previous team and should no longer have access to top secret \n documents. You can update the access control configuration to re-configure access \n control for your documents as circumstances change.
\nYou call the BatchPutDocument \n API to apply the updated access control configuration, with the \n AccessControlConfigurationId included in the \n Document \n object. If you use an S3 bucket as a data source, you synchronize your data source to \n apply the the AccessControlConfigurationId in the .metadata.json file. \n Amazon Kendra currently only supports access control configuration for S3 data \n sources and documents indexed using the BatchPutDocument API.
The identifier of the index for an access control configuration.
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.kendra#AccessControlConfigurationId", + "traits": { + "smithy.api#documentation": "The identifier of the access control configuration you want to update.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.kendra#AccessControlConfigurationName", + "traits": { + "smithy.api#documentation": "A new name for the access control configuration.
" + } + }, + "Description": { + "target": "com.amazonaws.kendra#Description", + "traits": { + "smithy.api#documentation": "A new description for the access control configuration.
" + } + }, + "AccessControlList": { + "target": "com.amazonaws.kendra#PrincipalList", + "traits": { + "smithy.api#documentation": "Information you want to update on principals (users and/or groups) and which \n documents they should have access to. This is useful for user context filtering, \n where search results are filtered based on the user or their group access to \n documents.
" + } + }, + "HierarchicalAccessControlList": { + "target": "com.amazonaws.kendra#HierarchicalPrincipalList", + "traits": { + "smithy.api#documentation": "The updated list of principal lists that \n define the hierarchy for which documents users should have access to.
" + } + } + } + }, + "com.amazonaws.kendra#UpdateAccessControlConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.kendra#UpdateDataSource": { "type": "operation", "input": { @@ -11755,57 +12216,57 @@ "Id": { "target": "com.amazonaws.kendra#DataSourceId", "traits": { - "smithy.api#documentation": "The unique identifier of the data source to update.
", + "smithy.api#documentation": "The identifier of the data source you want to update.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.kendra#DataSourceName", "traits": { - "smithy.api#documentation": "The name of the data source to update. The name of the data source\n can't be updated. To rename a data source you must delete the data source\n and re-create it.
" + "smithy.api#documentation": "A new name for the data source connector. You must \n first delete the data source and re-create it to change the \n name of the data source.
" } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index that contains the data source to\n update.
", + "smithy.api#documentation": "The identifier of the index used with the data source connector.
", "smithy.api#required": {} } }, "Configuration": { "target": "com.amazonaws.kendra#DataSourceConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for an Amazon Kendra data source you want to update.
" + "smithy.api#documentation": "Configuration information you want to update for the data source connector.
" } }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "The new description for the data source.
" + "smithy.api#documentation": "A new description for the data source connector.
" } }, "Schedule": { "target": "com.amazonaws.kendra#ScanSchedule", "traits": { - "smithy.api#documentation": "The new update schedule for the data source.
" + "smithy.api#documentation": "The sync schedule you want to update for the data source connector.
" } }, "RoleArn": { "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new role to use when the data\n source is accessing resources on your behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access \n the data source. For more information, see IAM Roles for \n Amazon Kendra.
" } }, "LanguageCode": { "target": "com.amazonaws.kendra#LanguageCode", "traits": { - "smithy.api#documentation": "The code for a language. This allows you to support a language for all \n documents when updating the data source. English is supported \n by default. For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" + "smithy.api#documentation": "The code for a language you want to update for the data source connector. \n This allows you to support a language for all \n documents when updating the data source. English is supported \n by default. For more information on supported languages, including their codes, \n see Adding \n documents in languages other than English.
" } }, "CustomDocumentEnrichmentConfiguration": { "target": "com.amazonaws.kendra#CustomDocumentEnrichmentConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for altering document metadata and content during the\n document ingestion process when you update a data source.
\nFor more information on how to create, modify and delete document metadata, or make\n other content alterations when you ingest documents into Amazon Kendra, see \n Customizing \n document metadata during the ingestion process.
" + "smithy.api#documentation": "Configuration information you want to update for altering document metadata \n and content during the document ingestion process.
\nFor more information on how to create, modify and delete document metadata, or make\n other content alterations when you ingest documents into Amazon Kendra, see \n Customizing \n document metadata during the ingestion process.
" } } } @@ -11855,13 +12316,13 @@ "Name": { "target": "com.amazonaws.kendra#ExperienceName", "traits": { - "smithy.api#documentation": "The name of your Amazon Kendra experience you want to update.
" + "smithy.api#documentation": "A new name for your Amazon Kendra experience.
" } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience you want to update.
", + "smithy.api#documentation": "The identifier of the index for your Amazon Kendra experience.
", "smithy.api#required": {} } }, @@ -11874,13 +12335,13 @@ "Configuration": { "target": "com.amazonaws.kendra#ExperienceConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for your Amazon Kendra you want to update.
" + "smithy.api#documentation": "Configuration information you want to update for your Amazon Kendra experience.
" } }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "The description of your Amazon Kendra experience you want to update.
" + "smithy.api#documentation": "A new description for your Amazon Kendra experience.
" } } } @@ -11926,20 +12387,20 @@ "Id": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index to update.
", + "smithy.api#documentation": "The identifier of the index you want to update.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.kendra#IndexName", "traits": { - "smithy.api#documentation": "The name of the index to update.
" + "smithy.api#documentation": "The name of the index you want to update.
" } }, "RoleArn": { "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "A new IAM role that gives Amazon Kendra permission to access your\n Amazon CloudWatch logs.
" + "smithy.api#documentation": "An Identity and Access Management (IAM) role that \n gives Amazon Kendra permission to access Amazon CloudWatch \n logs and metrics.
" } }, "Description": { @@ -11951,7 +12412,7 @@ "DocumentMetadataConfigurationUpdates": { "target": "com.amazonaws.kendra#DocumentMetadataConfigurationList", "traits": { - "smithy.api#documentation": "The document metadata you want to update.
" + "smithy.api#documentation": "The document metadata configuration you want to update for the index. \n Document metadata are fields or attributes associated with your documents. \n For example, the company department name associated with each document.
" } }, "CapacityUnits": { @@ -12018,27 +12479,27 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index for a block list.
", + "smithy.api#documentation": "The identifier of the index for the block list.
", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.kendra#QuerySuggestionsBlockListId", "traits": { - "smithy.api#documentation": "The unique identifier of a block list.
", + "smithy.api#documentation": "The identifier of the block list you want to update.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.kendra#QuerySuggestionsBlockListName", "traits": { - "smithy.api#documentation": "The name of a block list.
" + "smithy.api#documentation": "A new name for the block list.
" } }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "The description for a block list.
" + "smithy.api#documentation": "A new description for the block list.
" } }, "SourceS3Path": { @@ -12093,7 +12554,7 @@ "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index you want to update query suggestions settings for.
", + "smithy.api#documentation": "The identifier of the index with query suggestions you want to update.
", "smithy.api#required": {} } }, @@ -12158,7 +12619,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a thesaurus file associated with an index.
" + "smithy.api#documentation": "Updates a thesaurus for an index.
" } }, "com.amazonaws.kendra#UpdateThesaurusRequest": { @@ -12167,33 +12628,33 @@ "Id": { "target": "com.amazonaws.kendra#ThesaurusId", "traits": { - "smithy.api#documentation": "The identifier of the thesaurus to update.
", + "smithy.api#documentation": "The identifier of the thesaurus you want to update.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.kendra#ThesaurusName", "traits": { - "smithy.api#documentation": "The updated name of the thesaurus.
" + "smithy.api#documentation": "A new name for the thesaurus.
" } }, "IndexId": { "target": "com.amazonaws.kendra#IndexId", "traits": { - "smithy.api#documentation": "The identifier of the index associated with the thesaurus to update.
", + "smithy.api#documentation": "The identifier of the index for the thesaurus.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.kendra#Description", "traits": { - "smithy.api#documentation": "The updated description of the thesaurus.
" + "smithy.api#documentation": "A new description for the thesaurus.
" } }, "RoleArn": { "target": "com.amazonaws.kendra#RoleArn", "traits": { - "smithy.api#documentation": "The updated role ARN of the thesaurus.
" + "smithy.api#documentation": "An IAM role that gives Amazon Kendra permissions to \n access thesaurus file specified in SourceS3Path.
Provides information about the user context for\n an Amazon Kendra index.
\nThis is used for filtering search results for different users based on their access \n to documents.
\nYou provide one of the following:
\nUser token
\nUser ID, the groups the user belongs to, and any data sources the groups can\n access.
\nIf you provide both, an exception is thrown.
" + "smithy.api#documentation": "Provides information about the user context for\n an Amazon Kendra index.
\nUser context filtering is a kind of personalized search with \n the benefit of controlling access to documents. For example, not \n all teams that search the company portal for information should \n access top-secret company documents, nor are these documents \n relevant to all users. Only specific users or groups of teams given \n access to top-secret documents should see these documents in their \n search results.
\nYou provide one of the following:
\nUser token
\nUser ID, the groups the user belongs to, and any data sources the groups can\n access.
\nIf you provide both, an exception is thrown.
" } }, "com.amazonaws.kendra#UserContextPolicy": { @@ -12300,7 +12761,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides the configuration information to fetch access levels \n of groups and users from an Amazon Web Services Single Sign On identity \n source. This is useful for setting up user context filtering, where \n Amazon Kendra filters search results for different users based on their \n group's access to documents. You can also map your users to their \n groups for user context filtering using the \n PutPrincipalMapping \n API.
\nTo set up an Amazon Web Services SSO identity source in the console to use with \n Amazon Kendra, see Getting started \n with an Amazon Web Services SSO identity source. You must also grant the required \n permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see \n IAM roles for \n Amazon Web Services SSO.
\nAmazon Kendra currently does not support using UserGroupResolutionConfiguration \n with an Amazon Web Services organization member account for your Amazon Web Services SSO \n identify source. You must create your index in the management account for the organization \n in order to use UserGroupResolutionConfiguration.
Provides the configuration information to fetch access levels \n of groups and users from an Amazon Web Services Single Sign On identity \n source. This is useful for user context filtering, where search \n results are filtered based on the user or their group access to \n documents. You can also use the PutPrincipalMapping \n API to map users to their groups so that you only need to provide \n the user ID when you issue the query.
\nTo set up an Amazon Web Services SSO identity source in the console to use with \n Amazon Kendra, see Getting started \n with an Amazon Web Services SSO identity source. You must also grant the required \n permissions to use Amazon Web Services SSO with Amazon Kendra. For more information, see \n IAM roles for \n Amazon Web Services SSO.
\nAmazon Kendra currently does not support using UserGroupResolutionConfiguration \n with an Amazon Web Services organization member account for your Amazon Web Services SSO \n identify source. You must create your index in the management account for the organization \n in order to use UserGroupResolutionConfiguration.
Configuration information required to connect to websites using \n authentication.
\nYou can connect to websites using basic authentication of user name and password.
\nYou must provide the website host name and port number. For example, the host name \n of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the \n standard port for HTTPS. You use a secret in Secrets Manager to store \n your authentication credentials.
" + "smithy.api#documentation": "Configuration information required to connect to websites using \n authentication.
\nYou can connect to websites using basic authentication of user name and password. \n You use a secret in Secrets Manager to store \n your authentication credentials.
\nYou must provide the website host name and port number. For example, the host name \n of https://a.example.com/page1.html is \"a.example.com\" and the port is 443, the \n standard port for HTTPS.
" } } }, diff --git a/codegen/sdk/aws-models/networkmanager.json b/codegen/sdk/aws-models/networkmanager.json index 109dd30698d..3d4429a5caa 100644 --- a/codegen/sdk/aws-models/networkmanager.json +++ b/codegen/sdk/aws-models/networkmanager.json @@ -149,11 +149,20 @@ "type": "structure", "members": { "AccountId": { - "target": "com.amazonaws.networkmanager#AccountId" + "target": "com.amazonaws.networkmanager#AccountId", + "traits": { + "smithy.api#documentation": "The ID of an account within the Amazon Web Services Organization.
" + } }, "SLRDeploymentStatus": { - "target": "com.amazonaws.networkmanager#SLRDeploymentStatus" + "target": "com.amazonaws.networkmanager#SLRDeploymentStatus", + "traits": { + "smithy.api#documentation": "The status of SLR deployment for the account.
" + } } + }, + "traits": { + "smithy.api#documentation": "Describes the current status of an account within an Amazon Web Services Organization, including service-linked roles (SLRs).
" } }, "com.amazonaws.networkmanager#AccountStatusList": { @@ -507,7 +516,7 @@ "CoreNetworkId": { "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "A core network ID.
" + "smithy.api#documentation": "The ID of a core network.
" } }, "CoreNetworkArn": { @@ -667,6 +676,10 @@ { "value": "VPC", "name": "VPC" + }, + { + "value": "TRANSIT_GATEWAY_ROUTE_TABLE", + "name": "TRANSIT_GATEWAY_ROUTE_TABLE" } ] } @@ -758,6 +771,29 @@ ] } }, + "com.amazonaws.networkmanager#ChangeStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, "com.amazonaws.networkmanager#ChangeType": { "type": "string", "traits": { @@ -781,6 +817,22 @@ { "value": "ATTACHMENT_ROUTE_STATIC", "name": "ATTACHMENT_ROUTE_STATIC" + }, + { + "value": "CORE_NETWORK_CONFIGURATION", + "name": "CORE_NETWORK_CONFIGURATION" + }, + { + "value": "SEGMENTS_CONFIGURATION", + "name": "SEGMENTS_CONFIGURATION" + }, + { + "value": "SEGMENT_ACTIONS_CONFIGURATION", + "name": "SEGMENT_ACTIONS_CONFIGURATION" + }, + { + "value": "ATTACHMENT_POLICIES_CONFIGURATION", + "name": "ATTACHMENT_POLICIES_CONFIGURATION" } ] } @@ -913,7 +965,7 @@ "Tags": { "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "The tags associated with the Connect peer.
" + "smithy.api#documentation": "The list of key-value tags associated with the Connect peer.
" } } }, @@ -1145,7 +1197,7 @@ "Tags": { "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "The tags associated with a Connect peer summary.
" + "smithy.api#documentation": "The list of key-value tags associated with the Connect peer summary.
" } } }, @@ -1414,7 +1466,7 @@ "Tags": { "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "The tags associated with a core network.
" + "smithy.api#documentation": "The list of key-value tags associated with a core network.
" } } }, @@ -1464,12 +1516,100 @@ "traits": { "smithy.api#documentation": "The new value for a core network
" } + }, + "IdentifierPath": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be \"CORE_NETWORK_SEGMENT/us-east-1/devsegment\".
Details describing a core network change.
" } }, + "com.amazonaws.networkmanager#CoreNetworkChangeEvent": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.networkmanager#ChangeType", + "traits": { + "smithy.api#documentation": "Describes the type of change event.
" + } + }, + "Action": { + "target": "com.amazonaws.networkmanager#ChangeAction", + "traits": { + "smithy.api#documentation": "The action taken for the change event.
" + } + }, + "IdentifierPath": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be \"CORE_NETWORK_SEGMENT/us-east-1/devsegment\".
The timestamp for an event change in status.
" + } + }, + "Status": { + "target": "com.amazonaws.networkmanager#ChangeStatus", + "traits": { + "smithy.api#documentation": "The status of the core network change event.
" + } + }, + "Values": { + "target": "com.amazonaws.networkmanager#CoreNetworkChangeEventValues", + "traits": { + "smithy.api#documentation": "Details of the change event.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a core network change event. This can be a change to a segment, attachment, route, etc.
" + } + }, + "com.amazonaws.networkmanager#CoreNetworkChangeEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#CoreNetworkChangeEvent" + } + }, + "com.amazonaws.networkmanager#CoreNetworkChangeEventValues": { + "type": "structure", + "members": { + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "The edge location for the core network change event.
" + } + }, + "SegmentName": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "The segment name if the change event is associated with a segment.
" + } + }, + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "The ID of the attachment if the change event is associated with an attachment.
" + } + }, + "Cidr": { + "target": "com.amazonaws.networkmanager#ConstrainedString", + "traits": { + "smithy.api#documentation": "For a STATIC_ROUTE event, this is the IP address.
Describes a core network change event.
" + } + }, "com.amazonaws.networkmanager#CoreNetworkChangeList": { "type": "list", "member": { @@ -2719,6 +2859,166 @@ } } }, + "com.amazonaws.networkmanager#CreateTransitGatewayPeering": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#CreateTransitGatewayPeeringRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#CreateTransitGatewayPeeringResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a transit gateway peering connection.
", + "smithy.api#http": { + "method": "POST", + "uri": "/transit-gateway-peerings", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#CreateTransitGatewayPeeringRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "The ID of a core network.
", + "smithy.api#required": {} + } + }, + "TransitGatewayArn": { + "target": "com.amazonaws.networkmanager#TransitGatewayArn", + "traits": { + "smithy.api#documentation": "The ARN of the transit gateway for the peering request.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "The list of key-value tags associated with the request.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.networkmanager#ClientToken", + "traits": { + "smithy.api#documentation": "The client token associated with the request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.networkmanager#CreateTransitGatewayPeeringResponse": { + "type": "structure", + "members": { + "TransitGatewayPeering": { + "target": "com.amazonaws.networkmanager#TransitGatewayPeering", + "traits": { + "smithy.api#documentation": "Returns information about the transit gateway peering connection request.
" + } + } + } + }, + "com.amazonaws.networkmanager#CreateTransitGatewayRouteTableAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#CreateTransitGatewayRouteTableAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#CreateTransitGatewayRouteTableAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a transit gateway route table attachment.
", + "smithy.api#http": { + "method": "POST", + "uri": "/transit-gateway-route-table-attachments", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#CreateTransitGatewayRouteTableAttachmentRequest": { + "type": "structure", + "members": { + "PeeringId": { + "target": "com.amazonaws.networkmanager#PeeringId", + "traits": { + "smithy.api#documentation": "The ID of the peer for the
", + "smithy.api#required": {} + } + }, + "TransitGatewayRouteTableArn": { + "target": "com.amazonaws.networkmanager#TransitGatewayRouteTableArn", + "traits": { + "smithy.api#documentation": "The ARN of the transit gateway route table for the attachment request.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "The list of key-value tags associated with the request.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.networkmanager#ClientToken", + "traits": { + "smithy.api#documentation": "The client token associated with the request.
", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.networkmanager#CreateTransitGatewayRouteTableAttachmentResponse": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAttachment": { + "target": "com.amazonaws.networkmanager#TransitGatewayRouteTableAttachment", + "traits": { + "smithy.api#documentation": "The route table associated with the create transit gateway route table attachment request.
" + } + } + } + }, "com.amazonaws.networkmanager#CreateVpcAttachment": { "type": "operation", "input": { @@ -3418,13 +3718,13 @@ } } }, - "com.amazonaws.networkmanager#DeleteResourcePolicy": { + "com.amazonaws.networkmanager#DeletePeering": { "type": "operation", "input": { - "target": "com.amazonaws.networkmanager#DeleteResourcePolicyRequest" + "target": "com.amazonaws.networkmanager#DeletePeeringRequest" }, "output": { - "target": "com.amazonaws.networkmanager#DeleteResourcePolicyResponse" + "target": "com.amazonaws.networkmanager#DeletePeeringResponse" }, "errors": [ { @@ -3436,6 +3736,9 @@ { "target": "com.amazonaws.networkmanager#InternalServerException" }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, { "target": "com.amazonaws.networkmanager#ThrottlingException" }, @@ -3444,32 +3747,90 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.
", + "smithy.api#documentation": "Deletes an existing peering connection.
", "smithy.api#http": { "method": "DELETE", - "uri": "/resource-policy/{ResourceArn}", + "uri": "/peerings/{PeeringId}", "code": 200 } } }, - "com.amazonaws.networkmanager#DeleteResourcePolicyRequest": { + "com.amazonaws.networkmanager#DeletePeeringRequest": { "type": "structure", "members": { - "ResourceArn": { - "target": "com.amazonaws.networkmanager#ResourceArn", + "PeeringId": { + "target": "com.amazonaws.networkmanager#PeeringId", "traits": { - "smithy.api#documentation": "The ARN of the policy to delete.
", + "smithy.api#documentation": "The ID of the peering connection to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.networkmanager#DeleteResourcePolicyResponse": { + "com.amazonaws.networkmanager#DeletePeeringResponse": { "type": "structure", - "members": {} + "members": { + "Peering": { + "target": "com.amazonaws.networkmanager#Peering", + "traits": { + "smithy.api#documentation": "Information about a deleted peering connection.
" + } + } + } }, - "com.amazonaws.networkmanager#DeleteSite": { + "com.amazonaws.networkmanager#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#DeleteResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#ConflictException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/resource-policy/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "The ARN of the policy to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#DeleteResourcePolicyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.networkmanager#DeleteSite": { "type": "operation", "input": { "target": "com.amazonaws.networkmanager#DeleteSiteRequest" @@ -3642,6 +4003,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "GlobalNetworks", "pageSize": "MaxResults" } } @@ -4378,6 +4740,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ConnectPeerAssociations", "pageSize": "MaxResults" } } @@ -4492,6 +4855,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Connections", "pageSize": "MaxResults" } } @@ -4588,6 +4952,98 @@ } } }, + "com.amazonaws.networkmanager#GetCoreNetworkChangeEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetCoreNetworkChangeEventsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetCoreNetworkChangeEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a core network change event.
", + "smithy.api#http": { + "method": "GET", + "uri": "/core-networks/{CoreNetworkId}/core-network-change-events/{PolicyVersionId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CoreNetworkChangeEvents", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkChangeEventsRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "The ID of a core network.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PolicyVersionId": { + "target": "com.amazonaws.networkmanager#Integer", + "traits": { + "smithy.api#documentation": "The ID of the policy version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#GetCoreNetworkChangeEventsResponse": { + "type": "structure", + "members": { + "CoreNetworkChangeEvents": { + "target": "com.amazonaws.networkmanager#CoreNetworkChangeEventList", + "traits": { + "smithy.api#documentation": "The response to GetCoreNetworkChangeEventsRequest.
The token for the next page of results.
" + } + } + } + }, "com.amazonaws.networkmanager#GetCoreNetworkChangeSet": { "type": "operation", "input": { @@ -4623,6 +5079,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "CoreNetworkChanges", "pageSize": "MaxResults" } } @@ -4705,7 +5162,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets details about a core network policy. You can get details about your current live policy or any previous policy version.
", + "smithy.api#documentation": "Returns details about a core network policy. You can get details about your current live policy or any previous policy version.
", "smithy.api#http": { "method": "GET", "uri": "/core-networks/{CoreNetworkId}/core-network-policy", @@ -4813,6 +5270,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "CustomerGatewayAssociations", "pageSize": "MaxResults" } } @@ -4903,6 +5361,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Devices", "pageSize": "MaxResults" } } @@ -5000,6 +5459,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "LinkAssociations", "pageSize": "MaxResults" } } @@ -5097,6 +5557,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Links", "pageSize": "MaxResults" } } @@ -5205,6 +5666,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "NetworkResourceCounts", "pageSize": "MaxResults" } } @@ -5295,6 +5757,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Relationships", "pageSize": "MaxResults" } } @@ -5420,6 +5883,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "NetworkResources", "pageSize": "MaxResults" } } @@ -5682,6 +6146,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "NetworkTelemetry", "pageSize": "MaxResults" } } @@ -5986,6 +6451,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Sites", "pageSize": "MaxResults" } } @@ -6079,6 +6545,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TransitGatewayConnectPeerAssociations", "pageSize": "MaxResults" } } @@ -6134,6 +6601,64 @@ } } }, + "com.amazonaws.networkmanager#GetTransitGatewayPeering": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetTransitGatewayPeeringRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetTransitGatewayPeeringResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a transit gateway peer.
", + "smithy.api#http": { + "method": "GET", + "uri": "/transit-gateway-peerings/{PeeringId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayPeeringRequest": { + "type": "structure", + "members": { + "PeeringId": { + "target": "com.amazonaws.networkmanager#PeeringId", + "traits": { + "smithy.api#documentation": "The ID of the peering request.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayPeeringResponse": { + "type": "structure", + "members": { + "TransitGatewayPeering": { + "target": "com.amazonaws.networkmanager#TransitGatewayPeering", + "traits": { + "smithy.api#documentation": "Returns information about a transit gateway peering.
" + } + } + } + }, "com.amazonaws.networkmanager#GetTransitGatewayRegistrations": { "type": "operation", "input": { @@ -6169,6 +6694,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "TransitGatewayRegistrations", "pageSize": "MaxResults" } } @@ -6224,6 +6750,64 @@ } } }, + "com.amazonaws.networkmanager#GetTransitGatewayRouteTableAttachment": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#GetTransitGatewayRouteTableAttachmentRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#GetTransitGatewayRouteTableAttachmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a transit gateway route table attachment.
", + "smithy.api#http": { + "method": "GET", + "uri": "/transit-gateway-route-table-attachments/{AttachmentId}", + "code": 200 + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayRouteTableAttachmentRequest": { + "type": "structure", + "members": { + "AttachmentId": { + "target": "com.amazonaws.networkmanager#AttachmentId", + "traits": { + "smithy.api#documentation": "The ID of the transit gateway route table attachment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.networkmanager#GetTransitGatewayRouteTableAttachmentResponse": { + "type": "structure", + "members": { + "TransitGatewayRouteTableAttachment": { + "target": "com.amazonaws.networkmanager#TransitGatewayRouteTableAttachment", + "traits": { + "smithy.api#documentation": "Returns information about the transit gateway route table attachment.
" + } + } + } + }, "com.amazonaws.networkmanager#GetVpcAttachment": { "type": "operation", "input": { @@ -6642,6 +7226,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "Attachments", "pageSize": "MaxResults" } } @@ -6742,6 +7327,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "ConnectPeers", "pageSize": "MaxResults" } } @@ -6831,6 +7417,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "CoreNetworkPolicyVersions", "pageSize": "MaxResults" } } @@ -6911,6 +7498,7 @@ "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", + "items": "CoreNetworks", "pageSize": "MaxResults" } } @@ -6960,6 +7548,7 @@ "target": "com.amazonaws.networkmanager#ListOrganizationServiceAccessStatusResponse" }, "traits": { + "smithy.api#documentation": "Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.
", "smithy.api#http": { "method": "GET", "uri": "/organizations/service-access", @@ -6973,12 +7562,14 @@ "MaxResults": { "target": "com.amazonaws.networkmanager#MaxResults", "traits": { + "smithy.api#documentation": "The maximum number of results to return.
", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.networkmanager#NextToken", "traits": { + "smithy.api#documentation": "The token for the next page of results.
", "smithy.api#httpQuery": "nextToken" } } @@ -6988,10 +7579,117 @@ "type": "structure", "members": { "OrganizationStatus": { - "target": "com.amazonaws.networkmanager#OrganizationStatus" + "target": "com.amazonaws.networkmanager#OrganizationStatus", + "traits": { + "smithy.api#documentation": "Displays the status of an Amazon Web Services Organization.
" + } + }, + "NextToken": { + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + } + } + }, + "com.amazonaws.networkmanager#ListPeerings": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmanager#ListPeeringsRequest" + }, + "output": { + "target": "com.amazonaws.networkmanager#ListPeeringsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmanager#InternalServerException" + }, + { + "target": "com.amazonaws.networkmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the peerings for a core network.
", + "smithy.api#http": { + "method": "GET", + "uri": "/peerings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Peerings", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.networkmanager#ListPeeringsRequest": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "The ID of a core network.
", + "smithy.api#httpQuery": "coreNetworkId" + } + }, + "PeeringType": { + "target": "com.amazonaws.networkmanager#PeeringType", + "traits": { + "smithy.api#documentation": "Returns a list of a peering requests.
", + "smithy.api#httpQuery": "peeringType" + } + }, + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "Returns a list edge locations for the
", + "smithy.api#httpQuery": "edgeLocation" + } + }, + "State": { + "target": "com.amazonaws.networkmanager#PeeringState", + "traits": { + "smithy.api#documentation": "Returns a list of the peering request states.
", + "smithy.api#httpQuery": "state" + } + }, + "MaxResults": { + "target": "com.amazonaws.networkmanager#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
", + "smithy.api#httpQuery": "maxResults" + } }, "NextToken": { - "target": "com.amazonaws.networkmanager#NextToken" + "target": "com.amazonaws.networkmanager#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.networkmanager#ListPeeringsResponse": { + "type": "structure", + "members": { + "Peerings": { + "target": "com.amazonaws.networkmanager#PeeringList", + "traits": { + "smithy.api#documentation": "Lists the transit gateway peerings for the ListPeerings request.
The token for the next page of results.
" + } } } }, @@ -7157,6 +7855,12 @@ { "target": "com.amazonaws.networkmanager#CreateSiteToSiteVpnAttachment" }, + { + "target": "com.amazonaws.networkmanager#CreateTransitGatewayPeering" + }, + { + "target": "com.amazonaws.networkmanager#CreateTransitGatewayRouteTableAttachment" + }, { "target": "com.amazonaws.networkmanager#CreateVpcAttachment" }, @@ -7184,6 +7888,9 @@ { "target": "com.amazonaws.networkmanager#DeleteLink" }, + { + "target": "com.amazonaws.networkmanager#DeletePeering" + }, { "target": "com.amazonaws.networkmanager#DeleteResourcePolicy" }, @@ -7226,6 +7933,9 @@ { "target": "com.amazonaws.networkmanager#GetCoreNetwork" }, + { + "target": "com.amazonaws.networkmanager#GetCoreNetworkChangeEvents" + }, { "target": "com.amazonaws.networkmanager#GetCoreNetworkChangeSet" }, @@ -7274,9 +7984,15 @@ { "target": "com.amazonaws.networkmanager#GetTransitGatewayConnectPeerAssociations" }, + { + "target": "com.amazonaws.networkmanager#GetTransitGatewayPeering" + }, { "target": "com.amazonaws.networkmanager#GetTransitGatewayRegistrations" }, + { + "target": "com.amazonaws.networkmanager#GetTransitGatewayRouteTableAttachment" + }, { "target": "com.amazonaws.networkmanager#GetVpcAttachment" }, @@ -7295,6 +8011,9 @@ { "target": "com.amazonaws.networkmanager#ListOrganizationServiceAccessStatus" }, + { + "target": "com.amazonaws.networkmanager#ListPeerings" + }, { "target": "com.amazonaws.networkmanager#ListTagsForResource" }, @@ -7363,7 +8082,7 @@ "CoreNetworkId": { "target": "com.amazonaws.networkmanager#CoreNetworkId", "traits": { - "smithy.api#documentation": "a core network ID.
" + "smithy.api#documentation": "The ID of a core network.
" } }, "AwsRegion": { @@ -7705,20 +8424,33 @@ "type": "structure", "members": { "OrganizationId": { - "target": "com.amazonaws.networkmanager#OrganizationId" + "target": "com.amazonaws.networkmanager#OrganizationId", + "traits": { + "smithy.api#documentation": "The ID of an Amazon Web Services Organization.
" + } }, "OrganizationAwsServiceAccessStatus": { - "target": "com.amazonaws.networkmanager#OrganizationAwsServiceAccessStatus" + "target": "com.amazonaws.networkmanager#OrganizationAwsServiceAccessStatus", + "traits": { + "smithy.api#documentation": "The status of the organization's AWS service access. This will be ENABLED or DISABLED.
The status of the SLR deployment for the account. This will be either SUCCEEDED or IN_PROGRESS.
The current service-linked role (SLR) deployment status for an Amazon Web Services Organization's accounts. This will be either SUCCEEDED or IN_PROGRESS.
The status of an Amazon Web Services Organization and the accounts within that organization.
" } }, "com.amazonaws.networkmanager#PathComponent": { @@ -7753,13 +8485,131 @@ "target": "com.amazonaws.networkmanager#PathComponent" } }, + "com.amazonaws.networkmanager#Peering": { + "type": "structure", + "members": { + "CoreNetworkId": { + "target": "com.amazonaws.networkmanager#CoreNetworkId", + "traits": { + "smithy.api#documentation": "The ID of the core network for the peering request.
" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.networkmanager#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "The ARN of a core network.
" + } + }, + "PeeringId": { + "target": "com.amazonaws.networkmanager#PeeringId", + "traits": { + "smithy.api#documentation": "The ID of the peering attachment.
" + } + }, + "OwnerAccountId": { + "target": "com.amazonaws.networkmanager#AWSAccountId", + "traits": { + "smithy.api#documentation": "The ID of the account owner.
" + } + }, + "PeeringType": { + "target": "com.amazonaws.networkmanager#PeeringType", + "traits": { + "smithy.api#documentation": "The type of peering. This will be TRANSIT_GATEWAY.
The current state of the peering connection.
" + } + }, + "EdgeLocation": { + "target": "com.amazonaws.networkmanager#ExternalRegionCode", + "traits": { + "smithy.api#documentation": "The edge location for the peer.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.networkmanager#ResourceArn", + "traits": { + "smithy.api#documentation": "The resource ARN of the peer.
" + } + }, + "Tags": { + "target": "com.amazonaws.networkmanager#TagList", + "traits": { + "smithy.api#documentation": "The list of key-value tags associated with the peering.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.networkmanager#DateTime", + "traits": { + "smithy.api#documentation": "The timestamp when the attachment peer was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a peering connection.
" + } + }, + "com.amazonaws.networkmanager#PeeringId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^peering-([0-9a-f]{8,17})$" + } + }, + "com.amazonaws.networkmanager#PeeringList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#Peering" + } + }, + "com.amazonaws.networkmanager#PeeringState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.networkmanager#PeeringType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRANSIT_GATEWAY", + "name": "TRANSIT_GATEWAY" + } + ] + } + }, "com.amazonaws.networkmanager#ProposedSegmentChange": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.networkmanager#TagList", "traits": { - "smithy.api#documentation": "The key-value tags that changed for the segment.
" + "smithy.api#documentation": "The list of key-value tags that changed for the segment.
" } }, "AttachmentPolicyRuleNumber": { @@ -8785,6 +9635,7 @@ } ], "traits": { + "smithy.api#documentation": "Enables for the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.
", "smithy.api#http": { "method": "POST", "uri": "/organizations/service-access", @@ -8798,6 +9649,7 @@ "Action": { "target": "com.amazonaws.networkmanager#Action", "traits": { + "smithy.api#documentation": "The action to take for the update request. This can be either ENABLE or DISABLE.
The status of the service access update request for an Amazon Web Services Organization.
" + } } } }, @@ -9194,6 +10049,26 @@ ] } }, + "com.amazonaws.networkmanager#TransitGatewayPeering": { + "type": "structure", + "members": { + "Peering": { + "target": "com.amazonaws.networkmanager#Peering", + "traits": { + "smithy.api#documentation": "Describes a transit gateway peer connection.
" + } + }, + "TransitGatewayArn": { + "target": "com.amazonaws.networkmanager#TransitGatewayArn", + "traits": { + "smithy.api#documentation": "The ARN of the transit gateway.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a transit gateway peering attachment.
" + } + }, "com.amazonaws.networkmanager#TransitGatewayRegistration": { "type": "structure", "members": { @@ -9283,6 +10158,29 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.networkmanager#TransitGatewayRouteTableAttachment": { + "type": "structure", + "members": { + "Attachment": { + "target": "com.amazonaws.networkmanager#Attachment" + }, + "PeeringId": { + "target": "com.amazonaws.networkmanager#PeeringId", + "traits": { + "smithy.api#documentation": "The ID of the peering attachment.
" + } + }, + "TransitGatewayRouteTableArn": { + "target": "com.amazonaws.networkmanager#TransitGatewayRouteTableArn", + "traits": { + "smithy.api#documentation": "The ARN of the transit gateway attachment route table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a transit gateway route table attachment.
" + } + }, "com.amazonaws.networkmanager#TunnelProtocol": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/nimble.json b/codegen/sdk/aws-models/nimble.json index 28c9c35cd3f..c19d43c72f1 100644 --- a/codegen/sdk/aws-models/nimble.json +++ b/codegen/sdk/aws-models/nimble.json @@ -842,7 +842,8 @@ "aws.iam#requiredActions": [ "ec2:DescribeSecurityGroups", "fsx:DescribeFileSystems", - "ds:DescribeDirectories" + "ds:DescribeDirectories", + "iam:PassRole" ], "smithy.api#documentation": "Creates a studio component resource.
", "smithy.api#http": { @@ -930,6 +931,26 @@ "smithy.api#documentation": "The type of the studio component.
", "smithy.api#required": {} } + }, + "secureInitializationRoleArn": { + "target": "com.amazonaws.nimble#RoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
", + "smithy.api#tags": [ + "studio_component_roles" + ] + } + }, + "runtimeRoleArn": { + "target": "com.amazonaws.nimble#RoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
", + "smithy.api#tags": [ + "studio_component_roles" + ] + } } }, "traits": { @@ -955,7 +976,7 @@ "type": "structure", "members": { "adminRoleArn": { - "target": "com.amazonaws.nimble#String", + "target": "com.amazonaws.nimble#RoleArn", "traits": { "smithy.api#documentation": "The IAM role that Studio Admins will assume when logging in to the Nimble Studio\n portal.
", "smithy.api#required": {} @@ -999,7 +1020,7 @@ } }, "userRoleArn": { - "target": "com.amazonaws.nimble#String", + "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.
", @@ -1730,10 +1751,7 @@ }, "traits": { "aws.api#arn": { - "template": "eula-acceptance/{eulaAcceptanceId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "eula-acceptance/{eulaAcceptanceId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", @@ -1792,10 +1810,7 @@ }, "traits": { "aws.api#arn": { - "template": "eula/{eulaId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "eula/{eulaId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", @@ -1927,6 +1942,8 @@ "smithy.waiters#waitable": { "LaunchProfileReady": { "documentation": "Wait until a LaunchProfile is Ready. Use this after invoking CreateLaunchProfile or UpdateLaunchProfile", + "minDelay": 5, + "maxDelay": 750, "acceptors": [ { "state": "success", @@ -1958,12 +1975,12 @@ } } } - ], - "minDelay": 5, - "maxDelay": 750 + ] }, "LaunchProfileDeleted": { "documentation": "Wait until a LaunchProfile is Deleted. Use this after invoking DeleteLaunchProfile", + "minDelay": 5, + "maxDelay": 750, "acceptors": [ { "state": "success", @@ -1985,9 +2002,7 @@ } } } - ], - "minDelay": 5, - "maxDelay": 750 + ] } } } @@ -2478,6 +2493,8 @@ "smithy.api#readonly": {}, "smithy.waiters#waitable": { "StreamingSessionReady": { + "minDelay": 10, + "maxDelay": 1800, "documentation": "Wait until a StreamingSession is ready. Use this after invoking CreateStreamingSession, StartStreamingSession", "acceptors": [ { @@ -2510,11 +2527,11 @@ } } } - ], - "minDelay": 10, - "maxDelay": 1800 + ] }, "StreamingSessionStopped": { + "minDelay": 5, + "maxDelay": 900, "documentation": "Wait until a StreamingSessionStopped. Use this after invoking StopStreamingSession", "acceptors": [ { @@ -2537,11 +2554,11 @@ } } } - ], - "minDelay": 5, - "maxDelay": 900 + ] }, "StreamingSessionDeleted": { + "minDelay": 5, + "maxDelay": 900, "documentation": "Wait until a StreamingSessionDeleted. Use this after invoking Deletesession", "acceptors": [ { @@ -2564,9 +2581,7 @@ } } } - ], - "minDelay": 5, - "maxDelay": 900 + ] } } } @@ -2648,6 +2663,8 @@ "smithy.api#readonly": {}, "smithy.waiters#waitable": { "StreamingSessionStreamReady": { + "minDelay": 5, + "maxDelay": 150, "documentation": "Wait until a StreamingSessionStream is ready. Use this after invoking CreateStreamingSessionStream", "acceptors": [ { @@ -2670,9 +2687,7 @@ } } } - ], - "minDelay": 5, - "maxDelay": 150 + ] } } } @@ -2898,6 +2913,8 @@ ] }, "StudioComponentDeleted": { + "minDelay": 1, + "maxDelay": 120, "documentation": "Wait until a StudioComponent Deleted. Use this after invoking DeleteStudioComponent", "acceptors": [ { @@ -2920,8 +2937,7 @@ } } } - ], - "minDelay": 1 + ] } } } @@ -3370,6 +3386,24 @@ "traits": { "smithy.api#documentation": "The name for the studio component.
" } + }, + "secureInitializationRoleArn": { + "target": "com.amazonaws.nimble#RoleArn", + "traits": { + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
", + "smithy.api#tags": [ + "studio_component_roles" + ] + } + }, + "runtimeRoleArn": { + "target": "com.amazonaws.nimble#RoleArn", + "traits": { + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
", + "smithy.api#tags": [ + "studio_component_roles" + ] + } } }, "traits": { @@ -3532,16 +3566,13 @@ ], "traits": { "aws.api#arn": { - "template": "launch-profile/{launchProfileId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "launch-profile/{launchProfileId}" }, "aws.cloudformation#cfnResource": { + "name": "LaunchProfile", "additionalSchemas": [ "com.amazonaws.nimble#LaunchProfile" - ], - "name": "LaunchProfile" + ] }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", @@ -4031,8 +4062,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "members", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "members" }, "smithy.api#readonly": {} } @@ -4135,8 +4166,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "launchProfiles", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "launchProfiles" }, "smithy.api#readonly": {} } @@ -4328,7 +4359,7 @@ "nimble:ownedBy", "nimble:requesterPrincipalId" ], - "smithy.api#documentation": "Lists the streaming image resources in a studio.
", + "smithy.api#documentation": "Lists the streaming sessions in a studio.
", "smithy.api#http": { "method": "GET", "uri": "/2020-08-01/studios/{studioId}/streaming-sessions", @@ -4442,8 +4473,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "studioComponents", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "studioComponents" }, "smithy.api#readonly": {} } @@ -4548,8 +4579,8 @@ "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "members", - "pageSize": "maxResults" + "pageSize": "maxResults", + "items": "members" }, "smithy.api#readonly": {} } @@ -5064,6 +5095,15 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.nimble#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.nimble#ScriptParameterKey": { "type": "string", "traits": { @@ -5469,7 +5509,7 @@ "maxStoppedSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated by AWS (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped by AWS (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated by AWS (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped by AWS (instead of terminated).
Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the\n session will automatically be terminated (instead of stopped).
If the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time\n that a session stays in the READY state exceeds the\n maxSessionLengthInMinutes value, the session will automatically be\n stopped (instead of terminated).
The IAM role that studio admins assume when logging in to the Nimble Studio\n portal.
" @@ -6597,7 +6634,7 @@ } }, "userRoleArn": { - "target": "com.amazonaws.nimble#String", + "target": "com.amazonaws.nimble#RoleArn", "traits": { "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The IAM role that studio users assume when logging in to the Nimble Studio\n portal.
" @@ -6734,6 +6771,26 @@ "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The user ID of the user that most recently updated the resource.
" } + }, + "secureInitializationRoleArn": { + "target": "com.amazonaws.nimble#RoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
", + "smithy.api#tags": [ + "studio_component_roles" + ] + } + }, + "runtimeRoleArn": { + "target": "com.amazonaws.nimble#RoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
", + "smithy.api#tags": [ + "studio_component_roles" + ] + } } }, "traits": { @@ -6901,16 +6958,13 @@ }, "traits": { "aws.api#arn": { - "template": "studio-component/{studioComponentId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "studio-component/{studioComponentId}" }, "aws.cloudformation#cfnResource": { + "name": "StudioComponent", "additionalSchemas": [ "com.amazonaws.nimble#StudioComponent" - ], - "name": "StudioComponent" + ] }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", @@ -7337,16 +7391,13 @@ ], "traits": { "aws.api#arn": { - "template": "studio/{studioId}", - "absolute": false, - "noAccount": false, - "noRegion": false + "template": "studio/{studioId}" }, "aws.cloudformation#cfnResource": { + "name": "Studio", "additionalSchemas": [ "com.amazonaws.nimble#Studio" - ], - "name": "Studio" + ] }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}", @@ -8110,7 +8161,8 @@ "aws.iam#requiredActions": [ "ec2:DescribeSecurityGroups", "fsx:DescribeFileSystems", - "ds:DescribeDirectories" + "ds:DescribeDirectories", + "iam:PassRole" ], "smithy.api#documentation": "Updates a studio component resource.
", "smithy.api#http": { @@ -8195,6 +8247,26 @@ "traits": { "smithy.api#documentation": "The type of the studio component.
" } + }, + "secureInitializationRoleArn": { + "target": "com.amazonaws.nimble#RoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to AWS resources when the system initialization script runs.
", + "smithy.api#tags": [ + "studio_component_roles" + ] + } + }, + "runtimeRoleArn": { + "target": "com.amazonaws.nimble#RoleArn", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "An IAM role attached to a Studio Component that gives the studio component access to AWS resources at anytime while the instance is running.
", + "smithy.api#tags": [ + "studio_component_roles" + ] + } } } }, @@ -8213,7 +8285,7 @@ "type": "structure", "members": { "adminRoleArn": { - "target": "com.amazonaws.nimble#String", + "target": "com.amazonaws.nimble#RoleArn", "traits": { "smithy.api#documentation": "The IAM role that Studio Admins will assume when logging in to the Nimble Studio\n portal.
" } @@ -8242,7 +8314,7 @@ } }, "userRoleArn": { - "target": "com.amazonaws.nimble#String", + "target": "com.amazonaws.nimble#RoleArn", "traits": { "smithy.api#documentation": "The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.
" } @@ -8342,76 +8414,76 @@ "traits": { "aws.api#service": { "sdkId": "nimble", - "arnNamespace": "nimble", "cloudFormationName": "NimbleStudio", - "cloudTrailEventSource": "nimble.amazonaws.com", - "endpointPrefix": "nimble" + "arnNamespace": "nimble", + "cloudTrailEventSource": "nimble.amazonaws.com" }, "aws.auth#sigv4": { "name": "nimble" }, "aws.iam#defineConditionKeys": { - "nimble:ownedBy": { + "aws:ResourceTag/${TagKey}": { "type": "String", - "documentation": "Filters access by the ownedBy request parameter or the ID of the owner of the resource", - "externalDocumentation": "${ContextKeysDocRoot}" + "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" }, - "nimble:principalId": { + "aws:RequestTag/${TagKey}": { "type": "String", - "documentation": "Filters access by the principalId request parameter", - "externalDocumentation": "${ContextKeysDocRoot}" + "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" }, - "nimble:createdBy": { - "type": "String", - "documentation": "Filters access by the createdBy request parameter or the ID of the creator of the resource", - "externalDocumentation": "${ContextKeysDocRoot}" + "aws:TagKeys": { + "type": "ArrayOfString", + "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" }, "nimble:studioId": { "type": "String", "documentation": "Filters access by a specific studio", "externalDocumentation": "${ContextKeysDocRoot}" }, - "aws:RequestTag/${TagKey}": { + "nimble:requesterPrincipalId": { "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" + "documentation": "Filters access by the ID of the logged in user", + "externalDocumentation": "${ContextKeysDocRoot}" }, - "aws:TagKeys": { + "nimble:principalId": { "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" + "documentation": "Filters access by the principalId request parameter", + "externalDocumentation": "${ContextKeysDocRoot}" }, - "nimble:requesterPrincipalId": { + "nimble:createdBy": { "type": "String", - "documentation": "Filters access by the ID of the logged in user", + "documentation": "Filters access by the createdBy request parameter or the ID of the creator of the resource", "externalDocumentation": "${ContextKeysDocRoot}" }, - "aws:ResourceTag/${TagKey}": { + "nimble:ownedBy": { "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" + "documentation": "Filters access by the ownedBy request parameter or the ID of the owner of the resource", + "externalDocumentation": "${ContextKeysDocRoot}" } }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ + "*", + "content-type", "authorization", + "x-amz-date", "x-amz-content-sha256", + "x-amz-user-agent", "x-amzn-trace-id", - "x-amz-date", - "x-api-key", + "x-amz-dryrun", "x-amz-client-token", - "x-amz-user-agent", - "*", - "content-type", - "x-amz-dryrun" + "x-api-key" ], "additionalExposedHeaders": [ - "x-amz-apigw-id", - "x-amzn-trace-id", "x-amzn-errortype", - "x-amzn-requestid" - ] + "x-amzn-requestid", + "x-amzn-trace-id", + "x-amz-apigw-id" + ], + "maxAge": 600 }, "smithy.api#documentation": "Welcome to the Amazon Nimble Studio API reference. This API reference provides\n methods, schema, resources, parameters, and more to help you get the most out of Nimble\n Studio.
\nNimble Studio is a virtual studio that empowers visual effects, animation, and\n interactive content teams to create content securely within a scalable, private cloud\n service.
", "smithy.api#title": "AmazonNimbleStudio" @@ -8453,4 +8525,4 @@ ] } } -} +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/outposts.json b/codegen/sdk/aws-models/outposts.json index cdfb6761095..d7fcac60cf7 100644 --- a/codegen/sdk/aws-models/outposts.json +++ b/codegen/sdk/aws-models/outposts.json @@ -587,9 +587,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 255 + "max": 1024 }, - "smithy.api#pattern": "^([\\w-]+)$" + "smithy.api#pattern": "^[a-zA-Z0-9+/=]{1,1024}$" } }, "com.amazonaws.outposts#ContactName": { @@ -1599,12 +1599,50 @@ "traits": { "smithy.api#documentation": "The status of the line item.
" } + }, + "ShipmentInformation": { + "target": "com.amazonaws.outposts#ShipmentInformation", + "traits": { + "smithy.api#documentation": "\n Information about a line item shipment.\n
" + } + }, + "AssetInformationList": { + "target": "com.amazonaws.outposts#LineItemAssetInformationList", + "traits": { + "smithy.api#documentation": "\n Information about assets.\n
" + } } }, "traits": { "smithy.api#documentation": "Information about a line item.
" } }, + "com.amazonaws.outposts#LineItemAssetInformation": { + "type": "structure", + "members": { + "AssetId": { + "target": "com.amazonaws.outposts#AssetId", + "traits": { + "smithy.api#documentation": "\n The ID of the asset.\n
" + } + }, + "MacAddressList": { + "target": "com.amazonaws.outposts#MacAddressList", + "traits": { + "smithy.api#documentation": "\n MAC addresses of the asset.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Information about a line item asset.\n
" + } + }, + "com.amazonaws.outposts#LineItemAssetInformationList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#LineItemAssetInformation" + } + }, "com.amazonaws.outposts#LineItemId": { "type": "string", "traits": { @@ -2163,6 +2201,22 @@ } } }, + "com.amazonaws.outposts#MacAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 17, + "max": 17 + }, + "smithy.api#pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + } + }, + "com.amazonaws.outposts#MacAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.outposts#MacAddress" + } + }, "com.amazonaws.outposts#MaxResults1000": { "type": "integer", "traits": { @@ -2934,6 +2988,49 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.outposts#ShipmentCarrier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DHL", + "name": "DHL" + }, + { + "value": "DBS", + "name": "DBS" + }, + { + "value": "FEDEX", + "name": "FEDEX" + }, + { + "value": "UPS", + "name": "UPS" + } + ] + } + }, + "com.amazonaws.outposts#ShipmentInformation": { + "type": "structure", + "members": { + "ShipmentTrackingNumber": { + "target": "com.amazonaws.outposts#TrackingId", + "traits": { + "smithy.api#documentation": "\n The tracking number of the shipment.\n
" + } + }, + "ShipmentCarrier": { + "target": "com.amazonaws.outposts#ShipmentCarrier", + "traits": { + "smithy.api#documentation": "\n The carrier of the shipment. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Information about a line item shipment.\n
" + } + }, "com.amazonaws.outposts#Site": { "type": "structure", "members": { @@ -3319,6 +3416,16 @@ "smithy.api#pattern": "^(\\d+)##(\\S+)$" } }, + "com.amazonaws.outposts#TrackingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 42 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, "com.amazonaws.outposts#UnderlayIpAddress": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/redshift-serverless.json b/codegen/sdk/aws-models/redshift-serverless.json index f06d6905876..c5f8b4870eb 100644 --- a/codegen/sdk/aws-models/redshift-serverless.json +++ b/codegen/sdk/aws-models/redshift-serverless.json @@ -2572,7 +2572,7 @@ ], "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
\nThis 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
\nAmazon 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#documentation": "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
\nAmazon 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", diff --git a/codegen/sdk/aws-models/redshift.json b/codegen/sdk/aws-models/redshift.json index 5c6b4710ad0..1948ee69838 100644 --- a/codegen/sdk/aws-models/redshift.json +++ b/codegen/sdk/aws-models/redshift.json @@ -726,6 +726,9 @@ }, { "target": "com.amazonaws.redshift#LimitExceededFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -738,8 +741,13 @@ "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the snapshot the account is authorized to restore.
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the snapshot the account is authorized to restore.
" + } + }, + "SnapshotArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot to authorize access to.
" } }, "SnapshotClusterIdentifier": { @@ -2645,7 +2653,7 @@ "ElasticIp": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The Elastic IP (EIP) address for the cluster.
\nConstraints: The cluster must be provisioned in EC2-VPC and publicly-accessible\n through an Internet gateway. For more information about provisioning clusters in\n EC2-VPC, go to Supported\n Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
" + "smithy.api#documentation": "The Elastic IP (EIP) address for the cluster. You don't have to specify the EIP for a \n publicly accessible cluster with AvailabilityZoneRelocation turned on.
\nConstraints: The cluster must be provisioned in EC2-VPC and publicly-accessible\n through an Internet gateway. For more information about provisioning clusters in\n EC2-VPC, go to Supported\n Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
" } }, "Tags": { @@ -5013,6 +5021,9 @@ }, { "target": "com.amazonaws.redshift#InvalidTagFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -5077,6 +5088,12 @@ "smithy.api#documentation": "The snapshot identifier of the snapshot about which to return\n information.
" } }, + "SnapshotArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.
" + } + }, "SnapshotType": { "target": "com.amazonaws.redshift#String", "traits": { @@ -6184,6 +6201,9 @@ }, { "target": "com.amazonaws.redshift#InvalidClusterSnapshotStateFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -6218,6 +6238,12 @@ "smithy.api#documentation": "The identifier of the snapshot to evaluate for possible node configurations.
" } }, + "SnapshotArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
" + } + }, "OwnerAccount": { "target": "com.amazonaws.redshift#String", "traits": { @@ -12619,8 +12645,13 @@ "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The name of the snapshot from which to create the new cluster. This parameter isn't\n case sensitive.
\nExample: my-snapshot-id\n
The name of the snapshot from which to create the new cluster. This parameter isn't\n case sensitive.
\nExample: my-snapshot-id\n
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster.
" } }, "SnapshotClusterIdentifier": { @@ -12680,7 +12711,7 @@ "ElasticIp": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The elastic IP (EIP) address for the cluster.
" + "smithy.api#documentation": "The elastic IP (EIP) address for the cluster. You don't have to specify the EIP for a \n publicly accessible cluster with AvailabilityZoneRelocation turned on.
" } }, "ClusterParameterGroupName": { @@ -13196,6 +13227,9 @@ }, { "target": "com.amazonaws.redshift#ClusterSnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" } ], "traits": { @@ -13208,8 +13242,13 @@ "SnapshotIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the snapshot that the account can no longer access.
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the snapshot that the account can no longer access.
" + } + }, + "SnapshotArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke access.
" } }, "SnapshotClusterIdentifier": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index f8b92dcaadc..7af4bc8a128 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -3320,7 +3320,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 20 + "max": 30 } } }, @@ -4418,7 +4418,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 20 + "max": 30 } } }, @@ -20770,6 +20770,69 @@ } } }, + "com.amazonaws.sagemaker#InstanceGroup": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.sagemaker#TrainingInstanceType", + "traits": { + "smithy.api#documentation": "Specifies the instance type of the instance group.
", + "smithy.api#required": {} + } + }, + "InstanceCount": { + "target": "com.amazonaws.sagemaker#TrainingInstanceCount", + "traits": { + "smithy.api#documentation": "Specifies the number of instances of the instance group.
", + "smithy.api#required": {} + } + }, + "InstanceGroupName": { + "target": "com.amazonaws.sagemaker#InstanceGroupName", + "traits": { + "smithy.api#documentation": "Specifies the name of the instance group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Defines an instance group for heterogeneous cluster training. \n When requesting a training job using the CreateTrainingJob API, \n you can configure multiple instance groups .
" + } + }, + "com.amazonaws.sagemaker#InstanceGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.sagemaker#InstanceGroupNames": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InstanceGroupName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#InstanceGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#InstanceGroup" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.sagemaker#InstanceMetadataServiceConfiguration": { "type": "structure", "members": { @@ -21136,7 +21199,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 20 + "max": 30 } } }, @@ -31119,7 +31182,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.
\nYou can specify a maximum of 20 hyperparameters that a hyperparameter tuning job\n can search over. Every possible value of a categorical parameter range counts\n against this limit.
\nSpecifies ranges of integer, continuous, and categorical hyperparameters that a\n hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs\n with hyperparameter values within these ranges to find the combination of values that\n result in the training job with the best performance as measured by the objective metric\n of the hyperparameter tuning job.
\nThe maximum number of items specified for Array Members refers to\n the maximum number of hyperparameters for each range and also the maximum for the\n hyperparameter tuning job itself. That is, the sum of the number of hyperparameters\n for all the ranges can't exceed the maximum number specified.
The ML compute instance type.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ML compute instance type.
" } }, "InstanceCount": { "target": "com.amazonaws.sagemaker#TrainingInstanceCount", "traits": { - "smithy.api#documentation": "The number of ML compute instances to use. For distributed training, provide a\n value greater than 1.
", - "smithy.api#required": {} + "smithy.api#documentation": "The number of ML compute instances to use. For distributed training, provide a\n value greater than 1.
" } }, "VolumeSizeInGB": { @@ -35087,6 +35220,12 @@ "traits": { "smithy.api#documentation": "The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML\n compute instance(s) that run the training job.
\nCertain Nitro-based instances include local storage, dependent on the instance\n type. Local storage volumes are encrypted using a hardware module on the instance.\n You can't request a VolumeKmsKeyId when using an instance type with\n local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
\nFor more information about local instance storage encryption, see SSD\n Instance Store Volumes.
\nThe VolumeKmsKeyId can be in any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The configuration of a heterogeneous cluster in JSON format.
" + } } }, "traits": { @@ -35511,6 +35650,12 @@ "traits": { "smithy.api#documentation": "A list of one or more attribute names to use that are found in a specified augmented\n manifest file.
" } + }, + "InstanceGroupNames": { + "target": "com.amazonaws.sagemaker#InstanceGroupNames", + "traits": { + "smithy.api#documentation": "A list of names of instance groups that get data \n from the S3 data source.
" + } } }, "traits": { @@ -38895,7 +39040,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1 + "min": 0 } } }, diff --git a/gradle.properties b/gradle.properties index 58e33c1f957..220e089ec84 100644 --- a/gradle.properties +++ b/gradle.properties @@ -12,7 +12,7 @@ sdkVersion=0.17.0-SNAPSHOT smithyVersion=1.22.0 smithyGradleVersion=0.5.3 # smithy-kotlin codegen and runtime are versioned together -smithyKotlinVersion=0.12.0-SNAPSHOT +smithyKotlinVersion=0.12.0 # kotlin kotlinVersion=1.7.0