diff --git a/.github/workflows/kat-transform.yml b/.github/workflows/kat-transform.yml new file mode 100644 index 00000000000..6608dfae8b4 --- /dev/null +++ b/.github/workflows/kat-transform.yml @@ -0,0 +1,66 @@ +name: Kat Transform + +on: + pull_request: + types: [ opened, synchronize, reopened, labeled, unlabeled ] + branches: [ main ] + +# Allow one instance of this workflow per pull request, and cancel older runs when new changes are pushed +concurrency: + group: kat-pr-${{ github.ref }} + cancel-in-progress: true + +permissions: + id-token: write + contents: read + +env: + RUN: ${{ github.run_id }}-${{ github.run_number }} + GRADLE_OPTS: "-Dorg.gradle.daemon=false -Dkotlin.incremental=false" + +jobs: + verify-transform: + runs-on: ubuntu-latest + steps: + - name: Checkout sources + uses: actions/checkout@v4 + with: + path: 'aws-sdk-kotlin' + + - name: Setup Build + uses: ./aws-sdk-kotlin/.github/actions/setup-build + + - name: Configure AWS Credentials + uses: aws-actions/configure-aws-credentials@v4 + with: + role-to-assume: ${{ secrets.CI_AWS_ROLE_ARN }} + aws-region: us-west-2 + + - name: Setup kat + uses: awslabs/aws-kotlin-repo-tools/.github/actions/setup-kat@main + + - name: Build + working-directory: ./aws-sdk-kotlin + shell: bash + run: | + pwd + ls -lsa + kat bump-version # Bump from `vNext-SNAPSHOT` to `vNext`. kat transform only works on non-SNAPSHOT versions + ./gradlew build + ./gradlew publishAllPublicationsToTestLocalRepository + + - name: Transform + working-directory: ./aws-sdk-kotlin + shell: bash + run: | + pwd + ls -lsa + kat brazil transform -i ./build/m2 -o ./transformed -t .brazil.json -v live -m ./codegen/sdk/packages.json + + # Check for manifest file + if [ ! -f "./transformed/brazil-import-manifest.json" ]; then + echo "Error: brazil-import-manifest.json not found in the transformed artifact" + exit 1 + fi + + echo "Transformation succeeded!" diff --git a/CHANGELOG.md b/CHANGELOG.md index 67294e652c9..5cdd3c70bd8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,225 @@ # Changelog +## [1.3.58] - 10/21/2024 + +### Features +* (**applicationinsights**) This feature enables customers to specify SNS Topic ARN. CloudWatch Application Insights (CWAI) will utilize this ARN to send problem notifications. +* (**autoscaling**) Adds support for removing the PlacementGroup setting on an Auto Scaling Group through the UpdateAutoScalingGroup API. +* (**bedrockagentruntime**) Knowledge Bases for Amazon Bedrock now supports custom prompts and model parameters in the orchestrationConfiguration of the RetrieveAndGenerate API. The modelArn field accepts Custom Models and Imported Models ARNs. +* (**databasemigrationservice**) Added support for tagging in StartReplicationTaskAssessmentRun API and introduced IsLatestTaskAssessmentRun and ResultStatistic fields for enhanced tracking and assessment result statistics. +* (**ec2**) Amazon EC2 now allows you to create network interfaces with just the EFA driver and no ENA driver by specifying the network interface type as efa-only. +* (**eks**) This release adds support for Amazon Application Recovery Controller (ARC) zonal shift and zonal autoshift with EKS that enhances the resiliency of multi-AZ cluster environments +* (**fms**) Update AWS WAF policy - add the option to retrofit existing web ACLs instead of creating all new web ACLs. +* (**paymentcryptographydata**) Adding new API to generate authenticated scripts for EMV pin change use cases. +* (**wafv2**) Add a property to WebACL to indicate whether it's been retrofitted by Firewall Manager. + +## [1.3.57] - 10/18/2024 + +### Features +* (**athena**) Removing FEDERATED from Create/List/Delete/GetDataCatalog API +* (**bedrock**) Adding converse support to CMI API's +* (**bedrockruntime**) Added converse support for custom imported models +* (**datazone**) Adding the following project member designations: PROJECT_CATALOG_VIEWER, PROJECT_CATALOG_CONSUMER and PROJECT_CATALOG_STEWARD in the CreateProjectMembership API and PROJECT_CATALOG_STEWARD designation in the AddPolicyGrant API. +* (**ec2**) RequestSpotInstances and RequestSpotFleet feature release. + +## [1.3.56] - 10/17/2024 + +### Features +* (**bedrockagent**) Removing support for topK property in PromptModelInferenceConfiguration object, Making PromptTemplateConfiguration property as required, Limiting the maximum PromptVariant to 1 +* (**dataexchange**) This release adds Data Grant support, through which customers can programmatically create data grants to share with other AWS accounts and accept data grants from other AWS accounts. +* (**pinpointsmsvoicev2**) Added the registrations status of REQUIRES_AUTHENTICATION +* (**pipes**) This release adds validation to require specifying a SecurityGroup and Subnets in the Vpc object under PipesSourceSelfManagedKafkaParameters. It also adds support for iso-e, iso-f, and other non-commercial partitions in ARN parameters. +* (**quicksight**) Add StartDashboardSnapshotJobSchedule API. RestoreAnalysis now supports restoring analysis to folders. +* (**workspaces**) Updated the DomainName pattern for Active Directory + +### Documentation +* (**ecs**) This is an Amazon ECS documentation only update to address tickets. +* (**rds**) Updates Amazon RDS documentation for TAZ IAM support + +### Miscellaneous +* Upgrade to Kotlin 2.0.21 + +## [1.3.55] - 10/16/2024 + +### Features +* (**s3**) Add support for the new optional bucket-region and prefix query parameters in the ListBuckets API. For ListBuckets requests that express pagination, Amazon S3 will now return both the bucket names and associated AWS regions in the response. + +## [1.3.54] - 10/15/2024 + +### Features +* (**amplify**) Added sourceUrlType field to StartDeployment request +* (**codebuild**) Enable proxy for reserved capacity fleet. +* (**ivs**) On a channel that you own, you can now replace an ongoing stream with a new stream by streaming up with the priority parameter appended to the stream key. +* (**qbusiness**) Amazon Q Business now supports embedding the Amazon Q Business web experience on third-party websites. +* (**redshift**) This release launches the CreateIntegration, DeleteIntegration, DescribeIntegrations and ModifyIntegration APIs to create and manage Amazon Redshift Zero-ETL Integrations. +* (**resiliencehub**) AWS Resilience Hub now integrates with the myApplications platform, enabling customers to easily assess the resilience of applications defined in myApplications. The new Resiliency widget provides visibility into application resilience and actionable recommendations for improvement. +* (**sesv2**) This release adds support for email maximum delivery seconds that allows senders to control the time within which their emails are attempted for delivery. +* (**transcribestreaming**) We are expanding support for 40 new locales in AWS Transcribe Streaming. + +### Documentation +* (**cloudformation**) Documentation update for AWS CloudFormation API Reference. + +## [1.3.53] - 10/14/2024 + +### Features +* (**codepipeline**) AWS CodePipeline V2 type pipelines now support automatically retrying failed stages and skipping stage for failed entry conditions. +* (**mailmanager**) Mail Manager support for viewing and exporting metadata of archived messages. +* (**securitylake**) This release updates request validation regex for resource ARNs. +* (**supplychain**) This release adds AWS Supply Chain instance management functionality. Specifically adding CreateInstance, DeleteInstance, GetInstance, ListInstances, and UpdateInstance APIs. +* (**transfer**) This release enables customers using SFTP connectors to query the transfer status of their files to meet their monitoring needs as well as orchestrate post transfer actions. + +### Fixes +* ⚠️ **IMPORTANT**: Update to the latest S3 model, which correctly models `ReplicationRuleFilter` and `LifecycleRuleFilter` as structures (not unions). This may cause compilation failures in existing code which references these two shapes. + +## [1.3.52] - 10/11/2024 + +### Features +* (**elasticloadbalancingv2**) Add zonal_shift.config.enabled attribute. Add new AdministrativeOverride construct in the describe-target-health API response to include information about the override status applied to a target. +* (**emr**) This release provides new parameter "Context" in instance fleet clusters. +* (**guardduty**) Added a new field for network connection details. + +### Fixes +* [#1433](https://github.com/awslabs/aws-sdk-kotlin/issues/1433) Remove Route53 InvalidChangeBatch error response customization + +### Documentation +* (**appflow**) Doc only updates for clarification around OAuth2GrantType for Salesforce. +* (**robomaker**) Documentation update: added support notices to each API action. + +## [1.3.51] - 10/10/2024 + +### Features +* (**databasemigrationservice**) Introduces DescribeDataMigrations, CreateDataMigration, ModifyDataMigration, DeleteDataMigration, StartDataMigration, StopDataMigration operations to SDK. Provides FailedDependencyFault error message. +* (**ec2**) This release adds support for assigning the billing of shared Amazon EC2 On-Demand Capacity Reservations. +* (**iotfleetwise**) Refine campaign related API validations +* (**neptunegraph**) Support for 16 m-NCU graphs available through account allowlisting +* (**outposts**) Adding new "DELIVERED" enum value for Outposts Order status +* (**route53resolver**) Route 53 Resolver Forwarding Rules can now include a server name indication (SNI) in the target address for rules that use the DNS-over-HTTPS (DoH) protocol. When a DoH-enabled Outbound Resolver Endpoint forwards a request to a DoH server, it will provide the SNI in the TLS handshake. +* (**socialmessaging**) This release for AWS End User Messaging includes a public SDK, providing a suite of APIs that enable sending WhatsApp messages to end users. +* (**timestreaminfluxdb**) This release updates our regex based validation rules in regards to valid DbInstance and DbParameterGroup name. + +### Documentation +* (**acmpca**) Documentation updates for AWS Private CA. +* (**ecs**) This is a documentation only release that updates to documentation to let customers know that Amazon Elastic Inference is no longer available. +* (**elasticinference**) Elastic Inference - Documentation update to add service shutdown notice. + +## [1.3.50] - 10/09/2024 + +### Features +* (**codepipeline**) AWS CodePipeline introduces a Compute category + +## [1.3.49] - 10/08/2024 + +### Features +* (**elasticache**) AWS ElastiCache SDK now supports using APIs with newly launched Valkey engine. Please refer to updated AWS ElastiCache public documentation for detailed information on API usage. +* (**memorydb**) Amazon MemoryDB SDK now supports all APIs for newly launched Valkey engine. Please refer to the updated Amazon MemoryDB public documentation for detailed information on API usage. + +### Miscellaneous +* Upgrade to Smithy 1.51.0 + +## [1.3.48] - 10/07/2024 + +### Features +* (**deadline**) Add support for using the template from a previous job during job creation and listing parameter definitions for a job. +* (**qconnect**) This release adds support for the following capabilities: Configuration of the Gen AI system via AIAgent and AIPrompts. Integration support for Bedrock Knowledge Base. +* (**redshift**) Add validation pattern to S3KeyPrefix on the EnableLogging API + +### Documentation +* (**marketplacereporting**) Documentation-only update for AWS Marketplace Reporting API. + +## [1.3.47] - 10/04/2024 + +### Features +* (**ec2**) Documentation updates for Amazon EC2. +* (**iotdataplane**) Add v2 smoke tests and smithy smokeTests trait for SDK testing. + +## [1.3.46] - 10/03/2024 + +### Features +* (**codepipeline**) AWS CodePipeline introduces Commands action that enables you to easily run shell commands as part of your pipeline execution. +* (**connect**) Public GetMetricDataV2 Grouping increase from 3 to 4 +* (**ec2**) This release includes a new API for modifying instance cpu-options after launch. +* (**iot**) This release adds support for Custom Authentication with X.509 Client Certificates, support for Custom Client Certificate validation, and support for selecting application protocol and authentication type without requiring TLS ALPN for customer's AWS IoT Domain Configurations. +* (**marketplacereporting**) The AWS Marketplace Reporting service introduces the GetBuyerDashboard API. This API returns a dashboard that provides visibility into your organization's AWS Marketplace agreements and associated spend across the AWS accounts in your organization. +* (**mediapackagev2**) Added support for ClipStartTime on the FilterConfiguration object on OriginEndpoint manifest settings objects. Added support for EXT-X-START tags on produced HLS child playlists. +* (**quicksight**) QuickSight: Add support for exporting and importing folders in AssetBundle APIs + +## [1.3.45] - 10/02/2024 + +### Features +* (**appstream**) Added support for Automatic Time Zone Redirection on Amazon AppStream 2.0 +* (**b2bi**) Added and updated APIs to support outbound EDI transformations +* (**bedrockagentruntime**) Added raw model response and usage metrics to PreProcessing and PostProcessing Trace +* (**bedrockruntime**) Added new fields to Amazon Bedrock Guardrails trace +* (**iotdeviceadvisor**) Add clientToken attribute and implement idempotency for CreateSuiteDefinition. +* (**ivsrealtime**) Adds new Stage Health EventErrorCodes applicable to RTMP(S) broadcasts. Bug Fix: Enforces that EncoderConfiguration Video height and width must be even-number values. +* (**s3**) This release introduces a header representing the minimum object size limit for Lifecycle transitions. +* (**sagemaker**) releasing builtinlcc to public + +### Documentation +* (**workspaces**) WSP is being rebranded to become DCV. + +## [1.3.44] - 10/01/2024 + +### Features +* (**bedrockagent**) This release adds support to stop an ongoing ingestion job using the StopIngestionJob API in Agents for Amazon Bedrock. +* (**codeartifact**) Add support for the dual stack endpoints. +* (**rds**) This release provides additional support for enabling Aurora Limitless Database DB clusters. + +## [1.3.43] - 09/30/2024 + +### Features +* (**bedrock**) Add support for custom models via provisioned throughput for Bedrock Model Evaluation +* (**connect**) Amazon Connect introduces StartOutboundChatContact API allowing customers to initiate outbound chat contacts +* (**resourcegroups**) This update includes new APIs to support application groups and to allow users to manage resource tag-sync tasks in applications. +* (**supplychain**) Release DataLakeDataset, DataIntegrationFlow and ResourceTagging APIs for AWS Supply Chain +* (**timestreaminfluxdb**) Timestream for InfluxDB now supports port configuration and additional customer-modifiable InfluxDB v2 parameters. This release adds Port to the CreateDbInstance and UpdateDbInstance API, and additional InfluxDB v2 parameters to the CreateDbParameterGroup API. + +### Documentation +* (**clouddirectory**) Add examples for API operations in model. +* (**pricing**) Add examples for API operations in model. +* (**verifiedpermissions**) Add examples for API operations in model. + +## [1.3.42] - 09/27/2024 + +### Features +* (**customerprofiles**) Introduces optional RoleArn parameter for PutIntegration request and includes RoleArn in the response of PutIntegration, GetIntegration and ListIntegrations +* (**quicksight**) Adding personalization in QuickSight data stories. Admins can enable or disable personalization through QuickSight settings. +* (**sesv2**) This release adds support for engagement tracking over Https using custom domains. + +### Documentation +* (**securityhub**) Documentation updates for AWS Security Hub + +### Miscellaneous +* Remove WorkLink service + +## [1.3.41] - 09/26/2024 + +### Features +* (**chatbot**) Return State and StateReason fields for Chatbot Channel Configurations. +* (**lambda**) Reverting Lambda resource-based policy and block public access APIs. +* (**organizations**) Add support for policy operations on the CHATBOT_POLICY policy type. +* (**sagemaker**) Adding `TagPropagation` attribute to Sagemaker API + +### Documentation +* (**pcs**) AWS PCS API documentation - Edited the description of the iamInstanceProfileArn parameter of the CreateComputeNodeGroup and UpdateComputeNodeGroup actions; edited the description of the SlurmCustomSetting data type to list the supported parameters for clusters and compute node groups. +* (**rdsdata**) Documentation update for RDS Data API to reflect support for Aurora MySQL Serverless v2 and Provisioned DB clusters. + +## [1.3.40] - 09/25/2024 + +### Documentation +* (**cloudtrail**) Doc-only update for CloudTrail network activity events release (in preview) +* (**ec2**) Updates to documentation for the transit gateway security group referencing feature. +* (**fsx**) Doc-only update to address Lustre S3 hard-coded names. + +## [1.3.39] - 09/24/2024 + +### Features +* (**bedrock**) Add support for Cross Region Inference in Bedrock Model Evaluations. +* (**budgets**) Releasing minor partitional endpoint updates +* (**kinesis**) This release includes support to add tags when creating a stream +* (**pinpointsmsvoicev2**) AWS End User Messaging SMS-Voice V2 has added support for resource policies. Use the three new APIs to create, view, edit, and delete resource policies. +* (**sagemaker**) Adding `HiddenInstanceTypes` and `HiddenSageMakerImageVersionAliases` attribute to SageMaker API + ## [1.3.38] - 09/23/2024 ### Features diff --git a/aws-runtime/aws-config/build.gradle.kts b/aws-runtime/aws-config/build.gradle.kts index 8a0ee866369..7a7f1938e1e 100644 --- a/aws-runtime/aws-config/build.gradle.kts +++ b/aws-runtime/aws-config/build.gradle.kts @@ -14,7 +14,7 @@ plugins { description = "Support for AWS configuration" extra["moduleName"] = "aws.sdk.kotlin.runtime.config" -apply(plugin = "kotlinx-atomicfu") +apply(plugin = "org.jetbrains.kotlinx.atomicfu") kotlin { sourceSets { diff --git a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/ConfigSection.kt b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/ConfigSection.kt index 35596e0b017..87a471691a3 100644 --- a/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/ConfigSection.kt +++ b/aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/config/profile/ConfigSection.kt @@ -8,6 +8,7 @@ package aws.sdk.kotlin.runtime.config.profile import aws.sdk.kotlin.runtime.InternalSdkApi @InternalSdkApi +@ExposedCopyVisibility // FIXME Change to @ConsistentCopyVisibility in 1.4.x minor version bump public data class ConfigSection internal constructor( public val name: String, internal val properties: Map, diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/route53/ChangeResourceRecordSetsUnmarshallingIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/route53/ChangeResourceRecordSetsUnmarshallingIntegration.kt deleted file mode 100644 index b2fccd7a54b..00000000000 --- a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/customization/route53/ChangeResourceRecordSetsUnmarshallingIntegration.kt +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ -package aws.sdk.kotlin.codegen.customization.route53 - -import aws.sdk.kotlin.codegen.sdkId -import software.amazon.smithy.kotlin.codegen.KotlinSettings -import software.amazon.smithy.kotlin.codegen.aws.protocols.core.AwsHttpBindingProtocolGenerator -import software.amazon.smithy.kotlin.codegen.core.getContextValue -import software.amazon.smithy.kotlin.codegen.core.withBlock -import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration -import software.amazon.smithy.kotlin.codegen.integration.SectionWriterBinding -import software.amazon.smithy.kotlin.codegen.model.expectShape -import software.amazon.smithy.model.Model -import software.amazon.smithy.model.shapes.ServiceShape -import software.amazon.smithy.model.shapes.ShapeId - -class ChangeResourceRecordSetsUnmarshallingIntegration : KotlinIntegration { - private val targetErrorShapeId = ShapeId.from("com.amazonaws.route53#InvalidChangeBatch") - - override val sectionWriters: List = listOf( - SectionWriterBinding(AwsHttpBindingProtocolGenerator.Sections.ProtocolErrorDeserialization) { writer, prevValue -> - val op = writer.getContextValue(AwsHttpBindingProtocolGenerator.Sections.RenderThrowOperationError.Operation) - - if (op.errors.any { it == targetErrorShapeId }) { - writer.withBlock("payload?.let {", "}") { - withBlock("aws.sdk.kotlin.services.route53.internal.parseRestXmlInvalidChangeBatchResponse(payload)?.let {", "}") { - write("setAseErrorMetadata(it.exception, wrappedResponse, it.errorDetails)") - write("throw it.exception") - } - } - writer.write("") - } else { - writer.write(prevValue) - } - }, - ) - - override fun enabledForService(model: Model, settings: KotlinSettings) = - model.expectShape(settings.service).sdkId.equals("route 53", ignoreCase = true) -} diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsDenyListIntegration.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsDenyListIntegration.kt new file mode 100644 index 00000000000..66d5196b2f3 --- /dev/null +++ b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsDenyListIntegration.kt @@ -0,0 +1,37 @@ +package aws.sdk.kotlin.codegen.smoketests + +import software.amazon.smithy.kotlin.codegen.KotlinSettings +import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration +import software.amazon.smithy.kotlin.codegen.integration.SectionWriter +import software.amazon.smithy.kotlin.codegen.integration.SectionWriterBinding +import software.amazon.smithy.kotlin.codegen.rendering.smoketests.SmokeTestsRunner +import software.amazon.smithy.model.Model + +/** + * Will wipe the smoke test runner file for services that are deny listed. + * + * Some services model smoke tests incorrectly and the code generated file will not compile. + */ +class SmokeTestsDenyListIntegration : KotlinIntegration { + override fun enabledForService(model: Model, settings: KotlinSettings): Boolean = + settings.sdkId in smokeTestDenyList + + override val sectionWriters: List + get() = listOf( + SectionWriterBinding(SmokeTestsRunner, smokeTestDenyListSectionWriter), + ) + + private val smokeTestDenyListSectionWriter = SectionWriter { writer, _ -> + writer.write("// Smoke tests for service deny listed until model is fixed") + } +} + +/** + * SDK ID's of services that model smoke tests incorrectly + */ +val smokeTestDenyList = setOf( + "Application Auto Scaling", + "SWF", + "WAFV2", + "IoT Data Plane", +) diff --git a/codegen/aws-sdk-codegen/src/main/resources/META-INF/services/software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration b/codegen/aws-sdk-codegen/src/main/resources/META-INF/services/software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration index 876fbb45758..3ef264034df 100644 --- a/codegen/aws-sdk-codegen/src/main/resources/META-INF/services/software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration +++ b/codegen/aws-sdk-codegen/src/main/resources/META-INF/services/software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration @@ -33,7 +33,6 @@ aws.sdk.kotlin.codegen.customization.glacier.GlacierBodyChecksum aws.sdk.kotlin.codegen.customization.polly.PollyPresigner aws.sdk.kotlin.codegen.customization.machinelearning.MachineLearningEndpointCustomization aws.sdk.kotlin.codegen.customization.route53.TrimResourcePrefix -aws.sdk.kotlin.codegen.customization.route53.ChangeResourceRecordSetsUnmarshallingIntegration aws.sdk.kotlin.codegen.customization.ec2.EC2MakePrimitivesOptional aws.sdk.kotlin.codegen.customization.RemoveDefaults aws.sdk.kotlin.codegen.customization.s3.UnsupportedSigningAlgorithmIntegration @@ -43,3 +42,4 @@ aws.sdk.kotlin.codegen.customization.s3.express.SigV4S3ExpressAuthSchemeIntegrat aws.sdk.kotlin.codegen.customization.s3.express.S3ExpressIntegration aws.sdk.kotlin.codegen.customization.s3.S3ExpiresIntegration aws.sdk.kotlin.codegen.BusinessMetricsIntegration +aws.sdk.kotlin.codegen.smoketests.SmokeTestsDenyListIntegration diff --git a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json index 14e50ff40c6..5eaa9881086 100644 --- a/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json +++ b/codegen/aws-sdk-codegen/src/main/resources/aws/sdk/kotlin/codegen/endpoints.json @@ -559,11 +559,13 @@ "aoss" : { "endpoints" : { "ap-northeast-1" : { }, + "ap-northeast-2" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, "eu-central-1" : { }, + "eu-central-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -1658,6 +1660,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ca-central-1" : { }, + "ca-west-1" : { }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -2052,20 +2055,76 @@ "protocols" : [ "https" ] }, "endpoints" : { - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-2" : { } + "ap-northeast-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + } } }, "arc-zonal-shift" : { @@ -2573,6 +2632,7 @@ "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ap-southeast-4" : { }, + "ap-southeast-5" : { }, "ca-central-1" : { }, "ca-west-1" : { }, "eu-central-1" : { }, @@ -2709,6 +2769,7 @@ "bedrock" : { "endpoints" : { "ap-northeast-1" : { }, + "ap-northeast-2" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -2718,6 +2779,12 @@ }, "hostname" : "bedrock.ap-northeast-1.amazonaws.com" }, + "bedrock-ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "bedrock.ap-northeast-2.amazonaws.com" + }, "bedrock-ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" @@ -2778,6 +2845,12 @@ }, "hostname" : "bedrock-fips.us-east-1.amazonaws.com" }, + "bedrock-fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "bedrock-fips.us-east-2.amazonaws.com" + }, "bedrock-fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" @@ -2790,6 +2863,12 @@ }, "hostname" : "bedrock-runtime.ap-northeast-1.amazonaws.com" }, + "bedrock-runtime-ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "bedrock-runtime.ap-northeast-2.amazonaws.com" + }, "bedrock-runtime-ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" @@ -2850,6 +2929,12 @@ }, "hostname" : "bedrock-runtime-fips.us-east-1.amazonaws.com" }, + "bedrock-runtime-fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "bedrock-runtime-fips.us-east-2.amazonaws.com" + }, "bedrock-runtime-fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" @@ -2868,6 +2953,12 @@ }, "hostname" : "bedrock-runtime.us-east-1.amazonaws.com" }, + "bedrock-runtime-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "bedrock-runtime.us-east-2.amazonaws.com" + }, "bedrock-runtime-us-west-2" : { "credentialScope" : { "region" : "us-west-2" @@ -2886,6 +2977,12 @@ }, "hostname" : "bedrock.us-east-1.amazonaws.com" }, + "bedrock-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "bedrock.us-east-2.amazonaws.com" + }, "bedrock-us-west-2" : { "credentialScope" : { "region" : "us-west-2" @@ -2899,6 +2996,7 @@ "eu-west-3" : { }, "sa-east-1" : { }, "us-east-1" : { }, + "us-east-2" : { }, "us-west-2" : { } } }, @@ -8430,28 +8528,133 @@ }, "firehose" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-northeast-3" : { }, - "ap-south-1" : { }, - "ap-south-2" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ap-southeast-3" : { }, - "ap-southeast-4" : { }, + "af-south-1" : { + "variants" : [ { + "hostname" : "firehose.af-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "firehose.ap-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "firehose.ap-northeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "firehose.ap-northeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "hostname" : "firehose.ap-northeast-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "firehose.ap-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-2" : { + "variants" : [ { + "hostname" : "firehose.ap-south-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "firehose.ap-southeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "firehose.ap-southeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-3" : { + "variants" : [ { + "hostname" : "firehose.ap-southeast-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-4" : { + "variants" : [ { + "hostname" : "firehose.ap-southeast-4.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "ap-southeast-5" : { }, - "ca-central-1" : { }, - "ca-west-1" : { }, - "eu-central-1" : { }, - "eu-central-2" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-south-2" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "firehose.ca-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ca-west-1" : { + "variants" : [ { + "hostname" : "firehose.ca-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "firehose.eu-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-2" : { + "variants" : [ { + "hostname" : "firehose.eu-central-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "hostname" : "firehose.eu-north-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "firehose.eu-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-2" : { + "variants" : [ { + "hostname" : "firehose.eu-south-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "firehose.eu-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "firehose.eu-west-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "firehose.eu-west-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -8480,32 +8683,76 @@ "deprecated" : true, "hostname" : "firehose-fips.us-west-2.amazonaws.com" }, - "il-central-1" : { }, - "me-central-1" : { }, - "me-south-1" : { }, - "sa-east-1" : { }, + "il-central-1" : { + "variants" : [ { + "hostname" : "firehose.il-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "me-central-1" : { + "variants" : [ { + "hostname" : "firehose.me-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "me-south-1" : { + "variants" : [ { + "hostname" : "firehose.me-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "hostname" : "firehose.sa-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "us-east-1" : { "variants" : [ { "hostname" : "firehose-fips.us-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "firehose-fips.us-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "firehose.us-east-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-east-2" : { "variants" : [ { "hostname" : "firehose-fips.us-east-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "firehose-fips.us-east-2.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "firehose.us-east-2.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-west-1" : { "variants" : [ { "hostname" : "firehose-fips.us-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "firehose-fips.us-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "firehose.us-west-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-west-2" : { "variants" : [ { "hostname" : "firehose-fips.us-west-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "firehose-fips.us-west-2.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "firehose.us-west-2.api.aws", + "tags" : [ "dualstack" ] } ] } } @@ -9137,6 +9384,7 @@ "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "sa-east-1" : { }, @@ -9633,6 +9881,8 @@ }, "endpoints" : { "ap-south-1" : { }, + "ap-southeast-2" : { }, + "eu-west-2" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-2" : { } @@ -12998,6 +13248,7 @@ "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -14072,6 +14323,7 @@ "eu-central-1" : { }, "eu-north-1" : { }, "eu-south-1" : { }, + "eu-south-2" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -16001,8 +16253,24 @@ "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ap-southeast-4" : { }, - "ca-central-1" : { }, - "ca-west-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "resource-explorer-2-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "resource-explorer-2-fips.ca-central-1.api.aws", + "tags" : [ "dualstack", "fips" ] + } ] + }, + "ca-west-1" : { + "variants" : [ { + "hostname" : "resource-explorer-2-fips.ca-west-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "resource-explorer-2-fips.ca-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + } ] + }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -16011,14 +16279,88 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "resource-explorer-2-fips.ca-central-1.amazonaws.com" + }, + "fips-ca-west-1" : { + "credentialScope" : { + "region" : "ca-west-1" + }, + "deprecated" : true, + "hostname" : "resource-explorer-2-fips.ca-west-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "resource-explorer-2-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "resource-explorer-2-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "resource-explorer-2-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "resource-explorer-2-fips.us-west-2.amazonaws.com" + }, "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "us-east-1" : { + "variants" : [ { + "hostname" : "resource-explorer-2-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "resource-explorer-2-fips.us-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "resource-explorer-2-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "resource-explorer-2-fips.us-east-2.api.aws", + "tags" : [ "dualstack", "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "resource-explorer-2-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "resource-explorer-2-fips.us-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "resource-explorer-2-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + }, { + "hostname" : "resource-explorer-2-fips.us-west-2.api.aws", + "tags" : [ "dualstack", "fips" ] + } ] + } } }, "resource-groups" : { @@ -19502,6 +19844,86 @@ } } }, + "ssm-quicksetup" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.ca-central-1.amazonaws.com" + }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "ssm-quicksetup-fips.us-west-2.amazonaws.com" + }, + "sa-east-1" : { }, + "us-east-1" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.us-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "ssm-quicksetup-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } + } + }, "ssm-sap" : { "endpoints" : { "af-south-1" : { }, @@ -20912,8 +21334,10 @@ "vpc-lattice" : { "endpoints" : { "af-south-1" : { }, + "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, @@ -20924,6 +21348,7 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -21976,9 +22401,16 @@ "ap-northeast-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-west-2" : { }, + "fips-ca-central-1" : { + "deprecated" : true + }, "fips-us-east-1" : { "deprecated" : true }, @@ -23886,6 +24318,7 @@ }, "aoss" : { "endpoints" : { + "us-gov-east-1" : { }, "us-gov-west-1" : { } } }, @@ -27796,6 +28229,12 @@ } } }, + "schemas" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "secretsmanager" : { "endpoints" : { "us-gov-east-1" : { @@ -29164,8 +29603,32 @@ }, "ds" : { "endpoints" : { - "us-iso-east-1" : { }, - "us-iso-west-1" : { } + "fips-us-iso-east-1" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "deprecated" : true, + "hostname" : "ds-fips.us-iso-east-1.c2s.ic.gov" + }, + "fips-us-iso-west-1" : { + "credentialScope" : { + "region" : "us-iso-west-1" + }, + "deprecated" : true, + "hostname" : "ds-fips.us-iso-west-1.c2s.ic.gov" + }, + "us-iso-east-1" : { + "variants" : [ { + "hostname" : "ds-fips.us-iso-east-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-iso-west-1" : { + "variants" : [ { + "hostname" : "ds-fips.us-iso-west-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + } } }, "dynamodb" : { @@ -29985,7 +30448,19 @@ }, "ds" : { "endpoints" : { - "us-isob-east-1" : { } + "fips-us-isob-east-1" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "deprecated" : true, + "hostname" : "ds-fips.us-isob-east-1.sc2s.sgov.gov" + }, + "us-isob-east-1" : { + "variants" : [ { + "hostname" : "ds-fips.us-isob-east-1.sc2s.sgov.gov", + "tags" : [ "fips" ] + } ] + } } }, "dynamodb" : { @@ -30448,6 +30923,11 @@ "endpoints" : { "us-isob-east-1" : { } } + }, + "xray" : { + "endpoints" : { + "us-isob-east-1" : { } + } } } }, { diff --git a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/EndpointUrlConfigNamesTest.kt b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/EndpointUrlConfigNamesTest.kt index 2a56be7a27f..554375f224f 100644 --- a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/EndpointUrlConfigNamesTest.kt +++ b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/EndpointUrlConfigNamesTest.kt @@ -1593,11 +1593,6 @@ private const val TEST_SUITE_JSON = """ "services_section_name": "workdocs", "service_envvar_name": "AWS_ENDPOINT_URL_WORKDOCS" }, - { - "service_id": "WorkLink", - "services_section_name": "worklink", - "service_envvar_name": "AWS_ENDPOINT_URL_WORKLINK" - }, { "service_id": "WorkMail", "services_section_name": "workmail", @@ -1705,7 +1700,6 @@ private const val JAVA_CLIENT_NAMES_JSON = """ "DAX": "DaxClient", "OpsWorksCM": "OpsWorksCmClient", "ACM PCA": "AcmPcaClient", - "WorkLink": "WorkLinkClient", "GuardDuty": "GuardDutyClient", "CleanRooms": "CleanRoomsClient", "codeartifact": "CodeartifactClient", diff --git a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/customization/route53/ChangeResourceRecordSetsUnmarshallingIntegrationTest.kt b/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/customization/route53/ChangeResourceRecordSetsUnmarshallingIntegrationTest.kt deleted file mode 100644 index b46961e0695..00000000000 --- a/codegen/aws-sdk-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/customization/route53/ChangeResourceRecordSetsUnmarshallingIntegrationTest.kt +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ -package aws.sdk.kotlin.codegen.customization.route53 - -import org.junit.jupiter.api.Test -import software.amazon.smithy.kotlin.codegen.test.defaultSettings -import software.amazon.smithy.kotlin.codegen.test.prependNamespaceAndService -import software.amazon.smithy.kotlin.codegen.test.toSmithyModel -import software.amazon.smithy.model.Model -import kotlin.test.assertFalse -import kotlin.test.assertTrue - -class ChangeResourceRecordSetsUnmarshallingIntegrationTest { - @Test - fun nonRoute53ModelIntegration() { - val model = sampleModel("not route 53") - val isEnabledForModel = ChangeResourceRecordSetsUnmarshallingIntegration().enabledForService(model, model.defaultSettings()) - assertFalse(isEnabledForModel) - } - - @Test - fun route53ModelIntegration() { - val model = sampleModel("route 53") - val isEnabledForModel = ChangeResourceRecordSetsUnmarshallingIntegration().enabledForService(model, model.defaultSettings()) - assertTrue(isEnabledForModel) - } -} - -private fun sampleModel(serviceName: String): Model = - """ - @http(method: "PUT", uri: "/foo") - operation Foo { } - - @http(method: "POST", uri: "/bar") - operation Bar { } - """ - .prependNamespaceAndService(operations = listOf("Foo", "Bar"), serviceName = serviceName) - .toSmithyModel() diff --git a/codegen/sdk/aws-models/acm-pca.json b/codegen/sdk/aws-models/acm-pca.json index 4c2a880b7f1..7c697300aac 100644 --- a/codegen/sdk/aws-models/acm-pca.json +++ b/codegen/sdk/aws-models/acm-pca.json @@ -1778,7 +1778,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an audit report that lists every time that your CA private key is used. The\n\t\t\treport is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use\n\t\t\tthe private key.

\n \n

Both Amazon Web Services Private CA and the IAM principal must have permission to write to\n the S3 bucket that you specify. If the IAM principal making the call\n does not have permission to write to the bucket, then an exception is\n thrown. For more information, see Access \n\t\t\t\t\t\tpolicies for CRLs in Amazon S3.

\n \n

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. \n For more information, see Encrypting Your Audit\n\t\t\t\tReports.

\n \n

You can generate a maximum of one report every 30 minutes.

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

Creates an audit report that lists every time that your CA private key is used to issue a certificate. The IssueCertificate and RevokeCertificate actions use\n\t\t\tthe private key.

\n

To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see Prepare an Amazon S3 bucket for audit reports.

\n

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. \n For more information, see Encrypting Your Audit\n\t\t\t\tReports.

\n \n

You can generate a maximum of one report every 30 minutes.

\n ", "smithy.api#idempotent": {} } }, @@ -1844,7 +1844,7 @@ "RevocationConfiguration": { "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "smithy.api#documentation": "

Contains information to enable Online Certificate Status Protocol (OCSP) support, to\n\t\t\tenable a certificate revocation list (CRL), to enable both, or to enable neither. The\n\t\t\tdefault is for both certificate validation mechanisms to be disabled.

\n \n

The following requirements apply to revocation configurations.

\n
    \n
  • \n

    A configuration disabling CRLs or OCSP must contain only the Enabled=False \n\t\t\t\t\tparameter, and will fail if other parameters such as CustomCname or \n\t\t\t\t\tExpirationInDays are included.

    \n
    • \n
  • \n

    In a CRL configuration, the S3BucketName parameter must conform to \n\t\t\t\t\tAmazon S3 \n\t\t\t\t\tbucket naming rules.

    \n
    • \n
  • \n

    A configuration containing a custom Canonical\n\t\t\t\t\t\tName (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions\n\t\t\t\t\t\ton the use of special characters in a CNAME.

    \n
    • \n
  • \n

    In a CRL or OCSP configuration, the value of a CNAME parameter must not include a\n\t\t\t\t\t\tprotocol prefix such as \"http://\" or \"https://\".

    \n
    • \n
\n \n

For more information, see the OcspConfiguration and CrlConfiguration\n\t\t\ttypes.

" + "smithy.api#documentation": "

Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. By default, both certificate validation mechanisms are disabled.

\n

The following requirements apply to revocation configurations.

\n
    \n
  • \n

    A configuration disabling CRLs or OCSP must contain only the Enabled=False \n\t\t\t\t\tparameter, and will fail if other parameters such as CustomCname or \n\t\t\t\t\tExpirationInDays are included.

    \n
    • \n
  • \n

    In a CRL configuration, the S3BucketName parameter must conform to \n\t\t\t\t\tAmazon S3 \n\t\t\t\t\tbucket naming rules.

    \n
    • \n
  • \n

    A configuration containing a custom Canonical\n\t\t\t\t\t\tName (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions\n\t\t\t\t\t\ton the use of special characters in a CNAME.

    \n
    • \n
  • \n

    In a CRL or OCSP configuration, the value of a CNAME parameter must not include a\n\t\t\t\t\t\tprotocol prefix such as \"http://\" or \"https://\".

    \n
    • \n
\n

For more information, see the OcspConfiguration and CrlConfiguration\n\t\t\ttypes.

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

Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you\n\t\t\tare using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call\n\t\t\tthis action, the following preparations must in place:

\n
    \n
  1. \n

    In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you\n\t\t\t\t\tplan to back with the imported certificate.

    \n
    2. \n
  2. \n

    Call the GetCertificateAuthorityCsr action to generate a certificate signing\n\t\t\t\t\trequest (CSR).

    \n
    3. \n
  3. \n

    Sign the CSR using a root or intermediate CA hosted by either an on-premises\n\t\t\t\t\tPKI hierarchy or by a commercial CA.

    \n
    4. \n
  4. \n

    Create a certificate chain and copy the signed certificate and the certificate\n\t\t\t\t\tchain to your working directory.

    \n
    5. \n
\n

Amazon Web Services Private CA supports three scenarios for installing a CA certificate:

\n
    \n
  • \n

    Installing a certificate for a root CA hosted by Amazon Web Services Private CA.

    \n
    • \n
  • \n

    Installing a subordinate CA certificate whose parent authority is hosted by\n\t\t\t\t\tAmazon Web Services Private CA.

    \n
    • \n
  • \n

    Installing a subordinate CA certificate whose parent authority is externally\n\t\t\t\t\thosted.

    \n
    • \n
\n

The following additional requirements apply when you import a CA certificate.

\n
    \n
  • \n

    Only a self-signed certificate can be imported as a root CA.

    \n
    • \n
  • \n

    A self-signed certificate cannot be imported as a subordinate CA.

    \n
    • \n
  • \n

    Your certificate chain must not include the private CA certificate that you\n\t\t\t\t\tare importing.

    \n
    • \n
  • \n

    Your root CA must be the last certificate in your chain. The subordinate\n\t\t\t\t\tcertificate, if any, that your root CA signed must be next to last. The\n\t\t\t\t\tsubordinate certificate signed by the preceding subordinate CA must come next,\n\t\t\t\t\tand so on until your chain is built.

    \n
    • \n
  • \n

    The chain must be PEM-encoded.

    \n
    • \n
  • \n

    The maximum allowed size of a certificate is 32 KB.

    \n
    • \n
  • \n

    The maximum allowed size of a certificate chain is 2 MB.

    \n
    • \n
\n

\n Enforcement of Critical Constraints\n

\n

Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA\n\t\t\tcertificate or chain.

\n
    \n
  • \n

    Basic constraints (must be marked critical)

    \n
    • \n
  • \n

    Subject alternative names

    \n
    • \n
  • \n

    Key usage

    \n
    • \n
  • \n

    Extended key usage

    \n
    • \n
  • \n

    Authority key identifier

    \n
    • \n
  • \n

    Subject key identifier

    \n
    • \n
  • \n

    Issuer alternative name

    \n
    • \n
  • \n

    Subject directory attributes

    \n
    • \n
  • \n

    Subject information access

    \n
    • \n
  • \n

    Certificate policies

    \n
    • \n
  • \n

    Policy mappings

    \n
    • \n
  • \n

    Inhibit anyPolicy

    \n
    • \n
\n

Amazon Web Services Private CA rejects the following extensions when they are marked critical in an\n\t\t\timported CA certificate or chain.

\n
    \n
  • \n

    Name constraints

    \n
    • \n
  • \n

    Policy constraints

    \n
    • \n
  • \n

    CRL distribution points

    \n
    • \n
  • \n

    Authority information access

    \n
    • \n
  • \n

    Freshest CRL

    \n
    • \n
  • \n

    Any other extension

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

Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you\n\t\t\tare using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call\n\t\t\tthis action, the following preparations must in place:

\n
    \n
  1. \n

    In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you\n\t\t\t\t\tplan to back with the imported certificate.

    \n
    2. \n
  2. \n

    Call the GetCertificateAuthorityCsr action to generate a certificate signing\n\t\t\t\t\trequest (CSR).

    \n
    3. \n
  3. \n

    Sign the CSR using a root or intermediate CA hosted by either an on-premises\n\t\t\t\t\tPKI hierarchy or by a commercial CA.

    \n
    4. \n
  4. \n

    Create a certificate chain and copy the signed certificate and the certificate\n\t\t\t\t\tchain to your working directory.

    \n
    5. \n
\n

Amazon Web Services Private CA supports three scenarios for installing a CA certificate:

\n
    \n
  • \n

    Installing a certificate for a root CA hosted by Amazon Web Services Private CA.

    \n
    • \n
  • \n

    Installing a subordinate CA certificate whose parent authority is hosted by\n\t\t\t\t\tAmazon Web Services Private CA.

    \n
    • \n
  • \n

    Installing a subordinate CA certificate whose parent authority is externally\n\t\t\t\t\thosted.

    \n
    • \n
\n

The following additional requirements apply when you import a CA certificate.

\n
    \n
  • \n

    Only a self-signed certificate can be imported as a root CA.

    \n
    • \n
  • \n

    A self-signed certificate cannot be imported as a subordinate CA.

    \n
    • \n
  • \n

    Your certificate chain must not include the private CA certificate that you\n\t\t\t\t\tare importing.

    \n
    • \n
  • \n

    Your root CA must be the last certificate in your chain. The subordinate\n\t\t\t\t\tcertificate, if any, that your root CA signed must be next to last. The\n\t\t\t\t\tsubordinate certificate signed by the preceding subordinate CA must come next,\n\t\t\t\t\tand so on until your chain is built.

    \n
    • \n
  • \n

    The chain must be PEM-encoded.

    \n
    • \n
  • \n

    The maximum allowed size of a certificate is 32 KB.

    \n
    • \n
  • \n

    The maximum allowed size of a certificate chain is 2 MB.

    \n
    • \n
\n

\n Enforcement of Critical Constraints\n

\n

Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA\n\t\t\tcertificate or chain.

\n
    \n
  • \n

    Authority key identifier

    \n
    • \n
  • \n

    Basic constraints (must be marked critical)

    \n
    • \n
  • \n

    Certificate policies

    \n
    • \n
  • \n

    Extended key usage

    \n
    • \n
  • \n

    Inhibit anyPolicy

    \n
    • \n
  • \n

    Issuer alternative name

    \n
    • \n
  • \n

    Key usage

    \n
    • \n
  • \n

    Name constraints

    \n
    • \n
  • \n

    Policy mappings

    \n
    • \n
  • \n

    Subject alternative name

    \n
    • \n
  • \n

    Subject directory attributes

    \n
    • \n
  • \n

    Subject key identifier

    \n
    • \n
  • \n

    Subject information access

    \n
    • \n
\n

Amazon Web Services Private CA rejects the following extensions when they are marked critical in an\n\t\t\timported CA certificate or chain.

\n
    \n
  • \n

    Authority information access

    \n
    • \n
  • \n

    CRL distribution points

    \n
    • \n
  • \n

    Freshest CRL

    \n
    • \n
  • \n

    Policy constraints

    \n
    • \n
\n

Amazon Web Services Private Certificate Authority will also reject any other extension marked as critical not contained on the preceding list of allowed extensions.

" } }, "com.amazonaws.acmpca#ImportCertificateAuthorityCertificateRequest": { @@ -4612,7 +4612,7 @@ "RevocationConfiguration": { "target": "com.amazonaws.acmpca#RevocationConfiguration", "traits": { - "smithy.api#documentation": "

Contains information to enable Online Certificate Status Protocol (OCSP) support, to\n\t\t\tenable a certificate revocation list (CRL), to enable both, or to enable neither. If\n\t\t\tthis parameter is not supplied, existing capibilites remain unchanged. For more\n\t\t\tinformation, see the OcspConfiguration and CrlConfiguration types.

\n \n

The following requirements apply to revocation configurations.

\n
    \n
  • \n

    A configuration disabling CRLs or OCSP must contain only the Enabled=False \n\t\t\t\t\tparameter, and will fail if other parameters such as CustomCname or \n\t\t\t\t\tExpirationInDays are included.

    \n
    • \n
  • \n

    In a CRL configuration, the S3BucketName parameter must conform to \n\t\t\t\t\tAmazon S3 \n\t\t\t\t\tbucket naming rules.

    \n
    • \n
  • \n

    A configuration containing a custom Canonical\n\t\t\t\t\t\tName (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions\n\t\t\t\t\t\ton the use of special characters in a CNAME.

    \n
    • \n
  • \n

    In a CRL or OCSP configuration, the value of a CNAME parameter must not include a\n\t\t\t\t\t\tprotocol prefix such as \"http://\" or \"https://\".

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

Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don't supply this parameter, existing capibilites remain unchanged. For more\n\t\t\tinformation, see the OcspConfiguration and CrlConfiguration types.

\n

The following requirements apply to revocation configurations.

\n
    \n
  • \n

    A configuration disabling CRLs or OCSP must contain only the Enabled=False \n\t\t\t\t\tparameter, and will fail if other parameters such as CustomCname or \n\t\t\t\t\tExpirationInDays are included.

    \n
    • \n
  • \n

    In a CRL configuration, the S3BucketName parameter must conform to \n\t\t\t\t\tAmazon S3 \n\t\t\t\t\tbucket naming rules.

    \n
    • \n
  • \n

    A configuration containing a custom Canonical\n\t\t\t\t\t\tName (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions\n\t\t\t\t\t\ton the use of special characters in a CNAME.

    \n
    • \n
  • \n

    In a CRL or OCSP configuration, the value of a CNAME parameter must not include a\n\t\t\t\t\t\tprotocol prefix such as \"http://\" or \"https://\".

    \n
    • \n
\n \n

If you update the S3BucketName of CrlConfiguration, you can break revocation for existing certificates. In other words, if you call UpdateCertificateAuthority to update the CRL configuration's S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you'll need to reissue old certificates to keep the revocation working. Alternatively, you can use a CustomCname in your CRL configuration if you might need to change the S3 bucket name in the future.

\n " } }, "Status": { diff --git a/codegen/sdk/aws-models/amplify.json b/codegen/sdk/aws-models/amplify.json index 10d06a0aa3f..45ba331ec0a 100644 --- a/codegen/sdk/aws-models/amplify.json +++ b/codegen/sdk/aws-models/amplify.json @@ -2388,7 +2388,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are\n not connected to a repository.

\n

The maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8\n hours, the StartDeployment call and the associated Job will\n fail.

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

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are\n not connected to a Git repository.

\n

The maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8\n hours, the StartDeployment call and the associated Job will\n fail.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches/{branchName}/deployments", @@ -4280,9 +4280,21 @@ "jobType": { "target": "com.amazonaws.amplify#JobType", "traits": { - "smithy.api#documentation": "

The type for the job. If the value is RELEASE, the job was manually\n released from its source by using the StartJob API. If the value is\n RETRY, the job was manually retried using the StartJob\n API. If the value is WEB_HOOK, the job was automatically triggered by\n webhooks.

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

The type for the job. If the value is RELEASE, the job was manually\n released from its source by using the StartJob API. This value is available only for apps\n that are connected to a repository.

\n

If the value is RETRY, the job was manually retried using the StartJob\n API. If the value is WEB_HOOK, the job was automatically triggered by\n webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.

", "smithy.api#required": {} } + }, + "sourceUrl": { + "target": "com.amazonaws.amplify#SourceUrl", + "traits": { + "smithy.api#documentation": "

The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and\n downloads a single .zip file, or an Amazon S3 bucket and prefix.

" + } + }, + "sourceUrlType": { + "target": "com.amazonaws.amplify#SourceUrlType", + "traits": { + "smithy.api#documentation": "

The type of source specified by the sourceURL.\n If the value is ZIP, the source is a .zip file.\n If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and\n prefix. If no value is specified, the default is ZIP.

" + } } }, "traits": { @@ -5279,7 +5291,24 @@ "min": 0, "max": 3000 }, - "smithy.api#pattern": "^(?s)" + "smithy.api#pattern": "^(s3|https|http)://" + } + }, + "com.amazonaws.amplify#SourceUrlType": { + "type": "enum", + "members": { + "ZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZIP" + } + }, + "BUCKET_PREFIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUCKET_PREFIX" + } + } } }, "com.amazonaws.amplify#StackArn": { @@ -5363,7 +5392,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a deployment for a manually deployed app. Manually deployed apps are not\n connected to a repository.

\n

The maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8\n hours, the StartDeployment call and the associated Job will\n fail.

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

Starts a deployment for a manually deployed app. Manually deployed apps are not\n connected to a Git repository.

\n

The maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8\n hours, the StartDeployment call and the associated Job will\n fail.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches/{branchName}/deployments/start", @@ -5385,7 +5414,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name of the branch to use for the job.

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

The name of the branch to use for the deployment job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5393,13 +5422,19 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The job ID for this deployment, generated by the create deployment request.

" + "smithy.api#documentation": "

The job ID for this deployment that is generated by the CreateDeployment request.

" } }, "sourceUrl": { "target": "com.amazonaws.amplify#SourceUrl", "traits": { - "smithy.api#documentation": "

The source URL for this deployment, used when calling start deployment without create\n deployment. The source URL can be any HTTP GET URL that is publicly accessible and\n downloads a single .zip file.

" + "smithy.api#documentation": "

The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and\n downloads a single .zip file, or an Amazon S3 bucket and prefix.

" + } + }, + "sourceUrlType": { + "target": "com.amazonaws.amplify#SourceUrlType", + "traits": { + "smithy.api#documentation": "

The type of source specified by the sourceURL.\n If the value is ZIP, the source is a .zip file.\n If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and\n prefix. If no value is specified, the default is ZIP.

" } } }, diff --git a/codegen/sdk/aws-models/appflow.json b/codegen/sdk/aws-models/appflow.json index b7289d08e05..b905e855324 100644 --- a/codegen/sdk/aws-models/appflow.json +++ b/codegen/sdk/aws-models/appflow.json @@ -7886,7 +7886,7 @@ "oAuth2GrantType": { "target": "com.amazonaws.appflow#OAuth2GrantType", "traits": { - "smithy.api#documentation": "

Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an\n access token from Salesforce. Amazon AppFlow requires an access token each time it\n attempts to access your Salesforce records.

\n

You can specify one of the following values:

\n
\n
AUTHORIZATION_CODE
\n
\n

Amazon AppFlow passes an authorization code when it requests the access token\n from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n after you log in to your Salesforce account and authorize Amazon AppFlow to access\n your records.

\n
\n
CLIENT_CREDENTIALS
\n
\n

Amazon AppFlow passes client credentials (a client ID and client secret) when\n it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.

\n
\n
JWT_BEARER
\n
\n

Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n connection to your Salesforce account. When you use this grant type, you don't need to\n log in to your Salesforce account to authorize Amazon AppFlow to access your\n records.

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

Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an\n access token from Salesforce. Amazon AppFlow requires an access token each time it\n attempts to access your Salesforce records.

\n

You can specify one of the following values:

\n
\n
AUTHORIZATION_CODE
\n
\n

Amazon AppFlow passes an authorization code when it requests the access token\n from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n after you log in to your Salesforce account and authorize Amazon AppFlow to access\n your records.

\n
\n
JWT_BEARER
\n
\n

Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n connection to your Salesforce account. When you use this grant type, you don't need to\n log in to your Salesforce account to authorize Amazon AppFlow to access your\n records.

\n
\n
\n \n

The CLIENT_CREDENTIALS value is not supported for Salesforce.

\n " } }, "jwtToken": { @@ -8014,7 +8014,7 @@ "oauth2GrantTypesSupported": { "target": "com.amazonaws.appflow#OAuth2GrantTypeSupportedList", "traits": { - "smithy.api#documentation": "

The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access\n token from Salesforce. Amazon AppFlow requires an access token each time it attempts to\n access your Salesforce records.

\n
\n
AUTHORIZATION_CODE
\n
\n

Amazon AppFlow passes an authorization code when it requests the access token\n from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n after you log in to your Salesforce account and authorize Amazon AppFlow to access\n your records.

\n
\n
CLIENT_CREDENTIALS
\n
\n

Amazon AppFlow passes client credentials (a client ID and client secret) when\n it requests the access token from Salesforce. You provide these credentials to Amazon AppFlow when you define the connection to your Salesforce account.

\n
\n
JWT_BEARER
\n
\n

Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n connection to your Salesforce account. When you use this grant type, you don't need to\n log in to your Salesforce account to authorize Amazon AppFlow to access your\n records.

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

The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access\n token from Salesforce. Amazon AppFlow requires an access token each time it attempts to\n access your Salesforce records.

\n
\n
AUTHORIZATION_CODE
\n
\n

Amazon AppFlow passes an authorization code when it requests the access token\n from Salesforce. Amazon AppFlow receives the authorization code from Salesforce\n after you log in to your Salesforce account and authorize Amazon AppFlow to access\n your records.

\n
\n
JWT_BEARER
\n
\n

Amazon AppFlow passes a JSON web token (JWT) when it requests the access token\n from Salesforce. You provide the JWT to Amazon AppFlow when you define the\n connection to your Salesforce account. When you use this grant type, you don't need to\n log in to your Salesforce account to authorize Amazon AppFlow to access your\n records.

\n
\n
\n \n

The CLIENT_CREDENTIALS value is not supported for Salesforce.

\n " } } }, diff --git a/codegen/sdk/aws-models/application-insights.json b/codegen/sdk/aws-models/application-insights.json index d0aab87f7dc..ff150f6a66e 100644 --- a/codegen/sdk/aws-models/application-insights.json +++ b/codegen/sdk/aws-models/application-insights.json @@ -206,7 +206,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the owner of the application.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the owner of the application.

" } }, "ResourceGroupName": { @@ -227,6 +227,12 @@ "smithy.api#documentation": "

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

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

\n The SNS topic ARN that is associated with SNS notifications for updates or issues.\n

" + } + }, "OpsCenterEnabled": { "target": "com.amazonaws.applicationinsights#OpsCenterEnabled", "traits": { @@ -385,7 +391,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the owner of the application to which the configuration event belongs.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the owner of the application to which the configuration event belongs.

" } }, "MonitoredResourceARN": { @@ -558,6 +564,12 @@ "smithy.api#documentation": "

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

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

\n The SNS notification topic ARN.\n

" + } + }, "Tags": { "target": "com.amazonaws.applicationinsights#TagList", "traits": { @@ -730,7 +742,7 @@ "target": "com.amazonaws.applicationinsights#LogPatternRank", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

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

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

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

", "smithy.api#required": {} } } @@ -967,7 +979,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -1085,7 +1097,7 @@ "WorkloadName": { "target": "com.amazonaws.applicationinsights#WorkloadName", "traits": { - "smithy.api#documentation": "

The name of the workload.

" + "smithy.api#documentation": "

The name of the workload. The name of the workload is required when the tier of the application component is \n SAP_ASE_SINGLE_NODE or SAP_ASE_HIGH_AVAILABILITY.

" } }, "RecommendationType": { @@ -1133,7 +1145,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -1187,7 +1199,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -1262,7 +1274,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -1282,7 +1294,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } }, "LogPattern": { @@ -1332,7 +1344,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -1413,7 +1425,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -1448,7 +1460,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the owner of the resource group affected by the problem.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the owner of the resource group affected by the problem.

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

Information about the problem.

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

\n The SNS notification topic ARN of the problem.\n

" + } } }, "traits": { @@ -1520,7 +1538,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the workload owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the workload owner.

" } } }, @@ -2785,7 +2803,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -2866,7 +2884,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -2964,7 +2982,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -3045,7 +3063,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -3065,7 +3083,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } }, "LogPatternSets": { @@ -3144,7 +3162,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -3164,7 +3182,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } }, "LogPatterns": { @@ -3218,7 +3236,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } }, "ResourceGroupName": { @@ -3292,7 +3310,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the resource group owner.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the resource group owner.

" } } }, @@ -3409,7 +3427,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the owner of the workload.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the workload.

" } } }, @@ -3488,7 +3506,7 @@ "target": "com.amazonaws.applicationinsights#LogPatternRank", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

" } } }, @@ -3568,6 +3586,9 @@ "com.amazonaws.applicationinsights#MetricNamespace": { "type": "string" }, + "com.amazonaws.applicationinsights#MissingWorkloadConfig": { + "type": "boolean" + }, "com.amazonaws.applicationinsights#Monitor": { "type": "boolean" }, @@ -3673,31 +3694,31 @@ "HealthEventArn": { "target": "com.amazonaws.applicationinsights#HealthEventArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Health Event-based observation.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Health Event-based observation.

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

The service to which the AWS Health Event belongs, such as EC2.

" + "smithy.api#documentation": "

The service to which the Health Event belongs, such as EC2.

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

The type of the AWS Health event, for example,\n AWS_EC2_POWER_CONNECTIVITY_ISSUE.

" + "smithy.api#documentation": "

The type of the Health event, for example,\n AWS_EC2_POWER_CONNECTIVITY_ISSUE.

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

The category of the AWS Health event, such as issue.

" + "smithy.api#documentation": "

The category of the Health event, such as issue.

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

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

" + "smithy.api#documentation": "

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

" } }, "CodeDeployDeploymentId": { @@ -3920,6 +3941,12 @@ "smithy.api#documentation": "

The name of the problem.

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

\n The short name of the problem associated with the SNS notification.\n

" + } + }, "Insights": { "target": "com.amazonaws.applicationinsights#Insights", "traits": { @@ -3959,7 +3986,7 @@ "AccountId": { "target": "com.amazonaws.applicationinsights#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID for the owner of the resource group affected by the problem.

" + "smithy.api#documentation": "

The Amazon Web Services account ID for the owner of the resource group affected by the problem.

" } }, "ResourceGroupName": { @@ -4226,6 +4253,16 @@ "com.amazonaws.applicationinsights#S3EventName": { "type": "string" }, + "com.amazonaws.applicationinsights#SNSNotificationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 300 + }, + "smithy.api#pattern": "^arn:aws(-\\w+)*:[\\w\\d-]+:([\\w\\d-]*)?:[\\w\\d_-]*([:/].+)*$" + } + }, "com.amazonaws.applicationinsights#SeverityLevel": { "type": "enum", "members": { @@ -4255,6 +4292,9 @@ } } }, + "com.amazonaws.applicationinsights#ShortName": { + "type": "string" + }, "com.amazonaws.applicationinsights#SourceARN": { "type": "string" }, @@ -4330,7 +4370,7 @@ } }, "traits": { - "smithy.api#documentation": "

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

\n

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

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

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

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

\n

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

\n
    \n
  • \n

    Tag keys and values are case sensitive.

    \n
    • \n
  • \n

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

    \n
    • \n
  • \n

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

    \n
    • \n
" } }, "com.amazonaws.applicationinsights#TagKey": { @@ -4535,6 +4575,18 @@ "smithy.api#enumValue": "SAP_HANA_HIGH_AVAILABILITY" } }, + "SAP_ASE_SINGLE_NODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_ASE_SINGLE_NODE" + } + }, + "SAP_ASE_HIGH_AVAILABILITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAP_ASE_HIGH_AVAILABILITY" + } + }, "SQL_SERVER_FAILOVER_CLUSTER_INSTANCE": { "target": "smithy.api#Unit", "traits": { @@ -4704,6 +4756,12 @@ "smithy.api#documentation": "

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

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

\n The SNS topic ARN. Allows you to receive SNS notifications for updates and issues with an application.\n

" + } + }, "RemoveSNSTopic": { "target": "com.amazonaws.applicationinsights#RemoveSNSTopic", "traits": { @@ -4947,7 +5005,7 @@ "target": "com.amazonaws.applicationinsights#LogPatternRank", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

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

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

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

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

Indicates whether all of the component configurations required to monitor a workload were provided.

" + } } }, "traits": { @@ -5252,7 +5316,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 8 + "max": 12 }, "smithy.api#pattern": "^[a-zA-Z0-9\\.\\-_]*$" } diff --git a/codegen/sdk/aws-models/appstream.json b/codegen/sdk/aws-models/appstream.json index 3d58a636abb..f60bb59d4dd 100644 --- a/codegen/sdk/aws-models/appstream.json +++ b/codegen/sdk/aws-models/appstream.json @@ -137,6 +137,12 @@ "traits": { "smithy.api#enumValue": "DOMAIN_SMART_CARD_SIGNIN" } + }, + "AUTO_TIME_ZONE_REDIRECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_TIME_ZONE_REDIRECTION" + } } } }, diff --git a/codegen/sdk/aws-models/athena.json b/codegen/sdk/aws-models/athena.json index 5dddda82698..08f551e64eb 100644 --- a/codegen/sdk/aws-models/athena.json +++ b/codegen/sdk/aws-models/athena.json @@ -35,13 +35,13 @@ "S3AclOption": { "target": "com.amazonaws.athena#S3AclOption", "traits": { - "smithy.api#documentation": "

The Amazon S3 canned ACL that Athena should specify when storing\n query results. Currently the only supported canned ACL is\n BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the\n workgroup overrides client-side settings, then the Amazon S3 canned ACL\n specified in the workgroup's settings is used for all queries that run in the workgroup.\n For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

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

The Amazon S3 canned ACL that Athena should specify when storing\n query results, including data files inserted by Athena as the result\n of statements like CTAS or INSERT INTO. Currently the only supported canned ACL is\n BUCKET_OWNER_FULL_CONTROL. If a query runs in a workgroup and the\n workgroup overrides client-side settings, then the Amazon S3 canned ACL\n specified in the workgroup's settings is used for all queries that run in the workgroup.\n For more information about Amazon S3 canned ACLs, see Canned ACL in the Amazon S3 User Guide.

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

Indicates that an Amazon S3 canned ACL should be set to control ownership of\n stored query results. When Athena stores query results in Amazon S3,\n the canned ACL is set with the x-amz-acl request header. For more\n information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User\n Guide.

" + "smithy.api#documentation": "

Indicates that an Amazon S3 canned ACL should be set to control ownership of\n stored query results, including data files inserted by Athena as the result\n of statements like CTAS or INSERT INTO. When Athena stores query results in\n Amazon S3, the canned ACL is set with the x-amz-acl request\n header. For more information about S3 Object Ownership, see Object Ownership settings in the Amazon S3 User\n Guide.

" } }, "com.amazonaws.athena#Age": { @@ -2172,191 +2172,6 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, - "com.amazonaws.athena#ConnectionType": { - "type": "enum", - "members": { - "DYNAMODB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DYNAMODB" - } - }, - "MYSQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MYSQL" - } - }, - "POSTGRESQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRESQL" - } - }, - "REDSHIFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDSHIFT" - } - }, - "ORACLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ORACLE" - } - }, - "SYNAPSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SYNAPSE" - } - }, - "SQLSERVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQLSERVER" - } - }, - "DB2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DB2" - } - }, - "OPENSEARCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OPENSEARCH" - } - }, - "BIGQUERY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIGQUERY" - } - }, - "GOOGLECLOUDSTORAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GOOGLECLOUDSTORAGE" - } - }, - "HBASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HBASE" - } - }, - "DOCUMENTDB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOCUMENTDB" - } - }, - "MSK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MSK" - } - }, - "NEPTUNE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEPTUNE" - } - }, - "CMDB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CMDB" - } - }, - "TPCDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TPCDS" - } - }, - "REDIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDIS" - } - }, - "CLOUDWATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDWATCH" - } - }, - "TIMESTREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMESTREAM" - } - }, - "SAPHANA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAPHANA" - } - }, - "SNOWFLAKE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNOWFLAKE" - } - }, - "TERADATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERADATA" - } - }, - "VERTICA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERTICA" - } - }, - "CLOUDERAIMPALA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDERAIMPALA" - } - }, - "CLOUDERAHIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDERAHIVE" - } - }, - "HORTONWORKSHIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORTONWORKSHIVE" - } - }, - "DATALAKEGEN2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATALAKEGEN2" - } - }, - "DB2AS400": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DB2AS400" - } - }, - "CLOUDWATCHMETRICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDWATCHMETRICS" - } - } - } - }, "com.amazonaws.athena#CoordinatorDpuSize": { "type": "integer", "traits": { @@ -2455,7 +2270,7 @@ "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { - "smithy.api#documentation": "

The type of data catalog to create: LAMBDA for a federated catalog,\n GLUE for an Glue Data Catalog, and HIVE for an\n external Apache Hive metastore. FEDERATED is a federated catalog for which\n Athena creates the connection and the Lambda function for\n you based on the parameters that you pass.

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

The type of data catalog to create: LAMBDA for a federated catalog,\n HIVE for an external hive metastore, or GLUE for an\n Glue Data Catalog.

", "smithy.api#required": {} } }, @@ -2468,7 +2283,7 @@ "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type.

\n
    \n
  • \n

    For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

    \n

    \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

    \n
    • \n
  • \n

    For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

    \n
      \n
    • \n

      If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.

      \n

      \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

      \n
      • \n
    • \n

      If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

      \n

      \n function=lambda_arn\n \n

      \n
      • \n
    \n
    • \n
  • \n

    The GLUE type takes a catalog ID parameter and is required. The\n \n catalog_id\n is the account ID of the\n Amazon Web Services account to which the Glue Data Catalog\n belongs.

    \n

    \n catalog-id=catalog_id\n \n

    \n
      \n
    • \n

      The GLUE data catalog type also applies to the default\n AwsDataCatalog that already exists in your account, of\n which you can have only one and cannot modify.

      \n
      • \n
    \n
    • \n
  • \n

    The FEDERATED data catalog type uses one of the following\n parameters, but not both. Use connection-arn for an existing\n Glue connection. Use connection-type and\n connection-properties to specify the configuration setting for\n a new connection.

    \n
      \n
    • \n

      \n connection-arn:\n \n

      \n
      • \n
    • \n

      \n lambda-role-arn (optional): The execution role to use for the\n Lambda function. If not provided, one is created.

      \n
      • \n
    • \n

      \n connection-type:MYSQL|REDSHIFT|....,\n connection-properties:\"\"\n

      \n

      For \n \n , use escaped\n JSON text, as in the following example.

      \n

      \n \"{\\\"spill_bucket\\\":\\\"my_spill\\\",\\\"spill_prefix\\\":\\\"athena-spill\\\",\\\"host\\\":\\\"abc12345.snowflakecomputing.com\\\",\\\"port\\\":\\\"1234\\\",\\\"warehouse\\\":\\\"DEV_WH\\\",\\\"database\\\":\\\"TEST\\\",\\\"schema\\\":\\\"PUBLIC\\\",\\\"SecretArn\\\":\\\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\\\"}\"\n

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

Specifies the Lambda function or functions to use for creating the data\n catalog. This is a mapping whose values depend on the catalog type.

\n
    \n
  • \n

    For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

    \n

    \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

    \n
    • \n
  • \n

    For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

    \n
      \n
    • \n

      If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.

      \n

      \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

      \n
      • \n
    • \n

      If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

      \n

      \n function=lambda_arn\n \n

      \n
      • \n
    \n
    • \n
  • \n

    The GLUE type takes a catalog ID parameter and is required. The\n \n catalog_id\n is the account ID of the\n Amazon Web Services account to which the Glue Data Catalog\n belongs.

    \n

    \n catalog-id=catalog_id\n \n

    \n
      \n
    • \n

      The GLUE data catalog type also applies to the default\n AwsDataCatalog that already exists in your account, of\n which you can have only one and cannot modify.

      \n
      • \n
    \n
    • \n
" } }, "Tags": { @@ -2484,11 +2299,7 @@ }, "com.amazonaws.athena#CreateDataCatalogOutput": { "type": "structure", - "members": { - "DataCatalog": { - "target": "com.amazonaws.athena#DataCatalog" - } - }, + "members": {}, "traits": { "smithy.api#output": {} } @@ -2864,32 +2675,14 @@ "Type": { "target": "com.amazonaws.athena#DataCatalogType", "traits": { - "smithy.api#documentation": "

The type of data catalog to create: LAMBDA for a federated catalog,\n GLUE for an Glue Data Catalog, and HIVE for an\n external Apache Hive metastore. FEDERATED is a federated catalog for which\n Athena creates the connection and the Lambda function for\n you based on the parameters that you pass.

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

The type of data catalog to create: LAMBDA for a federated catalog,\n HIVE for an external hive metastore, or GLUE for an\n Glue Data Catalog.

", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.athena#ParametersMap", "traits": { - "smithy.api#documentation": "

Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.

\n
    \n
  • \n

    For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

    \n

    \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

    \n
    • \n
  • \n

    For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

    \n
      \n
    • \n

      If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.

      \n

      \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

      \n
      • \n
    • \n

      If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

      \n

      \n function=lambda_arn\n \n

      \n
      • \n
    \n
    • \n
  • \n

    The GLUE type takes a catalog ID parameter and is required. The\n \n catalog_id\n is the account ID of the\n Amazon Web Services account to which the Glue catalog\n belongs.

    \n

    \n catalog-id=catalog_id\n \n

    \n
      \n
    • \n

      The GLUE data catalog type also applies to the default\n AwsDataCatalog that already exists in your account, of\n which you can have only one and cannot modify.

      \n
      • \n
    \n
    • \n
  • \n

    The FEDERATED data catalog type uses one of the following\n parameters, but not both. Use connection-arn for an existing\n Glue connection. Use connection-type and\n connection-properties to specify the configuration setting for\n a new connection.

    \n
      \n
    • \n

      \n connection-arn:\n \n

      \n
      • \n
    • \n

      \n connection-type:MYSQL|REDSHIFT|....,\n connection-properties:\"\"\n

      \n

      For \n \n , use escaped\n JSON text, as in the following example.

      \n

      \n \"{\\\"spill_bucket\\\":\\\"my_spill\\\",\\\"spill_prefix\\\":\\\"athena-spill\\\",\\\"host\\\":\\\"abc12345.snowflakecomputing.com\\\",\\\"port\\\":\\\"1234\\\",\\\"warehouse\\\":\\\"DEV_WH\\\",\\\"database\\\":\\\"TEST\\\",\\\"schema\\\":\\\"PUBLIC\\\",\\\"SecretArn\\\":\\\"arn:aws:secretsmanager:ap-south-1:111122223333:secret:snowflake-XHb67j\\\"}\"\n

      \n
      • \n
    \n
    • \n
" - } - }, - "Status": { - "target": "com.amazonaws.athena#DataCatalogStatus", - "traits": { - "smithy.api#documentation": "

The status of the creation or deletion of the data catalog.

\n
    \n
  • \n

    The LAMBDA, GLUE, and HIVE data catalog\n types are created synchronously. Their status is either\n CREATE_COMPLETE or CREATE_FAILED.

    \n
    • \n
  • \n

    The FEDERATED data catalog type is created asynchronously.

    \n
    • \n
\n

Data catalog creation status:

\n
    \n
  • \n

    \n CREATE_IN_PROGRESS: Federated data catalog creation in\n progress.

    \n
    • \n
  • \n

    \n CREATE_COMPLETE: Data catalog creation complete.

    \n
    • \n
  • \n

    \n CREATE_FAILED: Data catalog could not be created.

    \n
    • \n
  • \n

    \n CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog\n creation failed and is being removed.

    \n
    • \n
  • \n

    \n CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation\n failed and was removed.

    \n
    • \n
  • \n

    \n CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation\n failed but could not be removed.

    \n
    • \n
\n

Data catalog deletion status:

\n
    \n
  • \n

    \n DELETE_IN_PROGRESS: Federated data catalog deletion in\n progress.

    \n
    • \n
  • \n

    \n DELETE_COMPLETE: Federated data catalog deleted.

    \n
    • \n
  • \n

    \n DELETE_FAILED: Federated data catalog could not be\n deleted.

    \n
    • \n
" - } - }, - "ConnectionType": { - "target": "com.amazonaws.athena#ConnectionType", - "traits": { - "smithy.api#documentation": "

The type of connection for a FEDERATED data catalog (for example,\n REDSHIFT, MYSQL, or SQLSERVER). For\n information about individual connectors, see Available data source\n connectors.

" - } - }, - "Error": { - "target": "com.amazonaws.athena#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Text of the error that occurred during data catalog creation or deletion.

" + "smithy.api#documentation": "

Specifies the Lambda function or functions to use for the data catalog.\n This is a mapping whose values depend on the catalog type.

\n
    \n
  • \n

    For the HIVE data catalog type, use the following syntax. The\n metadata-function parameter is required. The\n sdk-version parameter is optional and defaults to the currently\n supported version.

    \n

    \n metadata-function=lambda_arn,\n sdk-version=version_number\n \n

    \n
    • \n
  • \n

    For the LAMBDA data catalog type, use one of the following sets\n of required parameters, but not both.

    \n
      \n
    • \n

      If you have one Lambda function that processes metadata\n and another for reading the actual data, use the following syntax. Both\n parameters are required.

      \n

      \n metadata-function=lambda_arn,\n record-function=lambda_arn\n \n

      \n
      • \n
    • \n

      If you have a composite Lambda function that processes\n both metadata and data, use the following syntax to specify your Lambda function.

      \n

      \n function=lambda_arn\n \n

      \n
      • \n
    \n
    • \n
  • \n

    The GLUE type takes a catalog ID parameter and is required. The\n \n catalog_id\n is the account ID of the\n Amazon Web Services account to which the Glue catalog\n belongs.

    \n

    \n catalog-id=catalog_id\n \n

    \n
      \n
    • \n

      The GLUE data catalog type also applies to the default\n AwsDataCatalog that already exists in your account, of\n which you can have only one and cannot modify.

      \n
      • \n
    \n
    • \n
" } } }, @@ -2897,65 +2690,6 @@ "smithy.api#documentation": "

Contains information about a data catalog in an Amazon Web Services account.

\n \n

In the Athena console, data catalogs are listed as \"data sources\" on\n the Data sources page under the Data source name column.

\n " } }, - "com.amazonaws.athena#DataCatalogStatus": { - "type": "enum", - "members": { - "CREATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_IN_PROGRESS" - } - }, - "CREATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_COMPLETE" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "CREATE_FAILED_CLEANUP_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_IN_PROGRESS" - } - }, - "CREATE_FAILED_CLEANUP_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_COMPLETE" - } - }, - "CREATE_FAILED_CLEANUP_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED_CLEANUP_FAILED" - } - }, - "DELETE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_IN_PROGRESS" - } - }, - "DELETE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_COMPLETE" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, "com.amazonaws.athena#DataCatalogSummary": { "type": "structure", "members": { @@ -2970,24 +2704,6 @@ "traits": { "smithy.api#documentation": "

The data catalog type.

" } - }, - "Status": { - "target": "com.amazonaws.athena#DataCatalogStatus", - "traits": { - "smithy.api#documentation": "

The status of the creation or deletion of the data catalog.

\n
    \n
  • \n

    The LAMBDA, GLUE, and HIVE data catalog\n types are created synchronously. Their status is either\n CREATE_COMPLETE or CREATE_FAILED.

    \n
    • \n
  • \n

    The FEDERATED data catalog type is created asynchronously.

    \n
    • \n
\n

Data catalog creation status:

\n
    \n
  • \n

    \n CREATE_IN_PROGRESS: Federated data catalog creation in\n progress.

    \n
    • \n
  • \n

    \n CREATE_COMPLETE: Data catalog creation complete.

    \n
    • \n
  • \n

    \n CREATE_FAILED: Data catalog could not be created.

    \n
    • \n
  • \n

    \n CREATE_FAILED_CLEANUP_IN_PROGRESS: Federated data catalog\n creation failed and is being removed.

    \n
    • \n
  • \n

    \n CREATE_FAILED_CLEANUP_COMPLETE: Federated data catalog creation\n failed and was removed.

    \n
    • \n
  • \n

    \n CREATE_FAILED_CLEANUP_FAILED: Federated data catalog creation\n failed but could not be removed.

    \n
    • \n
\n

Data catalog deletion status:

\n
    \n
  • \n

    \n DELETE_IN_PROGRESS: Federated data catalog deletion in\n progress.

    \n
    • \n
  • \n

    \n DELETE_COMPLETE: Federated data catalog deleted.

    \n
    • \n
  • \n

    \n DELETE_FAILED: Federated data catalog could not be\n deleted.

    \n
    • \n
" - } - }, - "ConnectionType": { - "target": "com.amazonaws.athena#ConnectionType", - "traits": { - "smithy.api#documentation": "

The type of connection for a FEDERATED data catalog (for example,\n REDSHIFT, MYSQL, or SQLSERVER). For\n information about individual connectors, see Available data source\n connectors.

" - } - }, - "Error": { - "target": "com.amazonaws.athena#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Text of the error that occurred during data catalog creation or deletion.

" - } } }, "traits": { @@ -3020,12 +2736,6 @@ "traits": { "smithy.api#enumValue": "HIVE" } - }, - "FEDERATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FEDERATED" - } } } }, @@ -3177,11 +2887,7 @@ }, "com.amazonaws.athena#DeleteDataCatalogOutput": { "type": "structure", - "members": { - "DataCatalog": { - "target": "com.amazonaws.athena#DataCatalog" - } - }, + "members": {}, "traits": { "smithy.api#output": {} } @@ -4445,7 +4151,7 @@ "UpdateCount": { "target": "com.amazonaws.athena#Long", "traits": { - "smithy.api#documentation": "

The number of rows inserted with a CREATE TABLE AS SELECT statement.\n

" + "smithy.api#documentation": "

The number of rows inserted with a CREATE TABLE AS SELECT, INSERT\n INTO, or UPDATE statement.

" } }, "ResultSet": { diff --git a/codegen/sdk/aws-models/auto-scaling.json b/codegen/sdk/aws-models/auto-scaling.json index 80788987f2b..1b5d208f723 100644 --- a/codegen/sdk/aws-models/auto-scaling.json +++ b/codegen/sdk/aws-models/auto-scaling.json @@ -46,7 +46,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the AcceleratorCount object when\n you specify InstanceRequirements for an Auto Scaling group.

" + "smithy.api#documentation": "

Specifies the minimum and maximum for the AcceleratorCount object when\n you specify InstanceRequirements for an Auto Scaling group.

" } }, "com.amazonaws.autoscaling#AcceleratorManufacturer": { @@ -154,7 +154,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB\n object when you specify InstanceRequirements for an Auto Scaling group.

" + "smithy.api#documentation": "

Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB\n object when you specify InstanceRequirements for an Auto Scaling group.

" } }, "com.amazonaws.autoscaling#AcceleratorType": { @@ -534,7 +534,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more target groups to the specified Auto Scaling group.

\n

This operation is used with the following load balancer types:

\n
    \n
  • \n

    Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and\n HTTPS.

    \n
    • \n
  • \n

    Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and\n UDP.

    \n
    • \n
  • \n

    Gateway Load Balancer - Operates at the network layer (layer 3).

    \n
    • \n
\n

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

\n

This operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancerTargetGroups. You can\n use both the original AttachLoadBalancerTargetGroups API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more target groups to the specified Auto Scaling group.

\n

This operation is used with the following load balancer types:

\n
    \n
  • \n

    Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and\n HTTPS.

    \n
    • \n
  • \n

    Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and\n UDP.

    \n
    • \n
  • \n

    Gateway Load Balancer - Operates at the network layer (layer 3).

    \n
    • \n
\n

To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups\n API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

\n

This operation is additive and does not detach existing target groups or Classic Load\n Balancers from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", "smithy.api#examples": [ { "title": "To attach a target group to an Auto Scaling group", @@ -591,7 +591,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by AttachTrafficSources, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.

\n

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.

\n

This operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

This API operation is superseded by https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_AttachTrafficSources.html, which\n can attach multiple traffic sources types. We recommend using\n AttachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support AttachLoadBalancers. You can use both\n the original AttachLoadBalancers API operation and\n AttachTrafficSources on the same Auto Scaling group.

\n \n

Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the\n running instances with these Classic Load Balancers.

\n

To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API.\n To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers\n API.

\n

This operation is additive and does not detach existing Classic Load Balancers or\n target groups from the Auto Scaling group.

\n

For more information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", "smithy.api#examples": [ { "title": "To attach a load balancer to an Auto Scaling group", @@ -648,7 +648,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches one or more traffic sources to the specified Auto Scaling group.

\n

You can use any of the following as traffic sources for an Auto Scaling group:

\n
    \n
  • \n

    Application Load Balancer

    \n
    • \n
  • \n

    Classic Load Balancer

    \n
    • \n
  • \n

    Gateway Load Balancer

    \n
    • \n
  • \n

    Network Load Balancer

    \n
    • \n
  • \n

    VPC Lattice

    \n
    • \n
\n

This operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.

\n

After the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.

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

Attaches one or more traffic sources to the specified Auto Scaling group.

\n

You can use any of the following as traffic sources for an Auto Scaling group:

\n
    \n
  • \n

    Application Load Balancer

    \n
    • \n
  • \n

    Classic Load Balancer

    \n
    • \n
  • \n

    Gateway Load Balancer

    \n
    • \n
  • \n

    Network Load Balancer

    \n
    • \n
  • \n

    VPC Lattice

    \n
    • \n
\n

This operation is additive and does not detach existing traffic sources from the Auto Scaling\n group.

\n

After the operation completes, use the DescribeTrafficSources API to\n return details about the state of the attachments between traffic sources and your Auto Scaling\n group. To detach a traffic source from the Auto Scaling group, call the \n DetachTrafficSources API.

", "smithy.api#examples": [ { "title": "To attach a target group to an Auto Scaling group", @@ -842,7 +842,7 @@ "Status": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "

The current state of the group when the DeleteAutoScalingGroup\n operation is in progress.

" + "smithy.api#documentation": "

The current state of the group when the DeleteAutoScalingGroup\n operation is in progress.

" } }, "Tags": { @@ -2349,7 +2349,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object\n when you specify InstanceRequirements for an Auto Scaling group.

" + "smithy.api#documentation": "

Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object\n when you specify InstanceRequirements for an Auto Scaling group.

" } }, "com.amazonaws.autoscaling#BatchDeleteScheduledAction": { @@ -2581,7 +2581,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

When you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.

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

Cancels an instance refresh or rollback that is in progress. If an instance refresh or\n rollback is not in progress, an ActiveInstanceRefreshNotFound error\n occurs.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

When you cancel an instance refresh, this does not roll back any changes that it made.\n Use the RollbackInstanceRefresh API to roll back instead.

", "smithy.api#examples": [ { "title": "To cancel an instance refresh", @@ -2682,7 +2682,7 @@ } ], "traits": { - "smithy.api#documentation": "

Completes the lifecycle action for the specified token or instance with the specified\n result.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.

    \n
    6. \n
  6. \n

    \n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n

    \n
    7. \n
\n

For more information, see Complete a lifecycle\n action in the Amazon EC2 Auto Scaling User Guide.

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

Completes the lifecycle action for the specified token or instance with the specified\n result.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state.

    \n
    6. \n
  6. \n

    \n If you finish before the timeout period ends, send a\n callback by using the CompleteLifecycleAction API\n call.\n

    \n
    7. \n
\n

For more information, see Complete a lifecycle\n action in the Amazon EC2 Auto Scaling User Guide.

", "smithy.api#examples": [ { "title": "To complete the lifecycle action", @@ -2800,7 +2800,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started\n with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

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

\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Creates an Auto Scaling group with the specified name and attributes.

\n

If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started\n with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

Every Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.

", "smithy.api#examples": [ { "title": "To create an Auto Scaling group with an attached target group", @@ -3118,7 +3118,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a launch configuration.

\n

If you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.

\n \n

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

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

Creates a launch configuration.

\n

If you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. \n For information about updating this limit, see Quotas for \n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

For more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.

\n \n

Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.

\n ", "smithy.api#examples": [ { "title": "To create a launch configuration", @@ -3387,7 +3387,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified Auto Scaling group.

\n

If the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.

\n

To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.

\n

To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.

\n

If the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.

\n

For more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.

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

Deletes the specified Auto Scaling group.

\n

If the group has instances or scaling activities in progress, you must specify the\n option to force the deletion in order for it to succeed. The force delete operation will\n also terminate the EC2 instances. If the group has a warm pool, the force delete option\n also deletes the warm pool.

\n

To remove instances from the Auto Scaling group before deleting it, call the \n DetachInstances API with the list of instances and the option to\n decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement\n instances.

\n

To terminate all instances before deleting the Auto Scaling group, call the \n UpdateAutoScalingGroup API and set the minimum size and desired capacity\n of the Auto Scaling group to\n zero.

\n

If the group has scaling policies, deleting the group deletes the policies, the\n underlying alarm actions, and any alarm that no longer has an associated action.

\n

For more information, see Delete your Auto Scaling\n infrastructure in the Amazon EC2 Auto Scaling User Guide.

", "smithy.api#examples": [ { "title": "To delete an Auto Scaling group", @@ -3872,7 +3872,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the Auto Scaling groups in the account and Region.

\n

If you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.

\n

This operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.

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

Gets information about the Auto Scaling groups in the account and Region.

\n

If you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.

\n

This operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the \n DescribeWarmPool API.

", "smithy.api#examples": [ { "title": "To describe an Auto Scaling group", @@ -4396,7 +4396,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

\n

To determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.

\n

Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

You can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

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

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancerTargetGroups. You\n can use both the original DescribeLoadBalancerTargetGroups API\n operation and DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

\n

To determine the attachment status of the target group, use the State\n element in the response. When you attach a target group to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the target group. If\n Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and\n replace any instances that are reported as unhealthy. If no registered instances pass\n the health checks, the target group doesn't enter the InService state.

\n

Target groups also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your target group state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

\n \n

You can use this operation to describe target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n ", "smithy.api#examples": [ { "title": "To describe the target groups for an Auto Scaling group", @@ -4486,7 +4486,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.

\n

To determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.

\n

Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

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

This API operation is superseded by DescribeTrafficSources,\n which can describe multiple traffic sources types. We recommend using\n DescribeTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DescribeLoadBalancers. You can use both\n the original DescribeLoadBalancers API operation and\n DescribeTrafficSources on the same Auto Scaling group.

\n \n

Gets information about the load balancers for the specified Auto Scaling group.

\n

This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the\n DescribeLoadBalancerTargetGroups API instead.

\n

To determine the attachment status of the load balancer, use the State\n element in the response. When you attach a load balancer to an Auto Scaling group, the initial\n State value is Adding. The state transitions to\n Added after all Auto Scaling instances are registered with the load balancer.\n If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to\n InService after at least one Auto Scaling instance passes the health check.\n When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate\n and replace any instances that are reported as unhealthy. If no registered instances\n pass the health checks, the load balancer doesn't enter the InService\n state.

\n

Load balancers also have an InService state if you attach them in the\n CreateAutoScalingGroup API call. If your load balancer state is\n InService, but it is not working properly, check the scaling activities\n by calling DescribeScalingActivities and take any corrective actions\n necessary.

\n

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling:\n Health checks in the Amazon EC2 Auto Scaling User Guide. For more\n information, see Use Elastic Load Balancing to\n distribute traffic across the instances in your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.

", "smithy.api#examples": [ { "title": "To describe the load balancers for an Auto Scaling group", @@ -4920,7 +4920,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the scaling process types for use with the ResumeProcesses\n and SuspendProcesses APIs.

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

Describes the scaling process types for use with the ResumeProcesses \n and SuspendProcesses APIs.

", "smithy.api#examples": [ { "title": "To describe the Auto Scaling process types", @@ -4987,7 +4987,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the scheduled actions that haven't run or that have not reached\n their end time.

\n

To describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.

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

Gets information about the scheduled actions that haven't run or that have not reached\n their end time.

\n

To describe the scaling activities for scheduled actions that have already run, call\n the DescribeScalingActivities API.

", "smithy.api#examples": [ { "title": "To describe scheduled actions", @@ -5478,7 +5478,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more target groups from the specified Auto Scaling group.

\n

When you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain\n running.

\n \n

You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

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

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancerTargetGroups. You can\n use both the original DetachLoadBalancerTargetGroups API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more target groups from the specified Auto Scaling group.

\n

When you detach a target group, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the target group using the \n DescribeLoadBalancerTargetGroups\n API call. The instances remain running.

\n \n

You can use this operation to detach target groups that were attached by using\n AttachLoadBalancerTargetGroups, but not for target groups that\n were attached by using AttachTrafficSources.

\n ", "smithy.api#examples": [ { "title": "To detach a target group from an Auto Scaling group", @@ -5532,7 +5532,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

\n

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

\n

When you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

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

This API operation is superseded by DetachTrafficSources, which\n can detach multiple traffic sources types. We recommend using\n DetachTrafficSources to simplify how you manage traffic sources.\n However, we continue to support DetachLoadBalancers. You can use both\n the original DetachLoadBalancers API operation and\n DetachTrafficSources on the same Auto Scaling group.

\n \n

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

\n

This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or\n Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

\n

When you detach a load balancer, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the load balancer using the DescribeLoadBalancers\n API call. The instances remain running.

", "smithy.api#examples": [ { "title": "To detach a load balancer from an Auto Scaling group", @@ -5586,7 +5586,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detaches one or more traffic sources from the specified Auto Scaling group.

\n

When you detach a traffic source, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.

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

Detaches one or more traffic sources from the specified Auto Scaling group.

\n

When you detach a traffic source, it enters the Removing state while\n deregistering the instances in the group. When all instances are deregistered, then you\n can no longer describe the traffic source using the \n DescribeTrafficSources\n API call. The instances continue to run.

", "smithy.api#examples": [ { "title": "To detach a target group from an Auto Scaling group", @@ -6102,7 +6102,7 @@ "Name": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n

The valid values for Name depend on which API operation you're using with\n the filter (DescribeAutoScalingGroups or DescribeTags).

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n
    \n
  • \n

    \n tag-key - Accepts tag keys. The results only include information\n about the Auto Scaling groups associated with these tag keys.

    \n
    • \n
  • \n

    \n tag-value - Accepts tag values. The results only include\n information about the Auto Scaling groups associated with these tag values.

    \n
    • \n
  • \n

    \n tag: - Accepts the key/value combination of the tag.\n Use the tag key in the filter name and the tag value as the filter value. The\n results only include information about the Auto Scaling groups associated with the\n specified key/value combination.

    \n
    • \n
\n

\n DescribeTags\n

\n

Valid values for Name include the following:

\n
    \n
  • \n

    \n auto-scaling-group - Accepts the names of Auto Scaling groups. The\n results only include information about the tags associated with these Auto Scaling\n groups.

    \n
    • \n
  • \n

    \n key - Accepts tag keys. The results only include information\n about the tags associated with these tag keys.

    \n
    • \n
  • \n

    \n value - Accepts tag values. The results only include information\n about the tags associated with these tag values.

    \n
    • \n
  • \n

    \n propagate-at-launch - Accepts a Boolean value, which specifies\n whether tags propagate to instances at launch. The results only include\n information about the tags associated with the specified Boolean value.

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

The name of the filter.

\n

The valid values for Name depend on which API operation you're using with\n the filter (DescribeAutoScalingGroups or \n DescribeTags).

\n

\n DescribeAutoScalingGroups\n

\n

Valid values for Name include the following:

\n
    \n
  • \n

    \n tag-key - Accepts tag keys. The results only include information\n about the Auto Scaling groups associated with these tag keys.

    \n
    • \n
  • \n

    \n tag-value - Accepts tag values. The results only include\n information about the Auto Scaling groups associated with these tag values.

    \n
    • \n
  • \n

    \n tag: - Accepts the key/value combination of the tag.\n Use the tag key in the filter name and the tag value as the filter value. The\n results only include information about the Auto Scaling groups associated with the\n specified key/value combination.

    \n
    • \n
\n

\n DescribeTags\n

\n

Valid values for Name include the following:

\n
    \n
  • \n

    \n auto-scaling-group - Accepts the names of Auto Scaling groups. The\n results only include information about the tags associated with these Auto Scaling\n groups.

    \n
    • \n
  • \n

    \n key - Accepts tag keys. The results only include information\n about the tags associated with these tag keys.

    \n
    • \n
  • \n

    \n value - Accepts tag values. The results only include information\n about the tags associated with these tag values.

    \n
    • \n
  • \n

    \n propagate-at-launch - Accepts a Boolean value, which specifies\n whether tags propagate to instances at launch. The results only include\n information about the tags associated with the specified Boolean value.

    \n
    • \n
" } }, "Values": { @@ -6840,7 +6840,7 @@ "OnDemandAllocationStrategy": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The allocation strategy to apply to your On-Demand Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
lowest-price
\n
\n

Uses price to determine which instance types are the highest priority,\n launching the lowest priced instance types within an Availability Zone\n first. This is the default value for Auto Scaling groups that specify InstanceRequirements.

\n
\n
prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling\n launches your highest priority instance types first. If all your On-Demand\n capacity cannot be fulfilled using your highest priority instance type, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance\n type, and so on. This is the default value for Auto Scaling groups that don't\n specify InstanceRequirements and cannot be used for groups\n that do.

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

The allocation strategy to apply to your On-Demand Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
lowest-price
\n
\n

Uses price to determine which instance types are the highest priority,\n launching the lowest priced instance types within an Availability Zone\n first. This is the default value for Auto Scaling groups that specify \n InstanceRequirements.

\n
\n
prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling\n launches your highest priority instance types first. If all your On-Demand\n capacity cannot be fulfilled using your highest priority instance type, then\n Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance\n type, and so on. This is the default value for Auto Scaling groups that don't\n specify InstanceRequirements and cannot be used for groups\n that do.

\n
\n
" } }, "OnDemandBaseCapacity": { @@ -6858,7 +6858,7 @@ "SpotAllocationStrategy": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "

The allocation strategy to apply to your Spot Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
capacity-optimized
\n
\n

Requests Spot Instances using pools that are optimally chosen based on the\n available Spot capacity. This strategy has the lowest risk of interruption.\n To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized.

\n
\n
capacity-optimized-prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors\n the instance type priorities on a best effort basis but optimizes for\n capacity first. Note that if the On-Demand allocation strategy is set to\n prioritized, the same priority is applied when fulfilling\n On-Demand capacity. This is not a valid value for Auto Scaling groups that specify\n InstanceRequirements.

\n
\n
lowest-price
\n
\n

Requests Spot Instances using the lowest priced pools within an\n Availability Zone, across the number of Spot pools that you specify for the\n SpotInstancePools property. To ensure that your desired\n capacity is met, you might receive Spot Instances from several pools. This\n is the default value, but it might lead to high interruption rates because\n this strategy only considers instance price and not available\n capacity.

\n
\n
price-capacity-optimized (recommended)
\n
\n

The price and capacity optimized allocation strategy looks at both price\n and capacity to select the Spot Instance pools that are the least likely to\n be interrupted and have the lowest possible price.

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

The allocation strategy to apply to your Spot Instances when they are launched.\n Possible instance types are determined by the launch template overrides that you\n specify.

\n

The following lists the valid values:

\n
\n
capacity-optimized
\n
\n

Requests Spot Instances using pools that are optimally chosen based on the\n available Spot capacity. This strategy has the lowest risk of interruption.\n To give certain instance types a higher chance of launching first, use\n capacity-optimized-prioritized.

\n
\n
capacity-optimized-prioritized
\n
\n

You set the order of instance types for the launch template overrides from\n highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors\n the instance type priorities on a best effort basis but optimizes for\n capacity first. Note that if the On-Demand allocation strategy is set to\n prioritized, the same priority is applied when fulfilling\n On-Demand capacity. This is not a valid value for Auto Scaling groups that specify\n InstanceRequirements.

\n
\n
lowest-price
\n
\n

Requests Spot Instances using the lowest priced pools within an\n Availability Zone, across the number of Spot pools that you specify for the\n SpotInstancePools property. To ensure that your desired\n capacity is met, you might receive Spot Instances from several pools. This\n is the default value, but it might lead to high interruption rates because\n this strategy only considers instance price and not available\n capacity.

\n
\n
price-capacity-optimized (recommended)
\n
\n

The price and capacity optimized allocation strategy looks at both price\n and capacity to select the Spot Instance pools that are the least likely to\n be interrupted and have the lowest possible price.

\n
\n
" } }, "SpotInstancePools": { @@ -7747,7 +7747,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the MemoryGiBPerVCpu object when\n you specify InstanceRequirements for an Auto Scaling group.

" + "smithy.api#documentation": "

Specifies the minimum and maximum for the MemoryGiBPerVCpu object when\n you specify InstanceRequirements for an Auto Scaling group.

" } }, "com.amazonaws.autoscaling#MemoryMiBRequest": { @@ -7769,7 +7769,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the MemoryMiB object when you\n specify InstanceRequirements for an Auto Scaling group.

" + "smithy.api#documentation": "

Specifies the minimum and maximum for the MemoryMiB object when you\n specify InstanceRequirements for an Auto Scaling group.

" } }, "com.amazonaws.autoscaling#Metric": { @@ -8094,7 +8094,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the NetworkBandwidthGbps object\n when you specify InstanceRequirements for an Auto Scaling group.

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve\n the minimum bandwidth. Amazon EC2 will identify instance types that support the specified\n minimum bandwidth, but the actual bandwidth of your instance might go below the\n specified minimum at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide for Linux Instances.

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

Specifies the minimum and maximum for the NetworkBandwidthGbps object\n when you specify InstanceRequirements for an Auto Scaling group.

\n \n

Setting the minimum bandwidth does not guarantee that your instance will achieve\n the minimum bandwidth. Amazon EC2 will identify instance types that support the specified\n minimum bandwidth, but the actual bandwidth of your instance might go below the\n specified minimum at times. For more information, see Available instance bandwidth in the\n Amazon EC2 User Guide for Linux Instances.

\n " } }, "com.amazonaws.autoscaling#NetworkInterfaceCountRequest": { @@ -8114,7 +8114,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the NetworkInterfaceCount object\n when you specify InstanceRequirements for an Auto Scaling group.

" + "smithy.api#documentation": "

Specifies the minimum and maximum for the NetworkInterfaceCount object\n when you specify InstanceRequirements for an Auto Scaling group.

" } }, "com.amazonaws.autoscaling#NoDevice": { @@ -8709,7 +8709,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a lifecycle hook for the specified Auto Scaling group.

\n

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    \n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.

\n

You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.

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

Creates or updates a lifecycle hook for the specified Auto Scaling group.

\n

Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance\n lifecycle, and then perform a custom action on instances when the corresponding\n lifecycle event occurs.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    \n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n

    \n
    5. \n
  5. \n

    If you need more time, record the lifecycle action heartbeat to keep the\n instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

\n

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.

\n

You can view the lifecycle hooks for an Auto Scaling group using the \n DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.

", "smithy.api#examples": [ { "title": "To create a launch lifecycle hook", @@ -8845,7 +8845,7 @@ "target": "com.amazonaws.autoscaling#AutoScalingNotificationTypes", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of event that causes the notification to be sent. To query the notification\n types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.

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

The type of event that causes the notification to be sent. To query the notification\n types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.

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

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.

\n

For more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

\n

For more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.

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

Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to\n scale an Auto Scaling group based on configurable metrics. If no policies are defined, the\n dynamic scaling and predictive scaling features are not used.

\n

For more information about using dynamic scaling, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.

\n

For more information about using predictive scaling, see Predictive\n scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

\n

You can view the scaling policies for an Auto Scaling group using the \n DescribePolicies API call. If you are no longer using a scaling policy,\n you can delete it by calling the DeletePolicy API.

", "smithy.api#examples": [ { "title": "To add a scaling policy to an Auto Scaling group", @@ -9018,7 +9018,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a scheduled scaling action for an Auto Scaling group.

\n

For more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

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

Creates or updates a scheduled scaling action for an Auto Scaling group.

\n

For more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.

\n

You can view the scheduled actions for an Auto Scaling group using the \n DescribeScheduledActions\n API call. If you are no longer using a scheduled action, you can delete it by calling the \n DeleteScheduledAction API.

\n

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.

", "smithy.api#examples": [ { "title": "To add a scheduled action to an Auto Scaling group", @@ -9122,7 +9122,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity.

\n

This operation must be called from the Region in which the Auto Scaling group was\n created.

\n

You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the\n DeleteWarmPool API.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

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

Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity.

\n

This operation must be called from the Region in which the Auto Scaling group was\n created.

\n

You can view the instances in the warm pool using the DescribeWarmPool API call.\n If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.

\n

For more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

", "smithy.api#examples": [ { "title": "To create a warm pool for an Auto Scaling group", @@ -9194,7 +9194,7 @@ } ], "traits": { - "smithy.api#documentation": "

Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    \n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

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

Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the \n PutLifecycleHook API call.

\n

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:

\n
    \n
  1. \n

    (Optional) Create a launch template or launch configuration with a user data\n script that runs while an instance is in a wait state due to a lifecycle\n hook.

    \n
    2. \n
  2. \n

    (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke\n your Lambda function when an instance is put into a wait state due to a\n lifecycle hook.

    \n
    3. \n
  3. \n

    (Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish\n lifecycle notifications to the target.

    \n
    4. \n
  4. \n

    Create the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.

    \n
    5. \n
  5. \n

    \n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a wait state.\n

    \n
    6. \n
  6. \n

    If you finish before the timeout period ends, send a callback by using the\n CompleteLifecycleAction API call.

    \n
    7. \n
\n

For more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.

", "smithy.api#examples": [ { "title": "To record a lifecycle action heartbeat", @@ -9481,7 +9481,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels an instance refresh that is in progress and rolls back any changes that it\n made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh.\n This restores your Auto Scaling group to the configuration that it was using before the start of\n the instance refresh.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

A rollback is not supported in the following situations:

\n
    \n
  • \n

    There is no desired configuration specified for the instance refresh.

    \n
    • \n
  • \n

    The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead\n of an AMI ID for the ImageId property.

    \n
    • \n
  • \n

    The Auto Scaling group uses the launch template's $Latest or\n $Default version.

    \n
    • \n
\n

When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately\n begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.

" + "smithy.api#documentation": "

Cancels an instance refresh that is in progress and rolls back any changes that it\n made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh.\n This restores your Auto Scaling group to the configuration that it was using before the start of\n the instance refresh.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

A rollback is not supported in the following situations:

\n
    \n
  • \n

    There is no desired configuration specified for the instance refresh.

    \n
    • \n
  • \n

    The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead\n of an AMI ID for the ImageId property.

    \n
    • \n
  • \n

    The Auto Scaling group uses the launch template's $Latest or\n $Default version.

    \n
    • \n
\n

When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately\n begins replacing instances. You can check the status of this operation through the \n DescribeInstanceRefreshes API operation.

" } }, "com.amazonaws.autoscaling#RollbackInstanceRefreshAnswer": { @@ -9918,7 +9918,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

" + "smithy.api#documentation": "

Describes information used for one or more scheduled scaling action updates in a \n BatchPutScheduledUpdateGroupAction\n operation.

" } }, "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests": { @@ -10209,7 +10209,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an instance refresh.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.

\n

If successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.

\n

An instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.

\n

If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.

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

Starts an instance refresh.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group.\n This feature is helpful, for example, when you have a new AMI or a new user data script.\n You just need to create a new launch template that specifies the new AMI or user data\n script. Then start an instance refresh to immediately begin the process of updating\n instances in the group.

\n

If successful, the request's response contains a unique ID that you can use to track\n the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API.\n To describe the instance refreshes that\n have already run, call the DescribeInstanceRefreshes API. To cancel an\n instance refresh that is in progress, use the CancelInstanceRefresh\n API.

\n

An instance refresh might fail for several reasons, such as EC2 launch failures,\n misconfigured health checks, or not ignoring or allowing the termination of instances\n that are in Standby state or protected from scale in. You can monitor for\n failed EC2 launches using the scaling activities. To find the scaling activities, call\n the DescribeScalingActivities API.

\n

If you enable auto rollback, your Auto Scaling group will be rolled back automatically when\n the instance refresh fails. You can enable this feature before starting an instance\n refresh by specifying the AutoRollback property in the instance refresh\n preferences. Otherwise, to roll back an instance refresh before it finishes, use the\n RollbackInstanceRefresh API.

", "smithy.api#examples": [ { "title": "To start an instance refresh", @@ -10334,7 +10334,7 @@ } ], "traits": { - "smithy.api#documentation": "

Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.

\n

If you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.

\n

To resume processes that have been suspended, call the ResumeProcesses API.

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

Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.

\n

If you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.

\n

To resume processes that have been suspended, call the ResumeProcesses API.

", "smithy.api#examples": [ { "title": "To suspend Auto Scaling processes", @@ -10695,7 +10695,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the TotalLocalStorageGB object when\n you specify InstanceRequirements for an Auto Scaling group.

" + "smithy.api#documentation": "

Specifies the minimum and maximum for the TotalLocalStorageGB object when\n you specify InstanceRequirements for an Auto Scaling group.

" } }, "com.amazonaws.autoscaling#TrafficSourceIdentifier": { @@ -10787,7 +10787,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Updates the configuration for the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n

\n

If you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.

\n

Note the following about changing DesiredCapacity, MaxSize,\n or MinSize:

\n
    \n
  • \n

    If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.

    \n
    • \n
  • \n

    If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.

    \n
    • \n
  • \n

    If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.

    \n
    • \n
\n

To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy\n API.

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

\n We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n

\n

Updates the configuration for the specified Auto Scaling group.

\n

To update an Auto Scaling group, specify the name of the group and the property that you want\n to change. Any properties that you don't specify are not changed by this update request.\n The new settings take effect on any scaling activities after this call returns.\n

\n

If you associate a new launch configuration or template with an Auto Scaling group, all new\n instances will get the updated configuration. Existing instances continue to run with\n the configuration that they were originally launched with. When you update a group to\n specify a mixed instances policy instead of a launch configuration or template, existing\n instances may be replaced to match the new purchasing options that you specified in the\n policy. For example, if the group currently has 100% On-Demand capacity and the policy\n specifies 50% Spot capacity, this means that half of your instances will be gradually\n terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches\n new instances before terminating the old ones, so that updating your group does not\n compromise the performance or availability of your application.

\n

Note the following about changing DesiredCapacity, MaxSize,\n or MinSize:

\n
    \n
  • \n

    If a scale-in activity occurs as a result of a new\n DesiredCapacity value that is lower than the current size of\n the group, the Auto Scaling group uses its termination policy to determine which\n instances to terminate.

    \n
    • \n
  • \n

    If you specify a new value for MinSize without specifying a value\n for DesiredCapacity, and the new MinSize is larger\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MinSize value.

    \n
    • \n
  • \n

    If you specify a new value for MaxSize without specifying a value\n for DesiredCapacity, and the new MaxSize is smaller\n than the current size of the group, this sets the group's\n DesiredCapacity to the new MaxSize value.

    \n
    • \n
\n

To see which properties have been set, call the DescribeAutoScalingGroups API.\n To view the scaling policies for an Auto Scaling\n group, call the DescribePolicies API. If the group has scaling\n policies, you can update them by calling the PutScalingPolicy API.

", "smithy.api#examples": [ { "title": "To update an Auto Scaling group", @@ -10878,9 +10878,9 @@ } }, "PlacementGroup": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "target": "com.amazonaws.autoscaling#UpdatePlacementGroupParam", "traits": { - "smithy.api#documentation": "

The name of an existing placement group into which to launch your instances. For more\n information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

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

The name of an existing placement group into which to launch your instances. To remove the placement group setting, pass an empty string for placement-group. For more\n information about placement groups, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.

\n \n

A cluster placement group is a logical grouping of instances\n within a single Availability Zone. You cannot specify multiple Availability Zones\n and a cluster placement group.

\n " } }, "VPCZoneIdentifier": { @@ -10945,6 +10945,16 @@ } } }, + "com.amazonaws.autoscaling#UpdatePlacementGroupParam": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, "com.amazonaws.autoscaling#VCpuCountRequest": { "type": "structure", "members": { @@ -10964,7 +10974,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the minimum and maximum for the VCpuCount object when you\n specify InstanceRequirements for an Auto Scaling group.

" + "smithy.api#documentation": "

Specifies the minimum and maximum for the VCpuCount object when you\n specify InstanceRequirements for an Auto Scaling group.

" } }, "com.amazonaws.autoscaling#Values": { diff --git a/codegen/sdk/aws-models/b2bi.json b/codegen/sdk/aws-models/b2bi.json index 962797f8120..796a567f582 100644 --- a/codegen/sdk/aws-models/b2bi.json +++ b/codegen/sdk/aws-models/b2bi.json @@ -30,6 +30,9 @@ "type": "service", "version": "2022-06-23", "operations": [ + { + "target": "com.amazonaws.b2bi#CreateStarterMappingTemplate" + }, { "target": "com.amazonaws.b2bi#GetTransformerJob" }, @@ -42,6 +45,9 @@ { "target": "com.amazonaws.b2bi#TagResource" }, + { + "target": "com.amazonaws.b2bi#TestConversion" + }, { "target": "com.amazonaws.b2bi#TestMapping" }, @@ -815,6 +821,23 @@ "smithy.api#documentation": "

A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

" } }, + "com.amazonaws.b2bi#CapabilityDirection": { + "type": "enum", + "members": { + "INBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INBOUND" + } + }, + "OUTBOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTBOUND" + } + } + } + }, "com.amazonaws.b2bi#CapabilityId": { "type": "string", "traits": { @@ -840,6 +863,20 @@ } } }, + "com.amazonaws.b2bi#CapabilityOptions": { + "type": "structure", + "members": { + "outboundEdi": { + "target": "com.amazonaws.b2bi#OutboundEdiOptions", + "traits": { + "smithy.api#documentation": "

A structure that contains the outbound EDI options.

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

Contains the details for an Outbound EDI capability.

" + } + }, "com.amazonaws.b2bi#CapabilitySummary": { "type": "structure", "members": { @@ -909,6 +946,94 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.b2bi#ConversionSource": { + "type": "structure", + "members": { + "fileFormat": { + "target": "com.amazonaws.b2bi#ConversionSourceFormat", + "traits": { + "smithy.api#documentation": "

The format for the input file: either JSON or XML.

", + "smithy.api#required": {} + } + }, + "inputFile": { + "target": "com.amazonaws.b2bi#InputFileSource", + "traits": { + "smithy.api#documentation": "File to be converted", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the input for an outbound transformation.

" + } + }, + "com.amazonaws.b2bi#ConversionSourceFormat": { + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "XML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XML" + } + } + } + }, + "com.amazonaws.b2bi#ConversionTarget": { + "type": "structure", + "members": { + "fileFormat": { + "target": "com.amazonaws.b2bi#ConversionTargetFormat", + "traits": { + "smithy.api#documentation": "

Currently, only X12 format is supported.

", + "smithy.api#required": {} + } + }, + "formatDetails": { + "target": "com.amazonaws.b2bi#ConversionTargetFormatDetails", + "traits": { + "smithy.api#documentation": "

A structure that contains the formatting details for the conversion target.

" + } + }, + "outputSampleFile": { + "target": "com.amazonaws.b2bi#OutputSampleFileSource", + "traits": { + "smithy.api#documentation": "Customer uses this to provide a sample on what should file look like after conversion\nX12 EDI use case around this would be discovering the file syntax" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provide a sample of what the output of the transformation should look like.

" + } + }, + "com.amazonaws.b2bi#ConversionTargetFormat": { + "type": "enum", + "members": { + "X12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12" + } + } + } + }, + "com.amazonaws.b2bi#ConversionTargetFormatDetails": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Details" + } + }, + "traits": { + "smithy.api#documentation": "

Contains a structure describing the X12 details for the conversion target.

" + } + }, "com.amazonaws.b2bi#CreateCapability": { "type": "operation", "input": { @@ -1246,6 +1371,12 @@ "smithy.api#required": {} } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "

Specify the structure that contains the details for the associated capabilities.

" + } + }, "clientToken": { "target": "smithy.api#String", "traits": { @@ -1313,6 +1444,12 @@ "smithy.api#documentation": "

Returns one or more capabilities associated with this partnership.

" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "

Returns the structure that contains the details for the associated capabilities.

" + } + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -1539,6 +1676,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.b2bi#CreateStarterMappingTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#CreateStarterMappingTemplateRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#CreateStarterMappingTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.

\n

If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template.\n The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it\n into the JSON or XML file that is used to generate the EDI.

\n

If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails parameter.\n

\n

Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.

", + "smithy.api#examples": [ + { + "title": "Sample CreateStarterMappingTemplate call", + "input": { + "mappingType": "JSONATA", + "templateDetails": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + }, + "outputSampleLocation": { + "bucketName": "output-sample-bucket", + "key": "output-sample-key" + } + }, + "output": { + "mappingTemplate": "Example Mapping Template" + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/createmappingstarttemplate", + "method": "POST" + } + } + }, + "com.amazonaws.b2bi#CreateStarterMappingTemplateRequest": { + "type": "structure", + "members": { + "outputSampleLocation": { + "target": "com.amazonaws.b2bi#S3Location", + "traits": { + "smithy.api#documentation": "

Specify the location of the sample EDI file that is used to generate the mapping template.

" + } + }, + "mappingType": { + "target": "com.amazonaws.b2bi#MappingType", + "traits": { + "smithy.api#documentation": "

Specify the format for the mapping template: either JSONATA or XSLT.

", + "smithy.api#required": {} + } + }, + "templateDetails": { + "target": "com.amazonaws.b2bi#TemplateDetails", + "traits": { + "smithy.api#documentation": "

\n Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used:\n currently, we only support X12.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#CreateStarterMappingTemplateResponse": { + "type": "structure", + "members": { + "mappingTemplate": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Returns a string that represents the mapping template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.b2bi#CreateTransformer": { "type": "operation", "input": { @@ -1572,24 +1804,46 @@ ], "traits": { "aws.iam#requiredActions": [ - "b2bi:TagResource" + "b2bi:TagResource", + "b2bi:UpdateTransformer", + "logs:CreateLogDelivery", + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:DescribeLogGroups", + "logs:DescribeLogStreams", + "logs:DescribeResourcePolicies", + "logs:ListLogDeliveries", + "logs:PutLogEvents", + "logs:PutResourcePolicy" ], - "smithy.api#documentation": "

Creates a transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.

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

Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:

\n
    \n
  • \n

    \n Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange \n converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer,\n in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.

    \n
    • \n
  • \n

    \n Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use\n in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate\n a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

    \n
    • \n
\n \n

The following fields are provided for backwards compatibility only: fileFormat,\n mappingTemplate, ediType, and sampleDocument.

\n
    \n
  • \n

    Use the mapping data type in place of mappingTemplate and fileFormat\n

    \n
    • \n
  • \n

    Use the sampleDocuments data type in place of sampleDocument\n

    \n
    • \n
  • \n

    Use either the inputConversion or outputConversion in place of ediType\n

    \n
    • \n
\n ", "smithy.api#examples": [ { "title": "Sample CreateTransformer call", "input": { "clientToken": "foo", - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "name": "transformX12", + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "{}", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, "tags": [ { "Key": "sampleKey", @@ -1599,16 +1853,28 @@ }, "output": { "createdAt": "2023-11-01T21:51:05.504Z", - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "name": "transformX12", + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "$", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, "status": "inactive", "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", "transformerId": "tr-974c129999f84d8c9" @@ -1633,45 +1899,78 @@ "smithy.api#required": {} } }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.b2bi#TagList", + "traits": { + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

" + } + }, "fileFormat": { "target": "com.amazonaws.b2bi#FileFormat", "traits": { - "smithy.api#documentation": "

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

" } }, "mappingTemplate": { "target": "com.amazonaws.b2bi#MappingTemplate", "traits": { - "smithy.api#documentation": "

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

\n \n

This parameter is available for backwards compatibility. Use the Mapping data type instead.

\n " } }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "

Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" } }, - "clientToken": { - "target": "smithy.api#String", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "

Reserved for future use.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

Specify the InputConversion object, which contains the format options for the inbound transformation.

" } }, - "tags": { - "target": "com.amazonaws.b2bi#TagList", + "mapping": { + "target": "com.amazonaws.b2bi#Mapping", "traits": { - "aws.cloudformation#cfnMutability": "full", - "smithy.api#documentation": "

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

" + "smithy.api#documentation": "

Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).

" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "

A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.

" + } + }, + "sampleDocuments": { + "target": "com.amazonaws.b2bi#SampleDocuments", + "traits": { + "smithy.api#documentation": "

Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

" } } }, @@ -1703,20 +2002,6 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", - "traits": { - "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

", - "smithy.api#required": {} - } - }, - "mappingTemplate": { - "target": "com.amazonaws.b2bi#MappingTemplate", - "traits": { - "smithy.api#documentation": "

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

", - "smithy.api#required": {} - } - }, "status": { "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { @@ -1724,24 +2009,75 @@ "smithy.api#required": {} } }, - "ediType": { - "target": "com.amazonaws.b2bi#EdiType", + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", "traits": { - "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

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

Returns a timestamp for creation date and time of the transformer.

", "smithy.api#required": {} } }, - "sampleDocument": { - "target": "com.amazonaws.b2bi#FileLocation", + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", "traits": { - "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", "traits": { - "smithy.api#documentation": "

Returns a timestamp for creation date and time of the transformer.

", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

" + } + }, + "ediType": { + "target": "com.amazonaws.b2bi#EdiType", + "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" + } + }, + "sampleDocument": { + "target": "com.amazonaws.b2bi#FileLocation", + "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" + } + }, + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", + "traits": { + "smithy.api#documentation": "

Returns the InputConversion object, which contains the format options for the inbound transformation.

" + } + }, + "mapping": { + "target": "com.amazonaws.b2bi#Mapping", + "traits": { + "smithy.api#documentation": "

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "

Returns the OutputConversion object, which contains the format options for the outbound transformation.

" + } + }, + "sampleDocuments": { + "target": "com.amazonaws.b2bi#SampleDocuments", + "traits": { + "smithy.api#documentation": "

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

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

Deletes the specified transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.

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

Deletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

", "smithy.api#examples": [ { "title": "Sample DeleteTransformer call", @@ -2010,6 +2346,12 @@ "com.amazonaws.b2bi#EdiConfiguration": { "type": "structure", "members": { + "capabilityDirection": { + "target": "com.amazonaws.b2bi#CapabilityDirection", + "traits": { + "smithy.api#documentation": "

Specifies whether this is capability is for inbound or outbound transformations.

" + } + }, "type": { "target": "com.amazonaws.b2bi#EdiType", "traits": { @@ -2054,7 +2396,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" + "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer.\n Currently, only X12 is supported. X12 is a set of standards and corresponding messages \n that define specific business documents.

" } }, "com.amazonaws.b2bi#Email": { @@ -2091,6 +2433,12 @@ "traits": { "smithy.api#enumValue": "JSON" } + }, + "NOT_USED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_USED" + } } } }, @@ -2103,6 +2451,28 @@ } } }, + "com.amazonaws.b2bi#FormatOptions": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Details" + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the X12 transaction set and version.

" + } + }, + "com.amazonaws.b2bi#FromFormat": { + "type": "enum", + "members": { + "X12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12" + } + } + } + }, "com.amazonaws.b2bi#GetCapability": { "type": "operation", "input": { @@ -2378,6 +2748,9 @@ "smithy.api#documentation": "

Returns one or more capabilities associated with this partnership.

" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions" + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -2575,7 +2948,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the details for the transformer specified by the transformer ID. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.

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

Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

", "smithy.api#examples": [ { "title": "Sample GetTransformer call", @@ -2584,17 +2957,28 @@ }, "output": { "createdAt": "2023-11-01T21:51:05.504Z", - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "name": "transformX12", + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "$", - "modifiedAt": "2023-11-01T21:51:05.504Z", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, "status": "inactive", "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", "transformerId": "tr-974c129999f84d8c9" @@ -2753,51 +3137,88 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { - "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

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

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

", "smithy.api#required": {} } }, - "mappingTemplate": { - "target": "com.amazonaws.b2bi#MappingTemplate", + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", "traits": { - "smithy.api#documentation": "

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

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

Returns a timestamp for creation date and time of the transformer.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", "traits": { - "smithy.api#documentation": "

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

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

Returns a timestamp for last time the transformer was modified.

" + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

" + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

" } }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "

Returns a timestamp for creation date and time of the transformer.

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

Returns the InputConversion object, which contains the format options for the inbound transformation.

" } }, - "modifiedAt": { - "target": "com.amazonaws.b2bi#ModifiedDate", + "mapping": { + "target": "com.amazonaws.b2bi#Mapping", "traits": { - "smithy.api#documentation": "

Returns a timestamp for last time the transformer was modified.

" + "smithy.api#documentation": "

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "

Returns the OutputConversion object, which contains the format options for the outbound transformation.

" + } + }, + "sampleDocuments": { + "target": "com.amazonaws.b2bi#SampleDocuments", + "traits": { + "smithy.api#documentation": "

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

" } } }, @@ -2805,6 +3226,45 @@ "smithy.api#output": {} } }, + "com.amazonaws.b2bi#InputConversion": { + "type": "structure", + "members": { + "fromFormat": { + "target": "com.amazonaws.b2bi#FromFormat", + "traits": { + "smithy.api#documentation": "

The format for the transformer input: currently on X12 is supported.

", + "smithy.api#required": {} + } + }, + "formatOptions": { + "target": "com.amazonaws.b2bi#FormatOptions", + "traits": { + "smithy.api#documentation": "

A structure that contains the formatting options for an inbound transformer.

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

Contains the input formatting options for an inbound transformer (takes an X12-formatted\n EDI document as input and converts it to JSON or XML.

" + } + }, + "com.amazonaws.b2bi#InputFileSource": { + "type": "union", + "members": { + "fileContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Specify the input contents, as a string, for the source of an outbound transformation.

", + "smithy.api#length": { + "min": 1, + "max": 5000000 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The input file to use for an outbound transformation.

" + } + }, "com.amazonaws.b2bi#InstructionsDocuments": { "type": "list", "member": { @@ -2841,6 +3301,12 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.b2bi#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.b2bi#SampleDocumentKeys" + } + }, "com.amazonaws.b2bi#ListCapabilities": { "type": "operation", "input": { @@ -3261,7 +3727,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the available transformers. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.

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

Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

", "smithy.api#examples": [ { "title": "Sample ListTransformers call", @@ -3375,6 +3841,27 @@ } } }, + "com.amazonaws.b2bi#Mapping": { + "type": "structure", + "members": { + "templateLanguage": { + "target": "com.amazonaws.b2bi#MappingTemplateLanguage", + "traits": { + "smithy.api#documentation": "

The transformation language for the template, either XSLT or JSONATA.

", + "smithy.api#required": {} + } + }, + "template": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#documentation": "

A string that represents the mapping template, in the transformation language specified in templateLanguage.

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

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

" + } + }, "com.amazonaws.b2bi#MappingTemplate": { "type": "string", "traits": { @@ -3384,6 +3871,40 @@ } } }, + "com.amazonaws.b2bi#MappingTemplateLanguage": { + "type": "enum", + "members": { + "XSLT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSLT" + } + }, + "JSONATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONATA" + } + } + } + }, + "com.amazonaws.b2bi#MappingType": { + "type": "enum", + "members": { + "JSONATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONATA" + } + }, + "XSLT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XSLT" + } + } + } + }, "com.amazonaws.b2bi#MaxResults": { "type": "integer", "traits": { @@ -3399,6 +3920,52 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.b2bi#OutboundEdiOptions": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Envelope", + "traits": { + "smithy.api#documentation": "

A structure that contains an X12 envelope structure.

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

A container for outbound EDI options.

" + } + }, + "com.amazonaws.b2bi#OutputConversion": { + "type": "structure", + "members": { + "toFormat": { + "target": "com.amazonaws.b2bi#ToFormat", + "traits": { + "smithy.api#documentation": "

The format for the output from an outbound transformer: only X12 is currently supported.

", + "smithy.api#required": {} + } + }, + "formatOptions": { + "target": "com.amazonaws.b2bi#FormatOptions", + "traits": { + "smithy.api#documentation": "

A structure that contains the X12 transaction set and version for the transformer output.

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

Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).

" + } + }, + "com.amazonaws.b2bi#OutputSampleFileSource": { + "type": "union", + "members": { + "fileLocation": { + "target": "com.amazonaws.b2bi#S3Location" + } + }, + "traits": { + "smithy.api#documentation": "

Container for the location of a sample file used for outbound transformations.

" + } + }, "com.amazonaws.b2bi#PageToken": { "type": "string", "traits": { @@ -3505,6 +4072,9 @@ "smithy.api#documentation": "

Returns one or more capabilities associated with this partnership.

" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions" + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -3717,7 +4287,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File\n locations in Amazon S3 are identified using a combination of the bucket and key.

" + "smithy.api#documentation": "

Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File\n locations in Amazon S3 are identified using a combination of the bucket and key.

" } }, "com.amazonaws.b2bi#S3LocationList": { @@ -3726,6 +4296,48 @@ "target": "com.amazonaws.b2bi#S3Location" } }, + "com.amazonaws.b2bi#SampleDocumentKeys": { + "type": "structure", + "members": { + "input": { + "target": "com.amazonaws.b2bi#S3Key", + "traits": { + "smithy.api#documentation": "

An array of keys for your input sample documents.

" + } + }, + "output": { + "target": "com.amazonaws.b2bi#S3Key", + "traits": { + "smithy.api#documentation": "

An array of keys for your output sample documents.

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

An array of the Amazon S3 keys used to identify the location for your sample documents.

" + } + }, + "com.amazonaws.b2bi#SampleDocuments": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.b2bi#BucketName", + "traits": { + "smithy.api#documentation": "

Contains the Amazon S3 bucket that is used to hold your sample documents.

", + "smithy.api#required": {} + } + }, + "keys": { + "target": "com.amazonaws.b2bi#KeyList", + "traits": { + "smithy.api#documentation": "

Contains an array of the Amazon S3 keys used to identify the location for your sample documents.

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

Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

" + } + }, "com.amazonaws.b2bi#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -3799,7 +4411,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.

\n

If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just\n create and configure a transformer, and then run the StartTransformerJob API to process your files.

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

Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.

\n

If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just\n create and configure a transformer, and then run the StartTransformerJob API to process your files.

", "smithy.api#examples": [ { "title": "Sample StartTransformerJob call", @@ -4010,13 +4622,24 @@ } } }, - "com.amazonaws.b2bi#TestMapping": { + "com.amazonaws.b2bi#TemplateDetails": { + "type": "union", + "members": { + "x12": { + "target": "com.amazonaws.b2bi#X12Details" + } + }, + "traits": { + "smithy.api#documentation": "

A data structure that contains the information to use when generating a mapping template.

" + } + }, + "com.amazonaws.b2bi#TestConversion": { "type": "operation", "input": { - "target": "com.amazonaws.b2bi#TestMappingRequest" + "target": "com.amazonaws.b2bi#TestConversionRequest" }, "output": { - "target": "com.amazonaws.b2bi#TestMappingResponse" + "target": "com.amazonaws.b2bi#TestConversionResponse" }, "errors": [ { @@ -4036,17 +4659,121 @@ } ], "traits": { - "smithy.api#documentation": "

Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent parameter.

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

This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.

", "smithy.api#examples": [ { - "title": "Sample TestMapping call", + "title": "Sample TestConversion call", "input": { - "fileFormat": "JSON", - "inputFileContent": "Sample file content", - "mappingTemplate": "$" + "source": { + "fileFormat": "JSON", + "inputFile": { + "fileContent": "Sample file content" + } + }, + "target": { + "fileFormat": "X12", + "formatDetails": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } + } + } }, "output": { - "mappedFileContent": "Sample file content" + "convertedFileContent": "Sample converted file content", + "validationMessages": [] + } + } + ], + "smithy.api#http": { + "code": 200, + "uri": "/testconversion", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.b2bi#TestConversionRequest": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.b2bi#ConversionSource", + "traits": { + "smithy.api#documentation": "

Specify the source file for an outbound EDI request.

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

Specify the format (X12 is the only currently supported format), and other details for the conversion target.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.b2bi#TestConversionResponse": { + "type": "structure", + "members": { + "convertedFileContent": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Returns the converted file content.

", + "smithy.api#required": {} + } + }, + "validationMessages": { + "target": "com.amazonaws.b2bi#ValidationMessages", + "traits": { + "smithy.api#documentation": "

Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.b2bi#TestMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.b2bi#TestMappingRequest" + }, + "output": { + "target": "com.amazonaws.b2bi#TestMappingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.b2bi#AccessDeniedException" + }, + { + "target": "com.amazonaws.b2bi#InternalServerException" + }, + { + "target": "com.amazonaws.b2bi#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.b2bi#ThrottlingException" + }, + { + "target": "com.amazonaws.b2bi#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent parameter.

", + "smithy.api#examples": [ + { + "title": "Sample TestMapping call", + "input": { + "fileFormat": "JSON", + "inputFileContent": "Sample file content", + "mappingTemplate": "$" + }, + "output": { + "mappedFileContent": "Sample file content" } } ], @@ -4080,7 +4807,7 @@ "mappingTemplate": { "target": "com.amazonaws.b2bi#MappingTemplate", "traits": { - "smithy.api#documentation": "

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

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

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

\n \n

This parameter is available for backwards compatibility. Use the Mapping data type instead.

\n ", "smithy.api#required": {} } }, @@ -4235,6 +4962,17 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.b2bi#ToFormat": { + "type": "enum", + "members": { + "X12": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X12" + } + } + } + }, "com.amazonaws.b2bi#TradingPartnerId": { "type": "string", "traits": { @@ -4337,7 +5075,8 @@ "smithy.api#length": { "min": 1, "max": 254 - } + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,512}$" } }, "com.amazonaws.b2bi#TransformerStatus": { @@ -4374,56 +5113,93 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { - "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

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

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

", "smithy.api#required": {} } }, - "mappingTemplate": { - "target": "com.amazonaws.b2bi#MappingTemplate", + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", "traits": { - "smithy.api#documentation": "

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

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

Returns a timestamp indicating when the transformer was created. For example,\n 2023-07-20T19:58:44.624Z.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", "traits": { - "smithy.api#documentation": "

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

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

Returns a timestamp representing the date and time for the most recent change for the transformer object.

" + } + }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

" + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

" } }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "

Returns a timestamp indicating when the transformer was created. For example,\n 2023-07-20T19:58:44.624Z.

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

Returns a structure that contains the format options for the transformation.

" } }, - "modifiedAt": { - "target": "com.amazonaws.b2bi#ModifiedDate", + "mapping": { + "target": "com.amazonaws.b2bi#Mapping", "traits": { - "smithy.api#documentation": "

Returns a timestamp representing the date and time for the most recent change for the transformer object.

" + "smithy.api#documentation": "

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "

Returns the OutputConversion object, which contains the format options for the outbound transformation.

" + } + }, + "sampleDocuments": { + "target": "com.amazonaws.b2bi#SampleDocuments", + "traits": { + "smithy.api#documentation": "

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

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

Contains the details for a transformer object. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.

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

Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

", "smithy.api#references": [ { "resource": "com.amazonaws.b2bi#Transformer" @@ -4796,6 +5572,12 @@ "traits": { "smithy.api#documentation": "

List of the capabilities associated with this partnership.

" } + }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "

To update, specify the structure that contains the details for the associated capabilities.

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

Returns one or more capabilities associated with this partnership.

" } }, + "capabilityOptions": { + "target": "com.amazonaws.b2bi#CapabilityOptions", + "traits": { + "smithy.api#documentation": "

Returns the structure that contains the details for the associated capabilities.

" + } + }, "tradingPartnerId": { "target": "com.amazonaws.b2bi#TradingPartnerId", "traits": { @@ -5093,39 +5881,63 @@ "b2bi:TagResource", "b2bi:UntagResource" ], - "smithy.api#documentation": "

Updates the specified parameters for a transformer. A transformer\n describes how to process the incoming EDI documents and extract the necessary\n information to the output file.

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

Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively,\n a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

", "smithy.api#examples": [ { "title": "Sample UpdateTransformer call", "input": { - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "{}", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, + "name": "transformX12", "status": "inactive", "transformerId": "tr-974c129999f84d8c9" }, "output": { "createdAt": "2023-11-01T21:51:05.504Z", - "ediType": { - "x12Details": { - "transactionSet": "X12_110", - "version": "VERSION_4010" + "modifiedAt": "2023-11-02T22:31:05.504Z", + "name": "transformX12", + "inputConversion": { + "fromFormat": "X12", + "formatOptions": { + "x12": { + "transactionSet": "X12_110", + "version": "VERSION_4010" + } } }, - "fileFormat": "JSON", - "mappingTemplate": "$", - "modifiedAt": "2023-11-01T21:51:05.504Z", - "name": "transformJSON", - "sampleDocument": "s3://test-bucket/sampleDoc.txt", + "mapping": { + "templateLanguage": "JSONATA", + "template": "{}" + }, + "sampleDocuments": { + "bucketName": "test-bucket", + "keys": [ + { + "input": "sampleDoc.txt" + } + ] + }, "status": "inactive", - "transformerArn": "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9", + "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9", "transformerId": "tr-974c129999f84d8c9" } } @@ -5155,35 +5967,71 @@ "smithy.api#documentation": "

Specify a new name for the transformer, if you want to update it.

" } }, + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", + "traits": { + "smithy.api#documentation": "

Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.

" + } + }, "fileFormat": { "target": "com.amazonaws.b2bi#FileFormat", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

" } }, "mappingTemplate": { "target": "com.amazonaws.b2bi#MappingTemplate", "traits": { - "smithy.api#documentation": "

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

" - } - }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", - "traits": { - "smithy.api#documentation": "

Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.

" + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

\n \n

This parameter is available for backwards compatibility. Use the Mapping data type instead.

\n " } }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "

Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" } + }, + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", + "traits": { + "smithy.api#documentation": "

To update, specify the InputConversion object, which contains the format options for the inbound transformation.

" + } + }, + "mapping": { + "target": "com.amazonaws.b2bi#Mapping", + "traits": { + "smithy.api#documentation": "

Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).

" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "

To update, specify the OutputConversion object, which contains the format options for the outbound transformation.

" + } + }, + "sampleDocuments": { + "target": "com.amazonaws.b2bi#SampleDocuments", + "traits": { + "smithy.api#documentation": "

Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

" + } } }, "traits": { @@ -5214,52 +6062,89 @@ "smithy.api#required": {} } }, - "fileFormat": { - "target": "com.amazonaws.b2bi#FileFormat", + "status": { + "target": "com.amazonaws.b2bi#TransformerStatus", "traits": { - "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

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

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

", "smithy.api#required": {} } }, - "mappingTemplate": { - "target": "com.amazonaws.b2bi#MappingTemplate", + "createdAt": { + "target": "com.amazonaws.b2bi#CreatedDate", "traits": { - "smithy.api#documentation": "

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

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

Returns a timestamp for creation date and time of the transformer.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.b2bi#TransformerStatus", + "modifiedAt": { + "target": "com.amazonaws.b2bi#ModifiedDate", "traits": { - "smithy.api#documentation": "

Returns the state of the newly created transformer. The transformer can be either\n active or inactive. For the transformer to be used in a\n capability, its status must active.

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

Returns a timestamp for last time the transformer was modified.

", "smithy.api#required": {} } }, + "fileFormat": { + "target": "com.amazonaws.b2bi#FileFormat", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns that the currently supported file formats for EDI transformations are JSON and XML.

" + } + }, + "mappingTemplate": { + "target": "com.amazonaws.b2bi#MappingTemplate", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "NOT_USED", + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

" + } + }, "ediType": { "target": "com.amazonaws.b2bi#EdiType", "traits": { - "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, + "smithy.api#documentation": "

Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

" } }, "sampleDocument": { "target": "com.amazonaws.b2bi#FileLocation", "traits": { + "smithy.api#deprecated": { + "message": "This is a legacy trait. Please use input-conversion or output-conversion." + }, "smithy.api#documentation": "

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

" } }, - "createdAt": { - "target": "com.amazonaws.b2bi#CreatedDate", + "inputConversion": { + "target": "com.amazonaws.b2bi#InputConversion", "traits": { - "smithy.api#documentation": "

Returns a timestamp for creation date and time of the transformer.

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

Returns the InputConversion object, which contains the format options for the inbound transformation.

" } }, - "modifiedAt": { - "target": "com.amazonaws.b2bi#ModifiedDate", + "mapping": { + "target": "com.amazonaws.b2bi#Mapping", "traits": { - "smithy.api#documentation": "

Returns a timestamp for last time the transformer was modified.

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

Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

" + } + }, + "outputConversion": { + "target": "com.amazonaws.b2bi#OutputConversion", + "traits": { + "smithy.api#documentation": "

Returns the OutputConversion object, which contains the format options for the outbound transformation.

" + } + }, + "sampleDocuments": { + "target": "com.amazonaws.b2bi#SampleDocuments", + "traits": { + "smithy.api#documentation": "

Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

" } } }, @@ -5283,6 +6168,88 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.b2bi#ValidationMessages": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.b2bi#X12AcknowledgmentRequestedCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ApplicationReceiverCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ApplicationSenderCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ComponentSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12DataElementSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12Delimiters": { + "type": "structure", + "members": { + "componentSeparator": { + "target": "com.amazonaws.b2bi#X12ComponentSeparator", + "traits": { + "smithy.api#documentation": "

The component, or sub-element, separator. The default value is : (colon).

" + } + }, + "dataElementSeparator": { + "target": "com.amazonaws.b2bi#X12DataElementSeparator", + "traits": { + "smithy.api#documentation": "

The data element separator. The default value is * (asterisk).

" + } + }, + "segmentTerminator": { + "target": "com.amazonaws.b2bi#X12SegmentTerminator", + "traits": { + "smithy.api#documentation": "

The segment terminator. The default value is ~ (tilde).

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

In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.\n The delimiters are part of the message's syntax and divide up its different elements.

" + } + }, "com.amazonaws.b2bi#X12Details": { "type": "structure", "members": { @@ -5295,7 +6262,7 @@ "version": { "target": "com.amazonaws.b2bi#X12Version", "traits": { - "smithy.api#documentation": "

Returns the version to use for the specified X12 transaction set.\n \n \n \n

" + "smithy.api#documentation": "

Returns the version to use for the specified X12 transaction set.

" } } }, @@ -5303,6 +6270,187 @@ "smithy.api#documentation": "

A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

\n \n

If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

\n " } }, + "com.amazonaws.b2bi#X12Envelope": { + "type": "structure", + "members": { + "common": { + "target": "com.amazonaws.b2bi#X12OutboundEdiHeaders", + "traits": { + "smithy.api#documentation": "

A container for the X12 outbound EDI headers.

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

A wrapper structure for an X12 definition object.

\n

the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:

\n
    \n
  • \n

    Interchange Envelope

    \n
    • \n
  • \n

    Functional Group

    \n
    • \n
  • \n

    Transaction Set

    \n
    • \n
" + } + }, + "com.amazonaws.b2bi#X12FunctionalGroupHeaders": { + "type": "structure", + "members": { + "applicationSenderCode": { + "target": "com.amazonaws.b2bi#X12ApplicationSenderCode", + "traits": { + "smithy.api#documentation": "

A value representing the code used to identify the party transmitting a message, at position GS-02.

" + } + }, + "applicationReceiverCode": { + "target": "com.amazonaws.b2bi#X12ApplicationReceiverCode", + "traits": { + "smithy.api#documentation": "

A value representing the code used to identify the party receiving a message, at position GS-03.

" + } + }, + "responsibleAgencyCode": { + "target": "com.amazonaws.b2bi#X12ResponsibleAgencyCode", + "traits": { + "smithy.api#documentation": "

A code that identifies the issuer of the standard, at position GS-07.

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

Part of the X12 message structure. These are the functional group headers for the X12 EDI object.

" + } + }, + "com.amazonaws.b2bi#X12IdQualifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12InterchangeControlHeaders": { + "type": "structure", + "members": { + "senderIdQualifier": { + "target": "com.amazonaws.b2bi#X12IdQualifier", + "traits": { + "smithy.api#documentation": "

Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

" + } + }, + "senderId": { + "target": "com.amazonaws.b2bi#X12SenderId", + "traits": { + "smithy.api#documentation": "

Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

" + } + }, + "receiverIdQualifier": { + "target": "com.amazonaws.b2bi#X12IdQualifier", + "traits": { + "smithy.api#documentation": "

Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

" + } + }, + "receiverId": { + "target": "com.amazonaws.b2bi#X12ReceiverId", + "traits": { + "smithy.api#documentation": "

Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

" + } + }, + "repetitionSeparator": { + "target": "com.amazonaws.b2bi#X12RepetitionSeparator", + "traits": { + "smithy.api#documentation": "

Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

\n \n

This parameter is only honored for version greater than 401 (VERSION_4010 and higher).

\n

For versions less than 401, this field is called StandardsId, in which case our service\n sets the value to U.

\n " + } + }, + "acknowledgmentRequestedCode": { + "target": "com.amazonaws.b2bi#X12AcknowledgmentRequestedCode", + "traits": { + "smithy.api#documentation": "

Located at position ISA-14 in the header. The value \"1\" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value \"0\" is used otherwise.

" + } + }, + "usageIndicatorCode": { + "target": "com.amazonaws.b2bi#X12UsageIndicatorCode", + "traits": { + "smithy.api#documentation": "

Located at position ISA-15 in the header. Specifies how this interchange is being used:

\n
    \n
  • \n

    \n T indicates this interchange is for testing.

    \n
    • \n
  • \n

    \n P indicates this interchange is for production.

    \n
    • \n
  • \n

    \n I indicates this interchange is informational.

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

In X12, the Interchange Control Header is the first segment of an EDI document and is\n part of the Interchange Envelope. It contains information about the sender and receiver,\n the date and time of transmission, and the X12 version being used. It also includes\n delivery information, such as the sender and receiver IDs.

" + } + }, + "com.amazonaws.b2bi#X12OutboundEdiHeaders": { + "type": "structure", + "members": { + "interchangeControlHeaders": { + "target": "com.amazonaws.b2bi#X12InterchangeControlHeaders", + "traits": { + "smithy.api#documentation": "

In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

" + } + }, + "functionalGroupHeaders": { + "target": "com.amazonaws.b2bi#X12FunctionalGroupHeaders", + "traits": { + "smithy.api#documentation": "

The functional group headers for the X12 object.

" + } + }, + "delimiters": { + "target": "com.amazonaws.b2bi#X12Delimiters", + "traits": { + "smithy.api#documentation": "

The delimiters, for example semicolon (;), that separates sections of the headers for the X12 object.

" + } + }, + "validateEdi": { + "target": "com.amazonaws.b2bi#X12ValidateEdi", + "traits": { + "smithy.api#documentation": "

Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.

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

A structure containing the details for an outbound EDI object.

" + } + }, + "com.amazonaws.b2bi#X12ReceiverId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12RepetitionSeparator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.b2bi#X12ResponsibleAgencyCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12SegmentTerminator": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[!&'()*+,\\-./:;?=%@\\[\\]_{}|<>~^`\"]$" + } + }, + "com.amazonaws.b2bi#X12SenderId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 15 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, "com.amazonaws.b2bi#X12TransactionSet": { "type": "enum", "members": { @@ -5758,6 +6906,19 @@ } } }, + "com.amazonaws.b2bi#X12UsageIndicatorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.b2bi#X12ValidateEdi": { + "type": "boolean" + }, "com.amazonaws.b2bi#X12Version": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/bedrock-agent-runtime.json b/codegen/sdk/aws-models/bedrock-agent-runtime.json index b5b293bf4c5..77ceee91fe7 100644 --- a/codegen/sdk/aws-models/bedrock-agent-runtime.json +++ b/codegen/sdk/aws-models/bedrock-agent-runtime.json @@ -1064,7 +1064,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))))|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]{1,10})?:bedrock:[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]{1,20}/)?)?([a-z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$" } }, "com.amazonaws.bedrockagentruntime#ByteContentBlob": { @@ -1504,26 +1504,26 @@ "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { - "smithy.api#documentation": "

The modelArn used with the external source wrapper object in the retrieveAndGenerate function.

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

The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate function.

", "smithy.api#required": {} } }, "sources": { "target": "com.amazonaws.bedrockagentruntime#ExternalSources", "traits": { - "smithy.api#documentation": "

The document used with the external source wrapper object in the retrieveAndGenerate function.

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

The document for the external source wrapper object in the retrieveAndGenerate function.

", "smithy.api#required": {} } }, "generationConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesGenerationConfiguration", "traits": { - "smithy.api#documentation": "

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

" + "smithy.api#documentation": "

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

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

The configurations of the external source wrapper object in the retrieveAndGenerate function.

" + "smithy.api#documentation": "

The configurations of the external source wrapper object in the retrieveAndGenerate function.

" } }, "com.amazonaws.bedrockagentruntime#FailureReasonString": { @@ -4012,11 +4012,28 @@ "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration": { "type": "structure", "members": { + "promptTemplate": { + "target": "com.amazonaws.bedrockagentruntime#PromptTemplate", + "traits": { + "smithy.api#documentation": "

Contains the template for the prompt that's sent to the model for response generation.

" + } + }, + "inferenceConfig": { + "target": "com.amazonaws.bedrockagentruntime#InferenceConfig", + "traits": { + "smithy.api#documentation": "

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

" + } + }, + "additionalModelRequestFields": { + "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", + "traits": { + "smithy.api#documentation": "

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

" + } + }, "queryTransformationConfiguration": { "target": "com.amazonaws.bedrockagentruntime#QueryTransformationConfiguration", "traits": { - "smithy.api#documentation": "

To split up the prompt and retrieve multiple sources, set the transformation type to\n QUERY_DECOMPOSITION.

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

To split up the prompt and retrieve multiple sources, set the transformation type to\n QUERY_DECOMPOSITION.

" } } }, @@ -4042,7 +4059,7 @@ "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { - "smithy.api#documentation": "

Contains information about the foundation model output.

" + "smithy.api#documentation": "

Contains information about the foundation model output from the orchestration step.

" } } }, @@ -4217,6 +4234,18 @@ "traits": { "smithy.api#documentation": "

Details about the response from the Lambda parsing of the output of the post-processing step.

" } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse", + "traits": { + "smithy.api#documentation": "

\n Details of the raw response from the foundation model output.\n

" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "

\n Contains information about the foundation model output from the post-processing step.\n

" + } } }, "traits": { @@ -4274,6 +4303,18 @@ "traits": { "smithy.api#documentation": "

Details about the response from the Lambda parsing of the output of the pre-processing step.

" } + }, + "rawResponse": { + "target": "com.amazonaws.bedrockagentruntime#RawResponse", + "traits": { + "smithy.api#documentation": "

\n Details of the raw response from the foundation model output.\n

" + } + }, + "metadata": { + "target": "com.amazonaws.bedrockagentruntime#Metadata", + "traits": { + "smithy.api#documentation": "

\n Contains information about the foundation model output from the pre-processing step.\n

" + } } }, "traits": { @@ -5038,20 +5079,20 @@ "type": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType", "traits": { - "smithy.api#documentation": "

The type of resource that is queried by the request.

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

The type of resource that contains your data for retrieving information and generating responses.

\n

If you choose ot use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

", "smithy.api#required": {} } }, "knowledgeBaseConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrieveAndGenerateConfiguration", "traits": { - "smithy.api#documentation": "

Contains details about the resource being queried.

" + "smithy.api#documentation": "

Contains details about the knowledge base for retrieving information and generating responses.

" } }, "externalSourcesConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration", "traits": { - "smithy.api#documentation": "

The configuration used with the external source wrapper object in the retrieveAndGenerate function.

" + "smithy.api#documentation": "

The configuration for the external source wrapper object in the retrieveAndGenerate function.

" } } }, diff --git a/codegen/sdk/aws-models/bedrock-agent.json b/codegen/sdk/aws-models/bedrock-agent.json index b78911e16a8..4b35434ba21 100644 --- a/codegen/sdk/aws-models/bedrock-agent.json +++ b/codegen/sdk/aws-models/bedrock-agent.json @@ -3319,7 +3319,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.

\n \n

If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.

\n \n
    \n
  • \n

    Provide the name and an optional description.

    \n
    • \n
  • \n

    Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.

    \n
    • \n
  • \n

    Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.

    \n
    • \n
  • \n

    Provide the configuration for your vector store in the storageConfiguration object.

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

Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up a knowledge base.

\n \n

If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.

\n \n
    \n
  • \n

    Provide the name and an optional description.

    \n
    • \n
  • \n

    Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.

    \n
    • \n
  • \n

    Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.

    \n
    • \n
  • \n

    Provide the configuration for your vector store in the storageConfiguration object.

    \n \n
    • \n
", "smithy.api#http": { "code": 202, "method": "PUT", @@ -6691,7 +6691,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base that the data source was added to.

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

The unique identifier of the knowledge base for the data source.

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

Gets information about a ingestion job, in which a data source is added to a knowledge base.

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

Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -7172,7 +7172,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base for which the ingestion job applies.

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

The unique identifier of the knowledge base for the data ingestion job you want to get information on.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7180,7 +7180,7 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source in the ingestion job.

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

The unique identifier of the data source for the data ingestion job you want to get information on.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7188,7 +7188,7 @@ "ingestionJobId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the ingestion job.

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

The unique identifier of the data ingestion job you want to get information on.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7204,7 +7204,7 @@ "ingestionJob": { "target": "com.amazonaws.bedrockagent#IngestionJob", "traits": { - "smithy.api#documentation": "

Contains details about the ingestion job.

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

Contains details about the data ingestion job.

", "smithy.api#required": {} } } @@ -7257,7 +7257,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base for which to get information.

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

The unique identifier of the knowledge base you want to get information on.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7564,66 +7564,66 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source is being added.

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

The unique identifier of the knowledge for the data ingestion job.

", "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the ingested data source.

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

The unique identifier of the data source for the data ingestion job.

", "smithy.api#required": {} } }, "ingestionJobId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the ingestion job.

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

The unique identifier of the data ingestion job.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "

The description of the ingestion job.

" + "smithy.api#documentation": "

The description of the data ingestion job.

" } }, "status": { "target": "com.amazonaws.bedrockagent#IngestionJobStatus", "traits": { - "smithy.api#documentation": "

The status of the ingestion job.

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

The status of the data ingestion job.

", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", "traits": { - "smithy.api#documentation": "

Contains statistics about the ingestion job.

" + "smithy.api#documentation": "

Contains statistics about the data ingestion job.

" } }, "failureReasons": { "target": "com.amazonaws.bedrockagent#FailureReasons", "traits": { - "smithy.api#documentation": "

A list of reasons that the ingestion job failed.

" + "smithy.api#documentation": "

A list of reasons that the data ingestion job failed.

" } }, "startedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The time at which the ingestion job started.

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

The time the data ingestion job started.

\n

If you stop a data ingestion job, the startedAt time is the time the job was started before the job was stopped.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The time at which the ingestion job was last updated.

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

The time the data ingestion job was last updated.

\n

If you stop a data ingestion job, the updatedAt time is the time the job was stopped.

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

Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.

\n

This data type is used in the following API operations:

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

Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.

\n

This data type is used in the following API operations:

\n " } }, "com.amazonaws.bedrockagent#IngestionJobFilter": { @@ -7632,27 +7632,27 @@ "attribute": { "target": "com.amazonaws.bedrockagent#IngestionJobFilterAttribute", "traits": { - "smithy.api#documentation": "

The attribute by which to filter the results.

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

The name of field or attribute to apply the filter.

", "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", "traits": { - "smithy.api#documentation": "

The operation to carry out between the attribute and the values.

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

The operation to apply to the field or attribute.

", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.bedrockagent#IngestionJobFilterValues", "traits": { - "smithy.api#documentation": "

A list of values for the attribute.

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

A list of values that belong to the field or attribute.

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

Defines a filter by which to filter the results.

" + "smithy.api#documentation": "

The definition of a filter to filter the data.

" } }, "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { @@ -7722,6 +7722,9 @@ }, { "target": "com.amazonaws.bedrockagent#StartIngestionJob" + }, + { + "target": "com.amazonaws.bedrockagent#StopIngestionJob" } ] }, @@ -7731,20 +7734,20 @@ "attribute": { "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", "traits": { - "smithy.api#documentation": "

The attribute by which to sort the results.

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

The name of field or attribute to apply sorting of data.

", "smithy.api#required": {} } }, "order": { "target": "com.amazonaws.bedrockagent#SortOrder", "traits": { - "smithy.api#documentation": "

The order by which to sort the results.

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

The order for sorting the data.

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

Parameters by which to sort the results.

" + "smithy.api#documentation": "

The parameters of sorting the data.

" } }, "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { @@ -7806,7 +7809,7 @@ "target": "smithy.api#PrimitiveLong", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of source documents that was deleted.

" + "smithy.api#documentation": "

The number of source documents that were deleted.

" } }, "numberOfDocumentsFailed": { @@ -7818,7 +7821,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the statistics for the ingestion job.

" + "smithy.api#documentation": "

Contains the statistics for the data ingestion job.

" } }, "com.amazonaws.bedrockagent#IngestionJobStatus": { @@ -7847,6 +7850,18 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } } } }, @@ -7862,60 +7877,60 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source is added.

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

The unique identifier of the knowledge base for the data ingestion job.

", "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source in the ingestion job.

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

The unique identifier of the data source for the data ingestion job.

", "smithy.api#required": {} } }, "ingestionJobId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the ingestion job.

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

The unique identifier of the data ingestion job.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "

The description of the ingestion job.

" + "smithy.api#documentation": "

The description of the data ingestion job.

" } }, "status": { "target": "com.amazonaws.bedrockagent#IngestionJobStatus", "traits": { - "smithy.api#documentation": "

The status of the ingestion job.

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

The status of the data ingestion job.

", "smithy.api#required": {} } }, "startedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The time at which the ingestion job was started.

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

The time the data ingestion job started.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The time at which the ingestion job was last updated.

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

The time the data ingestion job was last updated.

", "smithy.api#required": {} } }, "statistics": { "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", "traits": { - "smithy.api#documentation": "

Contains statistics for the ingestion job.

" + "smithy.api#documentation": "

Contains statistics for the data ingestion job.

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

Contains details about an ingestion job.

" + "smithy.api#documentation": "

Contains details about a data ingestion job.

" } }, "com.amazonaws.bedrockagent#InputFlowNodeConfiguration": { @@ -8041,14 +8056,14 @@ "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The time at which the knowledge base was created.

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

The time the knowledge base was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The time at which the knowledge base was last updated.

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

The time the knowledge base was last updated.

", "smithy.api#required": {} } }, @@ -8085,12 +8100,12 @@ "vectorKnowledgeBaseConfiguration": { "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", "traits": { - "smithy.api#documentation": "

Contains details about the embeddings model that'sused to convert the data source.

" + "smithy.api#documentation": "

Contains details about the model that's used to convert the data source into vector embeddings.

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

Contains details about the embeddings configuration of the knowledge base.

" + "smithy.api#documentation": "

Contains details about the vector embeddings configuration of the knowledge base.

" } }, "com.amazonaws.bedrockagent#KnowledgeBaseFlowNodeConfiguration": { @@ -8309,7 +8324,7 @@ "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { - "smithy.api#documentation": "

The time at which the knowledge base was last updated.

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

The time the knowledge base was last updated.

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

Lists the ingestion jobs for a data source and information about each of them.

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

Lists the data ingestion jobs for a data source. The list also includes information about each job.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -9280,7 +9295,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base for which to return ingestion jobs.

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

The unique identifier of the knowledge base for the list of data ingestion jobs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9288,7 +9303,7 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source for which to return ingestion jobs.

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

The unique identifier of the data source for the list of data ingestion jobs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9296,13 +9311,13 @@ "filters": { "target": "com.amazonaws.bedrockagent#IngestionJobFilters", "traits": { - "smithy.api#documentation": "

Contains a definition of a filter for which to filter the results.

" + "smithy.api#documentation": "

Contains information about the filters for filtering the data.

" } }, "sortBy": { "target": "com.amazonaws.bedrockagent#IngestionJobSortBy", "traits": { - "smithy.api#documentation": "

Contains details about how to sort the results.

" + "smithy.api#documentation": "

Contains details about how to sort the data.

" } }, "maxResults": { @@ -9328,7 +9343,7 @@ "ingestionJobSummaries": { "target": "com.amazonaws.bedrockagent#IngestionJobSummaries", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about an ingestion job.

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

A list of data ingestion jobs with information about each job.

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

Lists the knowledge bases in an account and information about each of them.

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

Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -9410,7 +9425,7 @@ "knowledgeBaseSummaries": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummaries", "traits": { - "smithy.api#documentation": "

A list of objects, each of which contains information about a knowledge base.

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

A list of knowledge bases with information about each knowledge base.

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

The percentage of most-likely candidates that the model considers for the next token.

" } }, - "topK": { - "target": "com.amazonaws.bedrockagent#TopK", - "traits": { - "smithy.api#documentation": "

The number of most-likely candidates that the model considers for the next token during generation.

" - } - }, "maxTokens": { "target": "com.amazonaws.bedrockagent#MaximumLength", "traits": { @@ -10847,7 +10856,8 @@ "templateConfiguration": { "target": "com.amazonaws.bedrockagent#PromptTemplateConfiguration", "traits": { - "smithy.api#documentation": "

Contains configurations for the prompt template.

" + "smithy.api#documentation": "

Contains configurations for the prompt template.

", + "smithy.api#required": {} } }, "modelId": { @@ -10881,7 +10891,7 @@ }, "traits": { "smithy.api#length": { - "max": 3 + "max": 1 }, "smithy.api#sensitive": {} } @@ -11667,7 +11677,7 @@ } ], "traits": { - "smithy.api#documentation": "

Begins an ingestion job, in which a data source is added to a knowledge base.

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

Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -11685,7 +11695,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the knowledge base to which to add the data source.

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

The unique identifier of the knowledge base for the data ingestion job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11693,7 +11703,7 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the data source to ingest.

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

The unique identifier of the data source you want to ingest into your knowledge base.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11708,7 +11718,7 @@ "description": { "target": "com.amazonaws.bedrockagent#Description", "traits": { - "smithy.api#documentation": "

A description of the ingestion job.

" + "smithy.api#documentation": "

A description of the data ingestion job.

" } } }, @@ -11722,7 +11732,7 @@ "ingestionJob": { "target": "com.amazonaws.bedrockagent#IngestionJob", "traits": { - "smithy.api#documentation": "

An object containing information about the ingestion job.

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

Contains information about the data ingestion job.

", "smithy.api#required": {} } } @@ -11742,6 +11752,94 @@ } } }, + "com.amazonaws.bedrockagent#StopIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#StopIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#StopIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}/stop" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": [ + "console" + ] + } + }, + "com.amazonaws.bedrockagent#StopIngestionJobRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base for the data ingestion job you want to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data source for the data ingestion job you want to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ingestionJobId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data ingestion job you want to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#StopIngestionJobResponse": { + "type": "structure", + "members": { + "ingestionJob": { + "target": "com.amazonaws.bedrockagent#IngestionJob", + "traits": { + "smithy.api#documentation": "

Contains information about the stopped data ingestion job.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagent#StopSequences": { "type": "list", "member": { diff --git a/codegen/sdk/aws-models/bedrock-runtime.json b/codegen/sdk/aws-models/bedrock-runtime.json index 8dd29f993f1..25e1ead7b27 100644 --- a/codegen/sdk/aws-models/bedrock-runtime.json +++ b/codegen/sdk/aws-models/bedrock-runtime.json @@ -832,6 +832,12 @@ "smithy.api#documentation": "

The assessment details in the response from the guardrail.

", "smithy.api#required": {} } + }, + "guardrailCoverage": { + "target": "com.amazonaws.bedrockruntime#GuardrailCoverage", + "traits": { + "smithy.api#documentation": "

The guardrail coverage details in the apply guardrail response.

" + } } }, "traits": { @@ -1021,7 +1027,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):(model-gateway|inference-profile)/[a-zA-Z0-9-:.]+)|([a-zA-Z0-9-:.]+)$" } }, "com.amazonaws.bedrockruntime#Converse": { @@ -1636,6 +1642,12 @@ "traits": { "smithy.api#documentation": "

The contextual grounding policy used for the guardrail assessment.

" } + }, + "invocationMetrics": { + "target": "com.amazonaws.bedrockruntime#GuardrailInvocationMetrics", + "traits": { + "smithy.api#documentation": "

The invocation metrics for the guardrail assessment.

" + } } }, "traits": { @@ -1732,6 +1744,12 @@ "smithy.api#required": {} } }, + "filterStrength": { + "target": "com.amazonaws.bedrockruntime#GuardrailContentFilterStrength", + "traits": { + "smithy.api#documentation": "

The filter strength setting for the guardrail content filter.

" + } + }, "action": { "target": "com.amazonaws.bedrockruntime#GuardrailContentPolicyAction", "traits": { @@ -1779,6 +1797,35 @@ "target": "com.amazonaws.bedrockruntime#GuardrailContentFilter" } }, + "com.amazonaws.bedrockruntime#GuardrailContentFilterStrength": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + } + } + }, "com.amazonaws.bedrockruntime#GuardrailContentFilterType": { "type": "enum", "members": { @@ -2060,6 +2107,20 @@ "smithy.api#documentation": "

A text block that contains text that you want to assess with a guardrail. For more information, see GuardrailConverseContentBlock.

" } }, + "com.amazonaws.bedrockruntime#GuardrailCoverage": { + "type": "structure", + "members": { + "textCharacters": { + "target": "com.amazonaws.bedrockruntime#GuardrailTextCharactersCoverage", + "traits": { + "smithy.api#documentation": "

The text characters of the guardrail coverage details.

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

The action of the guardrail coverage details.

" + } + }, "com.amazonaws.bedrockruntime#GuardrailCustomWord": { "type": "structure", "members": { @@ -2097,6 +2158,32 @@ "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" } }, + "com.amazonaws.bedrockruntime#GuardrailInvocationMetrics": { + "type": "structure", + "members": { + "guardrailProcessingLatency": { + "target": "com.amazonaws.bedrockruntime#GuardrailProcessingLatency", + "traits": { + "smithy.api#documentation": "

The processing latency details for the guardrail invocation metrics.

" + } + }, + "usage": { + "target": "com.amazonaws.bedrockruntime#GuardrailUsage", + "traits": { + "smithy.api#documentation": "

The usage details for the guardrail invocation metrics.

" + } + }, + "guardrailCoverage": { + "target": "com.amazonaws.bedrockruntime#GuardrailCoverage", + "traits": { + "smithy.api#documentation": "

The coverage details for the guardrail invocation metrics.

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

The invocation metrics for the guardrail.

" + } + }, "com.amazonaws.bedrockruntime#GuardrailManagedWord": { "type": "structure", "members": { @@ -2392,6 +2479,9 @@ } } }, + "com.amazonaws.bedrockruntime#GuardrailProcessingLatency": { + "type": "long" + }, "com.amazonaws.bedrockruntime#GuardrailRegexFilter": { "type": "structure", "members": { @@ -2558,6 +2648,26 @@ "smithy.api#documentation": "

The text block to be evaluated by the guardrail.

" } }, + "com.amazonaws.bedrockruntime#GuardrailTextCharactersCoverage": { + "type": "structure", + "members": { + "guarded": { + "target": "com.amazonaws.bedrockruntime#TextCharactersGuarded", + "traits": { + "smithy.api#documentation": "

The text characters that were guarded by the guardrail coverage.

" + } + }, + "total": { + "target": "com.amazonaws.bedrockruntime#TextCharactersTotal", + "traits": { + "smithy.api#documentation": "

The total text characters by the guardrail coverage.

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

The guardrail coverage for the text characters.

" + } + }, "com.amazonaws.bedrockruntime#GuardrailTopic": { "type": "structure", "members": { @@ -2968,7 +3078,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):(model-gateway|inference-profile)/[a-zA-Z0-9-:.]+)|([a-zA-Z0-9-:.]+)$" } }, "com.amazonaws.bedrockruntime#InvokeModelRequest": { @@ -3569,6 +3679,12 @@ "target": "com.amazonaws.bedrockruntime#SystemContentBlock" } }, + "com.amazonaws.bedrockruntime#TextCharactersGuarded": { + "type": "integer" + }, + "com.amazonaws.bedrockruntime#TextCharactersTotal": { + "type": "integer" + }, "com.amazonaws.bedrockruntime#ThrottlingException": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/bedrock.json b/codegen/sdk/aws-models/bedrock.json index ce5b6e03875..3fe8539ad60 100644 --- a/codegen/sdk/aws-models/bedrock.json +++ b/codegen/sdk/aws-models/bedrock.json @@ -1051,7 +1051,7 @@ "clientRequestToken": { "target": "com.amazonaws.bedrock#IdempotencyToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

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

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, @@ -1084,7 +1084,7 @@ "inferenceConfig": { "target": "com.amazonaws.bedrock#EvaluationInferenceConfig", "traits": { - "smithy.api#documentation": "

Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.

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

Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model or inference profile, and model evaluation job that use human workers support two models or inference profiles.

", "smithy.api#required": {} } }, @@ -2386,7 +2386,7 @@ "modelIdentifier": { "target": "com.amazonaws.bedrock#EvaluationModelIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Bedrock model specified.

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

The ARN of the Amazon Bedrock model or inference profile specified.

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

Contains the ARN of the Amazon Bedrock models specified in your model evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.

\n

The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, \"temperature\":\"0.25\" key value pair would need to be formatted as \\\"temperature\\\":\\\"0.25\\\" to successfully accepted in the request.

" + "smithy.api#documentation": "

Contains the ARN of the Amazon Bedrock model or inference profile specified in your model evaluation job. Each Amazon Bedrock model supports different inferenceParams. To learn more about supported inference parameters for Amazon Bedrock models, see Inference parameters for foundation models.

\n

The inferenceParams are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, \"temperature\":\"0.25\" key value pair would need to be formatted as \\\"temperature\\\":\\\"0.25\\\" to successfully accepted in the request.

" } }, "com.amazonaws.bedrock#EvaluationConfig": { @@ -2693,7 +2693,7 @@ "bedrockModel": { "target": "com.amazonaws.bedrock#EvaluationBedrockModel", "traits": { - "smithy.api#documentation": "

Defines the Amazon Bedrock model and inference parameters you want used.

" + "smithy.api#documentation": "

Defines the Amazon Bedrock model or inference profile and inference parameters you want used.

" } } }, @@ -2720,7 +2720,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$" + "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z]{2}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))|(([a-z]{2}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))$" } }, "com.amazonaws.bedrock#EvaluationModelIdentifiers": { @@ -3757,6 +3757,12 @@ "traits": { "smithy.api#documentation": "

The imported model is encrypted at rest using this key.

" } + }, + "instructSupported": { + "target": "com.amazonaws.bedrock#InstructSupported", + "traits": { + "smithy.api#documentation": "

Specifies if the imported model supports fine tuning.

" + } } }, "traits": { @@ -6189,10 +6195,22 @@ "smithy.api#documentation": "

Creation time of the imported model.

", "smithy.api#required": {} } + }, + "instructSupported": { + "target": "com.amazonaws.bedrock#InstructSupported", + "traits": { + "smithy.api#documentation": "

Specifies if the imported model supports fine tuning.

" + } + }, + "modelArchitecture": { + "target": "com.amazonaws.bedrock#ModelArchitecture", + "traits": { + "smithy.api#documentation": "

The architecture of the imported model.

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

Information about tne imported model.

" + "smithy.api#documentation": "

Information about the imported model.

" } }, "com.amazonaws.bedrock#ImportedModelSummaryList": { @@ -6410,6 +6428,9 @@ "target": "com.amazonaws.bedrock#InferenceType" } }, + "com.amazonaws.bedrock#InstructSupported": { + "type": "boolean" + }, "com.amazonaws.bedrock#InternalServerException": { "type": "structure", "members": { @@ -7866,6 +7887,9 @@ "com.amazonaws.bedrock#MetricFloat": { "type": "float" }, + "com.amazonaws.bedrock#ModelArchitecture": { + "type": "string" + }, "com.amazonaws.bedrock#ModelArn": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/budgets.json b/codegen/sdk/aws-models/budgets.json index 00dc803101d..0fea2c0505a 100644 --- a/codegen/sdk/aws-models/budgets.json +++ b/codegen/sdk/aws-models/budgets.json @@ -340,6 +340,108 @@ }, "type": "endpoint" }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-e" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://budgets.global.cloud.adc-e.uk", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-iso-f" + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + false + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + false + ] + } + ], + "endpoint": { + "url": "https://budgets.global.csp.hci.ic.gov", + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-isof-south-1" + } + ] + }, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [ { @@ -858,6 +960,50 @@ "UseDualStack": false } }, + { + "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "eu-isoe-west-1" + } + ] + }, + "url": "https://budgets.global.cloud.adc-e.uk" + } + }, + "params": { + "Region": "eu-isoe-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "properties": { + "authSchemes": [ + { + "name": "sigv4", + "signingName": "budgets", + "signingRegion": "us-isof-south-1" + } + ] + }, + "url": "https://budgets.global.csp.hci.ic.gov" + } + }, + "params": { + "Region": "us-isof-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { @@ -3861,7 +4007,7 @@ "min": 25, "max": 684 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::(\\d{12}|aws):policy(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso|-iso-[a-z]{1})?:iam::(\\d{12}|aws):policy(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" } }, "com.amazonaws.budgets#PolicyId": { @@ -3978,7 +4124,7 @@ "min": 32, "max": 618 }, - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::\\d{12}:role(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" + "smithy.api#pattern": "^arn:aws(-cn|-us-gov|-iso|-iso-[a-z]{1})?:iam::\\d{12}:role(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" } }, "com.amazonaws.budgets#Roles": { diff --git a/codegen/sdk/aws-models/chatbot.json b/codegen/sdk/aws-models/chatbot.json index 1940cb5dca6..6b634fabe6d 100644 --- a/codegen/sdk/aws-models/chatbot.json +++ b/codegen/sdk/aws-models/chatbot.json @@ -112,6 +112,18 @@ "traits": { "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

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

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" + } + }, + "StateReason": { + "target": "com.amazonaws.chatbot#String", + "traits": { + "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

" + } } }, "traits": { @@ -177,6 +189,18 @@ "traits": { "smithy.api#documentation": "

The name of the Microsoft Teams Team.

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

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" + } + }, + "StateReason": { + "target": "com.amazonaws.chatbot#String", + "traits": { + "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

" + } } }, "traits": { @@ -2030,6 +2054,12 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.chatbot#ResourceState": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(ENABLED|DISABLED)$" + } + }, "com.amazonaws.chatbot#ServiceUnavailableException": { "type": "structure", "members": { @@ -2124,6 +2154,18 @@ "traits": { "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

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

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" + } + }, + "StateReason": { + "target": "com.amazonaws.chatbot#String", + "traits": { + "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

" + } } }, "traits": { @@ -2249,6 +2291,18 @@ "smithy.api#documentation": "

The name of the Slack workspace.

", "smithy.api#required": {} } + }, + "State": { + "target": "com.amazonaws.chatbot#ResourceState", + "traits": { + "smithy.api#documentation": "

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" + } + }, + "StateReason": { + "target": "com.amazonaws.chatbot#String", + "traits": { + "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

" + } } }, "traits": { @@ -2267,6 +2321,9 @@ "target": "com.amazonaws.chatbot#Arn" } }, + "com.amazonaws.chatbot#String": { + "type": "string" + }, "com.amazonaws.chatbot#Tag": { "type": "structure", "members": { @@ -2500,6 +2557,18 @@ "traits": { "smithy.api#documentation": "

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

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

Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration.\n\t For example, if Amazon Chime is disabled.

" + } + }, + "StateReason": { + "target": "com.amazonaws.chatbot#String", + "traits": { + "smithy.api#documentation": "

Provided if State is DISABLED. Provides context as to why the resource is disabled.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/clouddirectory.json b/codegen/sdk/aws-models/clouddirectory.json index d1e66ed8f15..a214b41c124 100644 --- a/codegen/sdk/aws-models/clouddirectory.json +++ b/codegen/sdk/aws-models/clouddirectory.json @@ -81,6 +81,24 @@ ], "traits": { "smithy.api#documentation": "

Adds a new Facet to an object. An object can have more than one facet applied on it.

", + "smithy.api#examples": [ + { + "title": "To add a facet to an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "SchemaFacet": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", + "FacetName": "node1" + }, + "ObjectAttributeList": [], + "ObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ" + } + }, + "output": {} + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/object/facets", @@ -1172,6 +1190,20 @@ ], "traits": { "smithy.api#documentation": "

Copies the input published schema, at the specified version, into the Directory with the same\n name and version as that of the published schema.

", + "smithy.api#examples": [ + { + "title": "To apply a schema", + "documentation": "", + "input": { + "PublishedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/published/org/1", + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI" + }, + "output": { + "AppliedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI/schema/org/1", + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/schema/apply", @@ -1276,6 +1308,25 @@ ], "traits": { "smithy.api#documentation": "

Attaches an existing object to another object. An object can be accessed in two\n ways:

\n
    \n
  1. \n

    Using the path

    \n
    2. \n
  2. \n

    Using ObjectIdentifier\n

    \n
    3. \n
", + "smithy.api#examples": [ + { + "title": "To attach an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "ParentReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + }, + "ChildReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + }, + "LinkName": "link2" + }, + "output": { + "AttachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/object/attach", @@ -1373,6 +1424,22 @@ ], "traits": { "smithy.api#documentation": "

Attaches a policy object to a regular object. An object can have a limited number of attached\n policies.

", + "smithy.api#examples": [ + { + "title": "To attach a policy to an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "PolicyReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew" + }, + "ObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw" + } + }, + "output": {} + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/policy/attach", @@ -1465,6 +1532,24 @@ ], "traits": { "smithy.api#documentation": "

Attaches the specified object to the specified index.

", + "smithy.api#examples": [ + { + "title": "To attach a index to an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "IndexReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q" + }, + "TargetReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + } + }, + "output": { + "AttachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/index/attach", @@ -1558,6 +1643,55 @@ ], "traits": { "smithy.api#documentation": "

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

", + "smithy.api#examples": [ + { + "title": "To attach a typed link to an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "SourceObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + }, + "TargetObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + }, + "TypedLinkFacet": { + "TypedLinkName": "exampletypedlink8", + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + }, + "Attributes": [ + { + "AttributeName": "22", + "Value": { + "BinaryValue": "c3Ry" + } + } + ] + }, + "output": { + "TypedLinkSpecifier": { + "SourceObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + }, + "IdentityAttributeValues": [ + { + "AttributeName": "22", + "Value": { + "BinaryValue": "c3Ry" + } + } + ], + "TargetObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + }, + "TypedLinkFacet": { + "TypedLinkName": "exampletypedlink8", + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + } + } + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/typedlink/attach", @@ -2889,6 +3023,20 @@ ], "traits": { "smithy.api#documentation": "

Performs all the read operations in a batch.

", + "smithy.api#examples": [ + { + "title": "To run a batch read command", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "Operations": [], + "ConsistencyLevel": "EVENTUAL" + }, + "output": { + "Responses": [] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/batchread", @@ -3392,6 +3540,19 @@ ], "traits": { "smithy.api#documentation": "

Performs all the write operations in a batch. Either all the operations succeed or\n none.

", + "smithy.api#examples": [ + { + "title": "To run a batch write command", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "Operations": [] + }, + "output": { + "Responses": [] + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/batchwrite", @@ -3856,6 +4017,22 @@ ], "traits": { "smithy.api#documentation": "

Creates a Directory by copying the published schema into the\n directory. A directory cannot be created without a schema.

\n

You can also quickly create a directory using a managed schema, called the\n QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

", + "smithy.api#examples": [ + { + "title": "To create a new Cloud Directory", + "documentation": "", + "input": { + "Name": "ExampleCD", + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/published/person/1" + }, + "output": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI", + "Name": "ExampleCD", + "ObjectIdentifier": "AQHzK-KsptZGU78KjmnwGH6i-4guCM3uQFOTA9_NjeHDrg", + "AppliedSchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI/schema/person/1" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/directory/create", @@ -3964,6 +4141,18 @@ ], "traits": { "smithy.api#documentation": "

Creates a new Facet in a schema. Facet creation is allowed only\n in development or applied schemas.

", + "smithy.api#examples": [ + { + "title": "To create a facet", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", + "Name": "node1", + "ObjectType": "NODE" + }, + "output": {} + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/facet/create", @@ -4064,6 +4253,22 @@ ], "traits": { "smithy.api#documentation": "

Creates an index object. See Indexing and search for more information.

", + "smithy.api#examples": [ + { + "title": "To create an index", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8", + "OrderedIndexedAttributeList": [], + "IsUnique": true, + "ParentReference": {}, + "LinkName": "Examplelink" + }, + "output": { + "ObjectIdentifier": "AQF0Fw173YJDlpLUV1eB50WvYsWFtVoUSmOzZjz_BLULIA" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/index", @@ -4173,6 +4378,24 @@ ], "traits": { "smithy.api#documentation": "

Creates an object in a Directory. Additionally attaches the object to\n a parent, if a parent reference and LinkName is specified. An object is simply a\n collection of Facet attributes. You can also use this API call to create a\n policy object, if the facet from which you create the object is a policy facet.

", + "smithy.api#examples": [ + { + "title": "To create an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8", + "SchemaFacets": [ + { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8/schema/ExampleOrgPersonSchema/1", + "FacetName": "Organization_Person" + } + ] + }, + "output": { + "ObjectIdentifier": "AQF0Fw173YJDlpLUV1eB50WvScvjsYXcS3K2nP1HwDuuYQ" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/object", @@ -4268,6 +4491,18 @@ ], "traits": { "smithy.api#documentation": "

Creates a new schema in a development state. A schema can exist in three\n phases:

\n
    \n
  • \n

    \n Development: This is a mutable phase of the schema. All new\n schemas are in the development phase. Once the schema is finalized, it can be\n published.

    \n
    • \n
  • \n

    \n Published: Published schemas are immutable and have a version\n associated with them.

    \n
    • \n
  • \n

    \n Applied: Applied schemas are mutable in a way that allows you\n to add new schema facets. You can also add new, nonrequired attributes to existing schema\n facets. You can apply only published schemas to directories.

    \n
    • \n
", + "smithy.api#examples": [ + { + "title": "To create a schema", + "documentation": "", + "input": { + "Name": "Customers" + }, + "output": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Customers" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/schema/create", @@ -4346,6 +4581,29 @@ ], "traits": { "smithy.api#documentation": "

Creates a TypedLinkFacet. For more information, see Typed Links.

", + "smithy.api#examples": [ + { + "title": "To create a typed link facet", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschema", + "Facet": { + "Name": "FacetExample", + "Attributes": [ + { + "Name": "1", + "Type": "BINARY", + "RequiredBehavior": "REQUIRED_ALWAYS" + } + ], + "IdentityAttributeOrder": [ + "1" + ] + } + }, + "output": {} + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/typedlink/facet/create", @@ -4428,6 +4686,18 @@ ], "traits": { "smithy.api#documentation": "

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme\n caution\n when deleting directories.

", + "smithy.api#examples": [ + { + "title": "To delete a directory", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8" + }, + "output": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/directory", @@ -4505,6 +4775,17 @@ ], "traits": { "smithy.api#documentation": "

Deletes a given Facet. All attributes and Rules\n that are associated with the facet will be deleted. Only development schema facets are allowed\n deletion.

", + "smithy.api#examples": [ + { + "title": "To delete a facet", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest", + "Name": "Organization" + }, + "output": {} + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/facet/delete", @@ -4581,6 +4862,19 @@ ], "traits": { "smithy.api#documentation": "

Deletes an object and its associated attributes. Only objects with no children and no\n parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

", + "smithy.api#examples": [ + { + "title": "To delete an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI", + "ObjectReference": { + "Selector": "$AQHzK-KsptZGU78KjmnwGH6i8H-voMZDSNCqfx-fRUcBFg" + } + }, + "output": {} + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/object/delete", @@ -4654,6 +4948,18 @@ ], "traits": { "smithy.api#documentation": "

Deletes a given schema. Schemas in a development and published state can only be deleted.

", + "smithy.api#examples": [ + { + "title": "To delete a schema", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest" + }, + "output": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorgtest" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/schema", @@ -4727,6 +5033,17 @@ ], "traits": { "smithy.api#documentation": "

Deletes a TypedLinkFacet. For more information, see Typed Links.

", + "smithy.api#examples": [ + { + "title": "To delete a typed link facet", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest", + "Name": "ExampleFacet" + }, + "output": {} + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/typedlink/facet/delete", @@ -4806,6 +5123,24 @@ ], "traits": { "smithy.api#documentation": "

Detaches the specified object from the specified index.

", + "smithy.api#examples": [ + { + "title": "To detach an object from an index", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "IndexReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q" + }, + "TargetReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + } + }, + "output": { + "DetachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/index/detach", @@ -4896,6 +5231,22 @@ ], "traits": { "smithy.api#documentation": "

Detaches a given object from the parent object. The object that is to be detached from the\n parent is specified by the link name.

", + "smithy.api#examples": [ + { + "title": "To detach an object from its parent object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "ParentReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + }, + "LinkName": "link2" + }, + "output": { + "DetachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/object/detach", @@ -4986,6 +5337,22 @@ ], "traits": { "smithy.api#documentation": "

Detaches a policy from an object.

", + "smithy.api#examples": [ + { + "title": "To detach a policy from an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "PolicyReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWgcBsTVmcQEWs6jlygfhuew" + }, + "ObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWQoovm1s3Ts2v0NKrzdVnPw" + } + }, + "output": {} + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/policy/detach", @@ -5069,6 +5436,35 @@ ], "traits": { "smithy.api#documentation": "

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

", + "smithy.api#examples": [ + { + "title": "To detach a typed link from an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "TypedLinkSpecifier": { + "SourceObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + }, + "IdentityAttributeValues": [ + { + "AttributeName": "22", + "Value": { + "BinaryValue": "c3Ry" + } + } + ], + "TargetObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + }, + "TypedLinkFacet": { + "TypedLinkName": "exampletypedlink8", + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + } + } + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/typedlink/detach", @@ -5261,6 +5657,18 @@ ], "traits": { "smithy.api#documentation": "

Disables the specified directory. Disabled directories cannot be read or written to.\n Only enabled directories can be disabled. Disabled directories may be reenabled.

", + "smithy.api#examples": [ + { + "title": "To disable a directory", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8" + }, + "output": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/directory/disable", @@ -5335,6 +5743,18 @@ ], "traits": { "smithy.api#documentation": "

Enables the specified directory. Only disabled directories can be enabled. Once\n enabled, the directory can then be read and written to.

", + "smithy.api#examples": [ + { + "title": "To enable a disabled directory", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8" + }, + "output": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8" + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/amazonclouddirectory/2017-01-11/directory/enable", @@ -5748,6 +6168,23 @@ ], "traits": { "smithy.api#documentation": "

Retrieves metadata about a directory.

", + "smithy.api#examples": [ + { + "title": "To get information about a directory", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY" + }, + "output": { + "Directory": { + "CreationDateTime": 1.506115781186E9, + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "Name": "ExampleCD", + "State": "ENABLED" + } + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/directory/get", @@ -5822,6 +6259,22 @@ ], "traits": { "smithy.api#documentation": "

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema\n facets -- published, development, or applied.

", + "smithy.api#examples": [ + { + "title": "To get information about a facet", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", + "Name": "node2" + }, + "output": { + "Facet": { + "Name": "node2", + "ObjectType": "NODE" + } + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/facet", @@ -6102,6 +6555,28 @@ ], "traits": { "smithy.api#documentation": "

Retrieves metadata about an object.

", + "smithy.api#examples": [ + { + "title": "To get information about an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "ObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ" + }, + "ConsistencyLevel": "SERIALIZABLE" + }, + "output": { + "SchemaFacets": [ + { + "FacetName": "node2", + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + } + ], + "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/object/information", @@ -6192,6 +6667,19 @@ ], "traits": { "smithy.api#documentation": "

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

", + "smithy.api#examples": [ + { + "title": "To get schema information and display it in JSON format", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + }, + "output": { + "Document": "{\"sourceSchemaArn\":\"arn:aws:clouddirectory:us-west-2:45132example:schema/published/org/1\",\"facets\":{\"node2\":{\"facetAttributes\":{},\"objectType\":\"NODE\"},\"Organization\":{\"facetAttributes\":{\"account_id\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"account_name\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"telephone_number\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"description\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_country\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_state\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_street2\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_street1\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"web_site\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"email\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_city\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"organization_status\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_postal_code\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"}},\"objectType\":\"LEAF_NODE\"},\"nodex\":{\"facetAttributes\":{},\"objectType\":\"NODE\"},\"Legal_Entity\":{\"facetAttributes\":{\"industry_vertical\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"registered_company_name\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"billing_currency\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_country\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_state\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_street2\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_street1\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"tax_id\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_city\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"},\"mailing_address_postal_code\":{\"attributeDefinition\":{\"attributeType\":\"STRING\",\"isImmutable\":false,\"attributeRules\":{\"nameLength\":{\"parameters\":{\"min\":\"1\",\"max\":\"1024\"},\"ruleType\":\"STRING_LENGTH\"}}},\"requiredBehavior\":\"NOT_REQUIRED\"}},\"objectType\":\"LEAF_NODE\"},\"policyfacet\":{\"facetAttributes\":{},\"objectType\":\"POLICY\"},\"node1\":{\"facetAttributes\":{},\"objectType\":\"NODE\"}},\"typedLinkFacets\":{\"exampletypedlink\":{\"facetAttributes\":{\"1\":{\"attributeDefinition\":{\"attributeType\":\"BINARY\",\"isImmutable\":false,\"attributeRules\":{}},\"requiredBehavior\":\"REQUIRED_ALWAYS\"}},\"identityAttributeOrder\":[\"1\"]},\"exampletypedlink8\":{\"facetAttributes\":{\"22\":{\"attributeDefinition\":{\"attributeType\":\"BINARY\",\"isImmutable\":false,\"attributeRules\":{}},\"requiredBehavior\":\"REQUIRED_ALWAYS\"}},\"identityAttributeOrder\":[\"22\"]}}}", + "Name": "org" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/schema/json", @@ -6274,6 +6762,21 @@ ], "traits": { "smithy.api#documentation": "

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.

", + "smithy.api#examples": [ + { + "title": "To get information about a typed link facet", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", + "Name": "exampletypedlink8" + }, + "output": { + "IdentityAttributeOrder": [ + "22" + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/typedlink/facet/get", @@ -6601,6 +7104,20 @@ ], "traits": { "smithy.api#documentation": "

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

", + "smithy.api#examples": [ + { + "title": "To list applied schema ARNs for a specified directory", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY" + }, + "output": { + "SchemaArns": [ + "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/schema/applied", @@ -6702,6 +7219,26 @@ ], "traits": { "smithy.api#documentation": "

Lists indices attached to the specified object.

", + "smithy.api#examples": [ + { + "title": "To list the indices attached to an object", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "TargetReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + } + }, + "output": { + "IndexAttachments": [ + { + "IndexedAttributes": [], + "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/object/indices", @@ -6812,6 +7349,22 @@ ], "traits": { "smithy.api#documentation": "

Retrieves each Amazon Resource Name (ARN) of schemas in the development\n state.

", + "smithy.api#examples": [ + { + "title": "To list all development schema arns in your AWS account", + "documentation": "", + "output": { + "SchemaArns": [ + "arn:aws:clouddirectory:us-west-2:45132example:schema/development/typedlinkschematest", + "arn:aws:clouddirectory:us-west-2:45132example:schema/development/testCDschema", + "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Customers", + "arn:aws:clouddirectory:us-west-2:45132example:schema/development/CourseCatalog", + "arn:aws:clouddirectory:us-west-2:45132example:schema/development/Consumers", + "arn:aws:clouddirectory:us-west-2:45132example:schema/development/exampleorg" + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/schema/development", @@ -6897,6 +7450,46 @@ ], "traits": { "smithy.api#documentation": "

Lists directories created within an account.

", + "smithy.api#examples": [ + { + "title": "To list all directories in your AWS account", + "documentation": "", + "output": { + "Directories": [ + { + "State": "ENABLED", + "CreationDateTime": 1.506121791167E9, + "Name": "ExampleCD4", + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/Ae89hOKmw0bRpvYgW8EAsus" + }, + { + "State": "DELETED", + "CreationDateTime": 1.485473189746E9, + "Name": "testCD", + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8" + }, + { + "State": "ENABLED", + "CreationDateTime": 1.506115781186E9, + "Name": "ExampleCD", + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY" + }, + { + "State": "ENABLED", + "CreationDateTime": 1.506118003859E9, + "Name": "ExampleCD2", + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI" + }, + { + "State": "DELETED", + "CreationDateTime": 1.485477107925E9, + "Name": "testCD2", + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AWeI1yjiB0SylWVTvQklCD0" + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/directory/list", @@ -6995,6 +7588,191 @@ ], "traits": { "smithy.api#documentation": "

Retrieves attributes attached to the facet.

", + "smithy.api#examples": [ + { + "title": "To list facet attributes", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", + "Name": "Organization" + }, + "output": { + "Attributes": [ + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "account_id" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "account_name" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "description" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "email" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "mailing_address_city" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "mailing_address_country" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "mailing_address_postal_code" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "mailing_address_state" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "mailing_address_street1" + }, + { + "AttributeDefinition": { + "Rules": { + "nameLength": { + "Type": "STRING_LENGTH", + "Parameters": { + "max": "1024", + "min": "1" + } + } + }, + "Type": "STRING", + "IsImmutable": false + }, + "RequiredBehavior": "NOT_REQUIRED", + "Name": "mailing_address_street2" + } + ], + "NextToken": "V0b3JnYW5pemF0aW9uX3N0YXR1cw==" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/facet/attributes", @@ -7098,6 +7876,25 @@ ], "traits": { "smithy.api#documentation": "

Retrieves the names of facets that exist in a schema.

", + "smithy.api#examples": [ + { + "title": "To list facet names", + "documentation": "", + "input": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + }, + "output": { + "FacetNames": [ + "Legal_Entity", + "Organization", + "node1", + "node2", + "nodex", + "policyfacet" + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/facet/list", @@ -7200,6 +7997,83 @@ ], "traits": { "smithy.api#documentation": "

Returns a paginated list of all the incoming TypedLinkSpecifier\n information for an object. It also supports filtering by typed link facet and identity\n attributes. For more information, see Typed Links.

", + "smithy.api#examples": [ + { + "title": "To list incoming typed links", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "ObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + } + }, + "output": { + "LinkSpecifiers": [ + { + "SourceObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + }, + "IdentityAttributeValues": [ + { + "AttributeName": "22", + "Value": { + "BinaryValue": "" + } + } + ], + "TargetObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + }, + "TypedLinkFacet": { + "TypedLinkName": "exampletypedlink8", + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + } + }, + { + "SourceObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + }, + "IdentityAttributeValues": [ + { + "AttributeName": "22", + "Value": { + "BinaryValue": "MA==" + } + } + ], + "TargetObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + }, + "TypedLinkFacet": { + "TypedLinkName": "exampletypedlink8", + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + } + }, + { + "SourceObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + }, + "IdentityAttributeValues": [ + { + "AttributeName": "22", + "Value": { + "BinaryValue": "c3Ry" + } + } + ], + "TargetObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + }, + "TypedLinkFacet": { + "TypedLinkName": "exampletypedlink8", + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1" + } + } + ], + "NextToken": "" + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/typedlink/incoming", @@ -7325,6 +8199,35 @@ ], "traits": { "smithy.api#documentation": "

Lists objects attached to the specified index.

", + "smithy.api#examples": [ + { + "title": "To list an index", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "IndexReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q" + } + }, + "output": { + "IndexAttachments": [ + { + "ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw", + "IndexedAttributes": [ + { + "Value": {}, + "Key": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", + "FacetName": "Organization", + "Name": "description" + } + } + ] + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/index/targets", @@ -7535,6 +8438,42 @@ ], "traits": { "smithy.api#documentation": "

Lists all attributes that are associated with an object.\n

", + "smithy.api#examples": [ + { + "title": "To list object attributes", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "ObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q" + } + }, + "output": { + "Attributes": [ + { + "Value": { + "BooleanValue": true + }, + "Key": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/CloudDirectory/1.0", + "FacetName": "INDEX", + "Name": "index_is_unique" + } + }, + { + "Value": { + "StringValue": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1*Organization*description" + }, + "Key": { + "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/CloudDirectory/1.0", + "FacetName": "INDEX", + "Name": "ordered_indexed_attributes" + } + } + ] + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/object/attributes", @@ -7657,6 +8596,23 @@ ], "traits": { "smithy.api#documentation": "

Returns a paginated list of child objects that are associated with a given\n object.

", + "smithy.api#examples": [ + { + "title": "To list an objects children", + "documentation": "", + "input": { + "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", + "ObjectReference": { + "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" + } + }, + "output": { + "Children": { + "link2": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" + } + } + } + ], "smithy.api#http": { "method": "POST", "uri": "/amazonclouddirectory/2017-01-11/object/children", diff --git a/codegen/sdk/aws-models/cloudformation.json b/codegen/sdk/aws-models/cloudformation.json index a2160e7f7e4..9334d3409f4 100644 --- a/codegen/sdk/aws-models/cloudformation.json +++ b/codegen/sdk/aws-models/cloudformation.json @@ -119,7 +119,7 @@ "Name": { "target": "com.amazonaws.cloudformation#LimitName", "traits": { - "smithy.api#documentation": "

The name of the account limit.

\n

Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit\n

" + "smithy.api#documentation": "

The name of the account limit.

\n

Values: ConcurrentResourcesLimit | StackLimit |\n StackOutputsLimit\n

" } }, "Value": { @@ -130,7 +130,7 @@ } }, "traits": { - "smithy.api#documentation": "

The AccountLimit data type.

\n

CloudFormation has the following limits per account:

\n
    \n
  • \n

    Number of concurrent resources

    \n
    • \n
  • \n

    Number of stacks

    \n
    • \n
  • \n

    Number of stack outputs

    \n
    • \n
\n

For more information about these account limits, and other CloudFormation limits, see CloudFormation quotas in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

The AccountLimit data type.

\n

CloudFormation has the following limits per account:

\n
    \n
  • \n

    Number of concurrent resources

    \n
    • \n
  • \n

    Number of stacks

    \n
    • \n
  • \n

    Number of stack outputs

    \n
    • \n
\n

For more information about these account limits, and other CloudFormation limits, see Understand CloudFormation quotas in the CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#AccountLimitList": { @@ -172,7 +172,7 @@ } ], "traits": { - "smithy.api#documentation": "

Activate trusted access with Organizations. With trusted access between StackSets and Organizations\n activated, the management account has permissions to create and manage StackSets for your\n organization.

" + "smithy.api#documentation": "

Activate trusted access with Organizations. With trusted access between StackSets\n and Organizations activated, the management account has permissions to create\n and manage StackSets for your organization.

" } }, "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput": { @@ -206,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "

Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.

\n

Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see\n Configuring extensions at\n the account level in the CloudFormation User Guide.

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

Activates a public third-party extension, making it available for use in stack templates.\n Once you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Using public\n extensions in the CloudFormation User Guide.

", "smithy.api#idempotent": {} } }, @@ -216,37 +216,37 @@ "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "

The extension type.

\n

Conditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.

" + "smithy.api#documentation": "

The extension type.

\n

Conditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.

" } }, "PublicTypeArn": { "target": "com.amazonaws.cloudformation#ThirdPartyTypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the public extension.

\n

Conditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the public extension.

\n

Conditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.

" } }, "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { - "smithy.api#documentation": "

The ID of the extension publisher.

\n

Conditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.

" + "smithy.api#documentation": "

The ID of the extension publisher.

\n

Conditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.

" + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.

" } }, "TypeNameAlias": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the\n alias to refer to the extension in your templates, API calls, and CloudFormation console.

\n

An extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.

" + "smithy.api#documentation": "

An alias to assign to the public extension, in this account and Region. If you specify an\n alias for the extension, CloudFormation treats the alias as the extension type name within this\n account and Region. You must use the alias to refer to the extension in your templates, API\n calls, and CloudFormation console.

\n

An extension alias must be unique within a given account and Region. You can activate the\n same public resource multiple times in the same account and Region, using different type name\n aliases.

" } }, "AutoUpdate": { "target": "com.amazonaws.cloudformation#AutoUpdate", "traits": { - "smithy.api#documentation": "

Whether to automatically update the extension in this account and Region when a new minor\n version is published by the extension publisher. Major versions released by the publisher must be manually\n updated.

\n

The default is true.

" + "smithy.api#documentation": "

Whether to automatically update the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions\n released by the publisher must be manually updated.

\n

The default is true.

" } }, "LoggingConfig": { @@ -264,13 +264,13 @@ "VersionBump": { "target": "com.amazonaws.cloudformation#VersionBump", "traits": { - "smithy.api#documentation": "

Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.

\n
    \n
  • \n

    \n MAJOR: CloudFormation updates the extension to the newest major version, if one is available.

    \n
    • \n
  • \n

    \n MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

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

Manually updates a previously-activated type to a new major or minor version, if\n available. You can also use this parameter to update the value of\n AutoUpdate.

\n
    \n
  • \n

    \n MAJOR: CloudFormation updates the extension to the newest major version, if\n one is available.

    \n
    • \n
  • \n

    \n MINOR: CloudFormation updates the extension to the newest minor version, if\n one is available.

    \n
    • \n
" } }, "MajorVersion": { "target": "com.amazonaws.cloudformation#MajorVersion", "traits": { - "smithy.api#documentation": "

The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of the major\n version selected.

\n

You can specify MajorVersion or VersionBump, but not both.

" + "smithy.api#documentation": "

The major version of this extension you want to activate, if multiple major versions are\n available. The default is the latest major version. CloudFormation uses the latest available\n minor version of the major version selected.

\n

You can specify MajorVersion or VersionBump, but not\n both.

" } } }, @@ -284,7 +284,7 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the activated extension, in this account and Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the activated extension, in this account and\n Region.

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

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry\n for the account and Region.

\n

For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation\n registry for the account and Region.

\n

For more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { @@ -419,7 +419,7 @@ } }, "traits": { - "smithy.api#documentation": "

Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.

" + "smithy.api#documentation": "

Detailed information concerning an error generated during the setting of configuration data\n for a CloudFormation extension.

" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors": { @@ -450,19 +450,19 @@ "Errors": { "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors", "traits": { - "smithy.api#documentation": "

A list of information concerning any errors generated during the setting of the specified configurations.

" + "smithy.api#documentation": "

A list of information concerning any errors generated during the setting of the specified\n configurations.

" } }, "UnprocessedTypeConfigurations": { "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", "traits": { - "smithy.api#documentation": "

A list of any of the specified extension configurations that CloudFormation could not process for any reason.

" + "smithy.api#documentation": "

A list of any of the specified extension configurations that CloudFormation could not process\n for any reason.

" } }, "TypeConfigurations": { "target": "com.amazonaws.cloudformation#TypeConfigurationDetailsList", "traits": { - "smithy.api#documentation": "

A list of any of the specified extension configurations from the CloudFormation registry.

" + "smithy.api#documentation": "

A list of any of the specified extension configurations from the CloudFormation\n registry.

" } } }, @@ -494,7 +494,7 @@ "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { - "smithy.api#documentation": "

An message with details about the error that occurred.

" + "smithy.api#documentation": "

A message with details about the error that occurred.

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

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update\n and reverts to the previous stack configuration.

\n \n

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

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

Cancels an update on the specified stack. If the call completes successfully, the stack\n rolls back the update and reverts to the previous stack configuration.

\n \n

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

\n " } }, "com.amazonaws.cloudformation#CancelUpdateStackInput": { @@ -549,14 +549,14 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "\n

If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account.

\n

The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:

\n

\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n

\n \n

The name or the unique stack ID that's associated with the stack.

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

If you don't pass a parameter to StackName, the API returns a response that\n describes all resources in the account.

\n

The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the\n request:

\n

\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }]\n }\n

\n \n

The name or the unique stack ID that's associated with the stack.

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

A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might\n retry CancelUpdateStack requests to ensure that CloudFormation successfully received them.

" + "smithy.api#documentation": "

A unique identifier for this CancelUpdateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an\n update on a stack with the same name. You might retry CancelUpdateStack requests\n to ensure that CloudFormation successfully received them.

" } } }, @@ -641,18 +641,18 @@ "HookInvocationCount": { "target": "com.amazonaws.cloudformation#HookInvocationCount", "traits": { - "smithy.api#documentation": "

Is either null, if no hooks invoke for the resource, or contains the number of hooks that will\n invoke for the resource.

" + "smithy.api#documentation": "

Is either null, if no hooks invoke for the resource, or contains the number of\n hooks that will invoke for the resource.

" } }, "ResourceChange": { "target": "com.amazonaws.cloudformation#ResourceChange", "traits": { - "smithy.api#documentation": "

A ResourceChange structure that describes the resource and action that CloudFormation will perform.

" + "smithy.api#documentation": "

A ResourceChange structure that describes the resource and action that\n CloudFormation will perform.

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

The Change structure describes the changes CloudFormation will perform if you execute the change set.

" + "smithy.api#documentation": "

The Change structure describes the changes CloudFormation will perform if you\n execute the change set.

" } }, "com.amazonaws.cloudformation#ChangeAction": { @@ -708,7 +708,7 @@ "TypeName": { "target": "com.amazonaws.cloudformation#HookTypeName", "traits": { - "smithy.api#documentation": "

The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of\n Organization::Service::Hook.

\n \n

The following organization namespaces are reserved and can't be used in your hook type names:

\n
    \n
  • \n

    \n Alexa\n

    \n
    • \n
  • \n

    \n AMZN\n

    \n
    • \n
  • \n

    \n Amazon\n

    \n
    • \n
  • \n

    \n ASK\n

    \n
    • \n
  • \n

    \n AWS\n

    \n
    • \n
  • \n

    \n Custom\n

    \n
    • \n
  • \n

    \n Dev\n

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

The unique name for your hook. Specifies a three-part namespace for your hook, with a\n recommended pattern of Organization::Service::Hook.

\n \n

The following organization namespaces are reserved and can't be used in your hook type\n names:

\n
    \n
  • \n

    \n Alexa\n

    \n
    • \n
  • \n

    \n AMZN\n

    \n
    • \n
  • \n

    \n Amazon\n

    \n
    • \n
  • \n

    \n ASK\n

    \n
    • \n
  • \n

    \n AWS\n

    \n
    • \n
  • \n

    \n Custom\n

    \n
    • \n
  • \n

    \n Dev\n

    \n
    • \n
\n " } }, "TypeVersionId": { @@ -947,19 +947,19 @@ "ExecutionStatus": { "target": "com.amazonaws.cloudformation#ExecutionStatus", "traits": { - "smithy.api#documentation": "

If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already\n updated.

" + "smithy.api#documentation": "

If the change set execution status is AVAILABLE, you can execute the change\n set. If you can't execute the change set, the status indicates why. For example, a change set\n might be in an UNAVAILABLE state because CloudFormation is still creating it or in an\n OBSOLETE state because the stack was already updated.

" } }, "Status": { "target": "com.amazonaws.cloudformation#ChangeSetStatus", "traits": { - "smithy.api#documentation": "

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.

" + "smithy.api#documentation": "

The state of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.

" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#ChangeSetStatusReason", "traits": { - "smithy.api#documentation": "

A description of the change set's status. For example, if your change set is in the FAILED state,\n CloudFormation shows the error message.

" + "smithy.api#documentation": "

A description of the change set's status. For example, if your change set is in the\n FAILED state, CloudFormation shows the error message.

" } }, "CreationTime": { @@ -1000,7 +1000,7 @@ } }, "traits": { - "smithy.api#documentation": "

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's\n associated.

" + "smithy.api#documentation": "

The ChangeSetSummary structure describes a change set, its status, and the\n stack with which it's associated.

" } }, "com.amazonaws.cloudformation#ChangeSetType": { @@ -1360,7 +1360,7 @@ "name": "cloudformation" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "CloudFormation\n

CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and\n repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly reliable, highly\n scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services\n infrastructure.

\n

With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a\n collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack\n together and manages all dependencies between the resources for you.

\n

For more information about CloudFormation, see the CloudFormation\n product page.

\n

CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a\n specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.

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

CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and\n repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service,\n Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly\n scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services\n infrastructure.

\n

With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a\n collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack\n together and manages all dependencies between the resources for you.

\n

For more information about CloudFormation, see the CloudFormation\n product page.

\n

CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a\n specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.

", "smithy.api#title": "AWS CloudFormation", "smithy.api#xmlNamespace": { "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" @@ -2452,7 +2452,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

\n

A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after\n a failed stack update. For example, you might have a stack that's rolling back to an old database instance that was\n deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes that the database instance\n still exists and attempts to roll back to it, causing the update rollback to fail.

" + "smithy.api#documentation": "

For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues\n rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of\n the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can\n return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and\n then try to update the stack again.

\n

A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll\n back all changes after a failed stack update. For example, you might have a stack that's\n rolling back to an old database instance that was deleted outside of CloudFormation. Because\n CloudFormation doesn't know the database was deleted, it assumes that the database instance still\n exists and attempts to roll back to it, causing the update rollback to fail.

" } }, "com.amazonaws.cloudformation#ContinueUpdateRollbackInput": { @@ -2462,26 +2462,26 @@ "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the unique ID of the stack that you want to continue rolling back.

\n \n

Don't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).

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

The name or the unique ID of the stack that you want to continue rolling back.

\n \n

Don't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the\n parent stack (the stack that contains the AWS::CloudFormation::Stack\n resource).

\n ", "smithy.api#required": {} } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this\n role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation\n uses this role even if the users don't have permission to pass it. Ensure that the role grants least\n permission.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to roll back the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.

" } }, "ResourcesToSkip": { "target": "com.amazonaws.cloudformation#ResourcesToSkip", "traits": { - "smithy.api#documentation": "

A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation.\n You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't\n specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update\n was canceled. To check why a resource update failed, use the DescribeStackResources action, and\n view the resource status reason.

\n \n

Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend\n that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified resources to\n UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the\n skipped resources will be inconsistent with the state of the resources in the stack template. Before performing\n another stack update, you must update the stack or resources to be consistent with each other. If you don't,\n subsequent stack updates might fail, and the stack will become unrecoverable.

\n \n

Specify the minimum number of resources required to successfully roll back your stack. For example, a failed\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.

\n

To skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.

\n \n

Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.

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

A list of the logical IDs of the resources that CloudFormation skips during the continue\n update rollback operation. You can specify only resources that are in the\n UPDATE_FAILED state because a rollback failed. You can't specify resources that\n are in the UPDATE_FAILED state for other reasons, for example, because an update\n was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

\n \n

Specify this property to skip rolling back resources that CloudFormation can't successfully\n roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the status of the\n specified resources to UPDATE_COMPLETE and continues to roll back the stack.\n After the rollback is complete, the state of the skipped resources will be inconsistent with\n the state of the resources in the stack template. Before performing another stack update,\n you must update the stack or resources to be consistent with each other. If you don't,\n subsequent stack updates might fail, and the stack will become unrecoverable.

\n \n

Specify the minimum number of resources required to successfully roll back your stack. For\n example, a failed resource update might cause dependent resources to fail. In this case, it\n might not be necessary to skip the dependent resources.

\n

To skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a\n stack resource (Type: AWS::CloudFormation::Stack) in the\n ResourcesToSkip list, then its corresponding embedded stack must be in one of\n the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or\n DELETE_FAILED.

\n \n

Don't confuse a child stack's name with its corresponding logical ID defined in the\n parent stack. For an example of a continue update rollback operation with nested stacks, see\n Continue rolling back from failed nested stack updates.

\n " } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name.\n You might retry ContinueUpdateRollback requests to ensure that CloudFormation successfully received\n them.

" + "smithy.api#documentation": "

A unique identifier for this ContinueUpdateRollback request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not attempting to\n continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that CloudFormation successfully received\n them.

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

Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you create a change\n set for an existing stack, CloudFormation compares the stack's information with the information that you submit in the change\n set and lists the differences. Use change sets to understand which resources CloudFormation will create or\n change, and how it will change resources in an existing stack, before you create or update a stack.

\n

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for\n the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

\n

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change set.

\n

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.

" + "smithy.api#documentation": "

Creates a list of changes that will be applied to a stack so that you can review the\n changes before executing them. You can create a change set for a stack that doesn't exist or\n an existing stack. If you create a change set for a stack that doesn't exist, the change set\n shows all of the resources that CloudFormation will create. If you create a change set for an\n existing stack, CloudFormation compares the stack's information with the information that you\n submit in the change set and lists the differences. Use change sets to understand which\n resources CloudFormation will create or change, and how it will change resources in an existing\n stack, before you create or update a stack.

\n

To create a change set for a stack that doesn't exist, for the ChangeSetType\n parameter, specify CREATE. To create a change set for an existing stack, specify\n UPDATE for the ChangeSetType parameter. To create a change set for\n an import operation, specify IMPORT for the ChangeSetType parameter.\n After the CreateChangeSet call successfully completes, CloudFormation starts creating\n the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

\n

When you are satisfied with the changes the change set will make, execute the change set\n by using the ExecuteChangeSet action. CloudFormation doesn't make changes until\n you execute the change set.

\n

To create a change set for the entire stack hierarchy, set\n IncludeNestedStacks to True.

" } }, "com.amazonaws.cloudformation#CreateChangeSetInput": { @@ -2528,82 +2528,82 @@ "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set\n by comparing this stack's information with the information that you submit, such as a modified template or different\n parameter input values.

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

The name or the unique ID of the stack for which you are creating a change set. CloudFormation\n generates the change set by comparing this stack's information with the information that you\n submit, such as a modified template or different parameter input values.

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

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you\n specified.

\n

Conditional: You must specify only TemplateBody or TemplateURL.

" + "smithy.api#documentation": "

A structure that contains the body of the revised template, with a minimum length of 1\n byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing\n this template with the template of the stack that you specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by\n comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with\n https://.

\n

Conditional: You must specify only TemplateBody or TemplateURL.

" + "smithy.api#documentation": "

The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager\n document. CloudFormation generates the change set by comparing this template with the stack that\n you specified. The location for an Amazon S3 bucket must start with https://.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" } }, "UsePreviousTemplate": { "target": "com.amazonaws.cloudformation#UsePreviousTemplate", "traits": { - "smithy.api#documentation": "

Whether to reuse the template that's associated with the stack to create the change set.

" + "smithy.api#documentation": "

Whether to reuse the template that's associated with the stack to create the change\n set.

" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the change set. For more\n information, see the Parameter data type.

" + "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the change\n set. For more information, see the Parameter data type.

" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in\n CloudFormation templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.

    \n \n

    This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.

    \n

    If you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.

    \n     \n

    For more information about macros, see Using CloudFormation macros to perform custom processing on\n templates.

    \n
    • \n
\n \n

Only one of the Capabilities and ResourceType parameters can be specified.

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

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n \n

    This capacity doesn't apply to creating change sets, and specifying it when creating\n change sets has no effect.

    \n

    If you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack directly\n from the template using the CreateStack or UpdateStack action, and specifying this capability.

    \n     \n

    For more information about macros, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
    • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n " } }, "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.

\n \n

Only one of the Capabilities and ResourceType parameters can be specified.

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

The template resource types that you have permissions to work with if you execute this\n change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource type that you're updating, the\n stack update fails. By default, CloudFormation grants permissions to all resource types. IAM\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Control access with\n Identity and Access Management in the CloudFormation User Guide.

\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n " } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the\n change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future\n operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if\n the users don't have permission to pass it. Ensure that the role grants least permission.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is\n available, CloudFormation uses a temporary session that is generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes when executing the\n change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that is generated from\n your user credentials.

" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.

" + "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.

" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates\n with the stack. To remove all associated notification topics, specify an empty list.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the\n stack. To remove all associated notification topics, specify an empty list.

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

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You\n can specify a maximum of 50 tags.

" + "smithy.api#documentation": "

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to\n resources in the stack. You can specify a maximum of 50 tags.

" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the change set. The name must be unique among all change sets that are associated with the specified\n stack.

\n

A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an\n alphabetical character and can't exceed 128 characters.

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

The name of the change set. The name must be unique among all change sets that are\n associated with the specified stack.

\n

A change set name can contain only alphanumeric, case sensitive characters, and hyphens.\n It must start with an alphabetical character and can't exceed 128 characters.

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

A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might\n retry CreateChangeSet requests to ensure that CloudFormation successfully received them.

" + "smithy.api#documentation": "

A unique identifier for this CreateChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to create\n another change set with the same name. You might retry CreateChangeSet requests\n to ensure that CloudFormation successfully received them.

" } }, "Description": { @@ -2615,7 +2615,7 @@ "ChangeSetType": { "target": "com.amazonaws.cloudformation#ChangeSetType", "traits": { - "smithy.api#documentation": "

The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n specify IMPORT.

\n

If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or\n resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.

\n

By default, CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change\n set for a new stack or the CREATE type to create a change set for an existing stack.

" + "smithy.api#documentation": "

The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.

\n

If you create a change set for a new stack, CloudFormation creates a stack with a unique stack\n ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS\n state until you execute the change set.

\n

By default, CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the CREATE\n type to create a change set for an existing stack.

" } }, "ResourcesToImport": { @@ -2627,19 +2627,19 @@ "IncludeNestedStacks": { "target": "com.amazonaws.cloudformation#IncludeNestedStacks", "traits": { - "smithy.api#documentation": "

Creates a change set for the all nested stacks specified in the template. The default behavior of this action is\n set to False. To include nested sets in a change set, specify True.

" + "smithy.api#documentation": "

Creates a change set for the all nested stacks specified in the template. The default\n behavior of this action is set to False. To include nested sets in a change set,\n specify True.

" } }, "OnStackFailure": { "target": "com.amazonaws.cloudformation#OnStackFailure", "traits": { - "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must\n not be specified. This must be one of these values:

\n
    \n
  • \n

    \n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.

    \n
    • \n
  • \n

    \n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.

    \n
    • \n
  • \n

    \n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.

    \n
    • \n
\n

For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.

" + "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. If this parameter is\n specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these\n values:

\n
    \n
  • \n

    \n DELETE - Deletes the change set if the stack creation fails. This is only\n valid when the ChangeSetType parameter is set to CREATE. If the\n deletion of the stack fails, the status of the stack is DELETE_FAILED.

    \n
    • \n
  • \n

    \n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent\n to specifying true for the DisableRollback parameter to the\n ExecuteChangeSet API operation.

    \n
    • \n
  • \n

    \n ROLLBACK - if the stack creation fails, roll back the stack. This is\n equivalent to specifying false for the DisableRollback parameter\n to the ExecuteChangeSet API operation.

    \n
    • \n
\n

For nested stacks, when the OnStackFailure parameter is set to\n DELETE for the change set for the parent stack, any failure in a child stack\n will cause the parent stack creation to fail and all stacks to be deleted.

" } }, "ImportExistingResources": { "target": "com.amazonaws.cloudformation#ImportExistingResources", "traits": { - "smithy.api#documentation": "

Indicates if the change set imports resources that already exist.

\n \n

This parameter can only import resources that have custom names in templates. For more information, see name type in the\n CloudFormation User Guide. To import resources that do not accept custom names, such as EC2 instances,\n use the resource import feature instead. For more information, see Bringing existing resources into CloudFormation\n management in the CloudFormation User Guide.

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

Indicates if the change set imports resources that already exist.

\n \n

This parameter can only import resources that have custom names in templates. For more\n information, see name type in the\n CloudFormation User Guide. To import resources that do not accept custom\n names, such as EC2 instances, use the resource import feature instead. For more information,\n see Import Amazon Web Services resources into\n a CloudFormation stack with a resource import in the\n CloudFormation User Guide.

\n " } } }, @@ -2689,7 +2689,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of\n the template generation using the DescribeGeneratedTemplate API action.

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

Creates a template from existing resources that are not already managed with CloudFormation.\n You can check the status of the template generation using the\n DescribeGeneratedTemplate API action.

", "smithy.api#examples": [ { "title": "To create a generated template", @@ -2724,7 +2724,7 @@ "Resources": { "target": "com.amazonaws.cloudformation#ResourceDefinitions", "traits": { - "smithy.api#documentation": "

An optional list of resources to be included in the generated template.

\n

If no resources are specified,the template will be created without any resources. Resources can be added to the\n template using the UpdateGeneratedTemplate API action.

" + "smithy.api#documentation": "

An optional list of resources to be included in the generated template.

\n

If no resources are specified,the template will be created without any resources.\n Resources can be added to the template using the UpdateGeneratedTemplate API\n action.

" } }, "GeneratedTemplateName": { @@ -2738,13 +2738,13 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

An optional name or ARN of a stack to use as the base stack for the generated template.

" + "smithy.api#documentation": "

An optional name or ARN of a stack to use as the base stack for the generated\n template.

" } }, "TemplateConfiguration": { "target": "com.amazonaws.cloudformation#TemplateConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.

" + "smithy.api#documentation": "

The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.

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

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.\n You can check the status of the stack through the DescribeStacks operation.

" + "smithy.api#documentation": "

Creates a stack as specified in the template. After the call completes successfully, the\n stack creation starts. You can check the status of the stack through the DescribeStacks operation.

\n

For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services\n resources as a single unit with CloudFormation stacks in the\n CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#CreateStackInput": { @@ -2799,110 +2799,110 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name that's associated with the stack. The name must be unique in the Region in which you are creating the\n stack.

\n \n

A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an\n alphabetical character and can't be longer than 128 characters.

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

The name that's associated with the stack. The name must be unique in the Region in which\n you are creating the stack.

\n \n

A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It\n must start with an alphabetical character and can't be longer than 128 characters.

\n ", "smithy.api#required": {} } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template anatomy in the CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.

\n

Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location\n for an Amazon S3 bucket must start with https://.

\n

Conditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.

" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.

" + "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.

" } }, "DisableRollback": { "target": "com.amazonaws.cloudformation#DisableRollback", "traits": { - "smithy.api#documentation": "

Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.

\n

Default: false\n

" + "smithy.api#documentation": "

Set to true to disable rollback of the stack if stack creation failed. You\n can specify either DisableRollback or OnFailure, but not\n both.

\n

Default: false\n

" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the\n specified monitoring period afterwards.

" + "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.

" } }, "TimeoutInMinutes": { "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { - "smithy.api#documentation": "

The amount of time that can pass before the stack status becomes CREATE_FAILED; if\n DisableRollback is not set or is set to false, the stack will be rolled back.

" + "smithy.api#documentation": "

The amount of time that can pass before the stack status becomes\n CREATE_FAILED; if DisableRollback is not set or is set to\n false, the stack will be rolled back.

" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "

The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

" + "smithy.api#documentation": "

The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs\n using the Amazon SNS console or your Command Line Interface (CLI).

" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.

    \n

    If you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.

    \n \n

    You should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.

    \n

    Each macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.

    \n     \n

    For more information, see Using CloudFormation macros to perform custom processing\n on templates.

    \n
    • \n
\n \n

Only one of the Capabilities and ResourceType parameters can be specified.

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

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n

    If you want to create a stack from a stack template that contains macros\n and nested stacks, you must create the stack directly from the\n template using this capability.

    \n \n

    You should only create stacks directly from a stack template that contains macros if\n you know what processing the macro performs.

    \n

    Each macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.

    \n     \n

    For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
    • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n " } }, "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a\n specific custom resource), AWS::service_name::* (for all resources of a particular\n Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific\n Amazon Web Services resource).

\n

If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

\n \n

Only one of the Capabilities and ResourceType parameters can be specified.

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

The template resource types that you have permissions to work with for this create stack\n action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all Amazon Web Services resources), Custom::* (for all\n custom resources), Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a particular\n Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).

\n

If the list of resource types doesn't include a resource that you're creating, the stack\n creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses\n this parameter for CloudFormation-specific condition keys in IAM policies. For more information,\n see Control access with\n Identity and Access Management.

\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n " } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n create the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses\n this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to create the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.

" } }, "OnFailure": { "target": "com.amazonaws.cloudformation#OnFailure", "traits": { - "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.

\n

Default: ROLLBACK\n

" + "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. This must be one of:\n DO_NOTHING, ROLLBACK, or DELETE. You can specify\n either OnFailure or DisableRollback, but not both.

\n

Default: ROLLBACK\n

" } }, "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

" + "smithy.api#documentation": "

Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with https://.\n You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not\n both.

" + "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3\n bucket must start with https://. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.

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

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in\n the stack. A maximum number of 50 tags can be specified.

" + "smithy.api#documentation": "

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the\n resources created in the stack. A maximum number of 50 tags can be specified.

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

A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n CreateStack requests to ensure that CloudFormation successfully received them.

\n

All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

A unique identifier for this CreateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to create a stack\n with the same name. You might retry CreateStack requests to ensure that\n CloudFormation successfully received them.

\n

All events initiated by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } }, "EnableTerminationProtection": { "target": "com.amazonaws.cloudformation#EnableTerminationProtection", "traits": { - "smithy.api#documentation": "

Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with\n termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks\n by default.

\n

For nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.

" + "smithy.api#documentation": "

Whether to enable termination protection on the specified stack. If a user attempts to\n delete a stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protect CloudFormation\n stacks from being deleted in the CloudFormation User Guide. Termination\n protection is deactivated on stacks by default.

\n

For nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack.

" } }, "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.

\n

Default: false\n

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.

\n

Default: false\n

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

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack\n instance refers to a stack in a specific account and Region. You must specify at least one value for either\n Accounts or DeploymentTargets, and you must specify at least one value for\n Regions.

" + "smithy.api#documentation": "

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A\n stack instance refers to a stack in a specific account and Region. You must specify at least\n one value for either Accounts or DeploymentTargets, and you must\n specify at least one value for Regions.

" } }, "com.amazonaws.cloudformation#CreateStackInstancesInput": { @@ -2950,34 +2950,34 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to create stack instances from.

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

The name or unique ID of the stack set that you want to create stack instances\n from.

", "smithy.api#required": {} } }, "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack\n instances in the specified Region(s) for.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create\n stack instances in the specified Region(s) for.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts for which to create stack instances in the\n specified Amazon Web Services Regions.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts for which to create stack\n instances in the specified Amazon Web Services Regions.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified\n Amazon Web Services accounts.

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

The names of one or more Amazon Web Services Regions where you want to create stack instances using the\n specified Amazon Web Services accounts.

", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of stack set parameters whose values you want to override in the selected stack instances.

\n

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values\n during stack instance operations:

\n
    \n
  • \n

    To override the current value for a parameter, include the parameter and specify its value.

    \n
    • \n
  • \n

    To leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)

    \n
    • \n
  • \n

    To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.

    \n
    • \n
  • \n

    To leave all parameters set to their present values, don't specify this property at all.

    \n
    • \n
\n

During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.

\n

You can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template.

" + "smithy.api#documentation": "

A list of stack set parameters whose values you want to override in the selected stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance operations:

\n
    \n
  • \n

    To override the current value for a parameter, include the parameter and specify its\n value.

    \n
    • \n
  • \n

    To leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)

    \n
    • \n
  • \n

    To set an overridden parameter back to the value specified in the stack set, specify a\n parameter list but don't include the parameter in the list.

    \n
    • \n
  • \n

    To leave all parameters set to their present values, don't specify this property at\n all.

    \n
    • \n
\n

During stack set updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet\n to update the stack set template.

" } }, "OperationPreferences": { @@ -2989,14 +2989,14 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.

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

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -3063,32 +3063,32 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name to associate with the stack set. The name must be unique in the Region where you create your stack\n set.

\n \n

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an\n alphabetic character and can't be longer than 128 characters.

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

The name to associate with the stack set. The name must be unique in the Region where you\n create your stack set.

\n \n

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It\n must start with an alphabetic character and can't be longer than 128 characters.

\n ", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.cloudformation#Description", "traits": { - "smithy.api#documentation": "

A description of the stack set. You can use the description to identify the stack set's purpose or other\n important information.

" + "smithy.api#documentation": "

A description of the stack set. You can use the description to identify the stack set's\n purpose or other important information.

" } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + "smithy.api#documentation": "

The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but\n not both.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see\n Template Anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + "smithy.api#documentation": "

The location of the file that contains the template body. The URL must point to a template\n (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager\n document.

\n

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but\n not both.

" } }, "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.

" + "smithy.api#documentation": "

The stack ID you are importing into a new stack set. Specify the Amazon Resource Name\n (ARN) of the stack.

" } }, "Parameters": { @@ -3100,56 +3100,56 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must explicitly\n acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.

    \n \n

    Stack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions,\n if you reference a macro in your template the stack set operation will fail.

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

In some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for CloudFormation to create the stack set and related stack\n instances.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new IAM users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some templates reference macros. If your stack set template references one or more\n macros, you must create the stack set directly from the processed template, without first\n reviewing the resulting changes in a change set. To create the stack set directly, you\n must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.

    \n \n

    Stack sets with service-managed permissions don't currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if\n you specify this capability for a stack set with service-managed permissions, if you\n reference a macro in your template the stack set operation will fail.

    \n     \n
    • \n
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates\n these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be\n specified.

\n

If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the\n required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an\n access denied error, and the stack set is not created.

" + "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks. A\n maximum number of 50 tags can be specified.

\n

If you specify tags as part of a CreateStackSet action, CloudFormation checks to\n see if you have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the\n stack set is not created.

" } }, "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control which users or groups can\n manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting\n Permissions for Stack Set Operations in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Prerequisites: Granting\n Permissions for Stack Set Operations in the\n CloudFormation User Guide.

" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The name of the IAM execution role to use to create the stack set. If you do not specify an execution role,\n CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which stack resources users\n and groups can include in their stack sets.

" + "smithy.api#documentation": "

The name of the IAM execution role to use to create the stack set. If you do not specify\n an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole\n role for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.

" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.

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

Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.

\n " } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "

Describes whether StackSets automatically deploys to Organizations accounts that are added to the target\n organization or organizational unit (OU). Specify only if PermissionModel is\n SERVICE_MANAGED.

" + "smithy.api#documentation": "

Describes whether StackSets automatically deploys to Organizations accounts that\n are added to the target organization or organizational unit (OU). Specify only if\n PermissionModel is SERVICE_MANAGED.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    To create a stack set with service-managed permissions while signed in to the management account,\n specify SELF.

    \n
    • \n
  • \n

    To create a stack set with service-managed permissions while signed in to a delegated administrator account,\n specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated admin in the management account.\n For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

    \n
    • \n
\n

Stack sets with service-managed permissions are created in the management account, including stack\n sets that are created by delegated administrators.

" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    To create a stack set with service-managed permissions while signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    To create a stack set with service-managed permissions while signed in to a delegated\n administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated admin in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
\n

Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated\n administrators.

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

A unique identifier for this CreateStackSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another stack set with the same name. You might\n retry CreateStackSet requests to ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.

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

A unique identifier for this CreateStackSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to create\n another stack set with the same name. You might retry CreateStackSet requests to\n ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

", "smithy.api#idempotencyToken": {} } }, "ManagedExecution": { "target": "com.amazonaws.cloudformation#ManagedExecution", "traits": { - "smithy.api#documentation": "

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.

" + "smithy.api#documentation": "

Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.

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

Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your\n organization.

" + "smithy.api#documentation": "

Deactivates trusted access with Organizations. If trusted access is deactivated,\n the management account does not have permissions to create and manage\n service-managed StackSets for your organization.

" } }, "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput": { @@ -3242,7 +3242,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deactivates a public extension that was previously activated in this account and Region.

\n

Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack update operations\n where the stack template includes the extension, even if no updates are being made to the extension. In addition,\n deactivated extensions aren't automatically updated if a new version of the extension is released.

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

Deactivates a public extension that was previously activated in this account and\n Region.

\n

Once deactivated, an extension can't be used in any CloudFormation operation. This includes\n stack update operations where the stack template includes the extension, even if no updates\n are being made to the extension. In addition, deactivated extensions aren't automatically\n updated if a new version of the extension is released.

", "smithy.api#idempotent": {} } }, @@ -3252,19 +3252,19 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The type name of the extension, in this account and Region. If you specified a type name alias when enabling the\n extension, use the type name alias.

\n

Conditional: You must specify either Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The type name of the extension, in this account and Region. If you specified a type name\n alias when enabling the extension, use the type name alias.

\n

Conditional: You must specify either Arn, or TypeName and\n Type.

" } }, "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "

The extension type.

\n

Conditional: You must specify either Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The extension type.

\n

Conditional: You must specify either Arn, or TypeName and\n Type.

" } }, "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

Conditional: You must specify either Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

Conditional: You must specify either Arn, or TypeName and\n Type.

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

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

\n

If the call successfully completes, CloudFormation successfully deleted the change set.

\n

If IncludeNestedStacks specifies True during the creation of the nested change set,\n then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also\n delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.

" + "smithy.api#documentation": "

Deletes the specified change set. Deleting change sets ensures that no one executes the\n wrong change set.

\n

If the call successfully completes, CloudFormation successfully deleted the change set.

\n

If IncludeNestedStacks specifies True during the creation of the\n nested change set, then DeleteChangeSet will delete all change sets that belong\n to the stacks hierarchy and will also delete all change sets for nested stacks with the status\n of REVIEW_IN_PROGRESS.

" } }, "com.amazonaws.cloudformation#DeleteChangeSetInput": { @@ -3310,7 +3310,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's\n associated with it.

" + "smithy.api#documentation": "

If you specified the name of a change set to delete, specify the stack name or Amazon\n Resource Name (ARN) that's associated with it.

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

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't\n show up in the DescribeStacks operation if the deletion has been completed successfully.

" + "smithy.api#documentation": "

Deletes a specified stack. Once the call completes successfully, stack deletion starts.\n Deleted stacks don't show up in the DescribeStacks operation if the deletion\n has been completed successfully.

\n

For more information about deleting a stack, see Delete a stack from\n the CloudFormation console in the CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#DeleteStackInput": { @@ -3403,25 +3403,25 @@ "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { - "smithy.api#documentation": "

For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the retained\n resources.

\n

Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.

" + "smithy.api#documentation": "

For stacks in the DELETE_FAILED state, a list of resource logical IDs that\n are associated with the resources you want to retain. During deletion, CloudFormation deletes the\n stack but doesn't delete the retained resources.

\n

Retaining resources is useful when you can't delete a resource, such as a non-empty S3\n bucket, but you want to delete the stack.

" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that's generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to delete the\n stack. CloudFormation uses the role's credentials to make calls on your behalf.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that's generated from\n your user credentials.

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

A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n DeleteStack requests to ensure that CloudFormation successfully received them.

\n

All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

A unique identifier for this DeleteStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to delete a stack\n with the same name. You might retry DeleteStack requests to ensure that\n CloudFormation successfully received them.

\n

All events initiated by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } }, "DeletionMode": { "target": "com.amazonaws.cloudformation#DeletionMode", "traits": { - "smithy.api#documentation": "

Specifies the deletion mode for the stack. Possible values are:

\n
    \n
  • \n

    \n STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this\n parameter.

    \n
    • \n
  • \n

    \n FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to\n resource deletion failure.

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

Specifies the deletion mode for the stack. Possible values are:

\n
    \n
  • \n

    \n STANDARD - Use the standard behavior. Specifying this value is the same\n as not specifying this parameter.

    \n
    • \n
  • \n

    \n FORCE_DELETE_STACK - Delete the stack if it's stuck in a\n DELETE_FAILED state due to resource deletion failure.

    \n
    • \n
" } } }, @@ -3473,13 +3473,13 @@ "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances\n for.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack\n instances for.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts from which to delete stack instances.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts from which to delete\n stack instances.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "Regions": { @@ -3500,21 +3500,21 @@ "target": "com.amazonaws.cloudformation#RetainStacks", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a\n retained stack or add an existing, saved stack to a new stack set.

\n

For more information, see Stack set operation\n options.

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

Removes the stack instances from the specified stack set, but doesn't delete the stacks.\n You can't reassociate a retained stack or add an existing, saved stack to a new stack\n set.

\n

For more information, see Stack set operation options.

", "smithy.api#required": {} } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

If you don't specify an operation ID, the SDK generates one automatically.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You can retry stack set operation requests to\n ensure that CloudFormation successfully received them.

\n

Repeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.

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

The unique identifier for this stack set operation.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n can retry stack set operation requests to ensure that CloudFormation successfully received\n them.

\n

Repeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

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

Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more\n information about how to complete this, see DeleteStackInstances.

" + "smithy.api#documentation": "

Deletes a stack set. Before you can delete a stack set, all its member stack instances\n must be deleted. For more information about how to complete this, see DeleteStackInstances.

" } }, "com.amazonaws.cloudformation#DeleteStackSetInput": { @@ -3563,14 +3563,14 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.

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

The name or unique ID of the stack set that you're deleting. You can obtain this value by\n running ListStackSets.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

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

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from\n active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

\n

To deregister an entire extension, you must individually deregister all active versions of that extension. If an\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.

\n

You can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.

\n

To view the deprecation status of an extension or extension version, use DescribeType.

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

Marks an extension or extension version as DEPRECATED in the CloudFormation\n registry, removing it from active use. Deprecated extensions or extension versions cannot be\n used in CloudFormation operations.

\n

To deregister an entire extension, you must individually deregister all active versions of\n that extension. If an extension has only a single active version, deregistering that version\n results in the extension itself being deregistered and marked as deprecated in the\n registry.

\n

You can't deregister the default version of an extension if there are other active version\n of that extension. If you do deregister the default version of an extension, the extension\n type itself is deregistered as well and marked as deprecated.

\n

To view the deprecation status of an extension or extension version, use DescribeType.

", "smithy.api#idempotent": {} } }, @@ -3681,25 +3681,25 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The kind of extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The kind of extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.

" + "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

" } } }, @@ -3723,7 +3723,7 @@ "target": "com.amazonaws.cloudformation#DescribeAccountLimitsOutput" }, "traits": { - "smithy.api#documentation": "

Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.\n For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.

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

Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you\n can create in your account. For more information about account limits, see Understand CloudFormation quotas in the CloudFormation User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3752,13 +3752,13 @@ "AccountLimits": { "target": "com.amazonaws.cloudformation#AccountLimitList", "traits": { - "smithy.api#documentation": "

An account limit structure that contain a list of CloudFormation account limits and their values.

" + "smithy.api#documentation": "

An account limit structure that contain a list of CloudFormation account limits and their\n values.

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

If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page\n exists, this value is null.

" + "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of limits. If\n no additional page exists, this value is null.

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

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.\n For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.

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

Returns the inputs for the change set and a list of changes that CloudFormation will make if\n you execute the change set. For more information, see Update\n CloudFormation stacks using change sets in the\n CloudFormation User Guide.

", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -3835,7 +3835,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the\n change set.

" + "smithy.api#documentation": "

Returns hook-related information for the change set and a list of changes that CloudFormation\n makes when you run the change set.

" } }, "com.amazonaws.cloudformation#DescribeChangeSetHooksInput": { @@ -3852,19 +3852,19 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want\n to describe.

" + "smithy.api#documentation": "

If you specified the name of a change set, specify the stack name or stack ID (ARN) of the\n change set you want to describe.

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

A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of\n information that you want to retrieve.

" + "smithy.api#documentation": "

A string, provided by the DescribeChangeSetHooks response output, that\n identifies the next page of information that you want to retrieve.

" } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "

If specified, lists only the hooks related to the specified LogicalResourceId.

" + "smithy.api#documentation": "

If specified, lists only the hooks related to the specified\n LogicalResourceId.

" } } }, @@ -3936,19 +3936,19 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to\n describe.

" + "smithy.api#documentation": "

If you specified the name of a change set, specify the stack name or ID (ARN) of the\n change set you want to describe.

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

A string (provided by the DescribeChangeSet response output) that identifies the next page of\n information that you want to retrieve.

" + "smithy.api#documentation": "

A string (provided by the DescribeChangeSet response output) that\n identifies the next page of information that you want to retrieve.

" } }, "IncludePropertyValues": { "target": "com.amazonaws.cloudformation#IncludePropertyValues", "traits": { - "smithy.api#documentation": "

If true, the returned changes include detailed changes in the property values.

" + "smithy.api#documentation": "

If true, the returned changes include detailed changes in the property\n values.

" } } }, @@ -3993,7 +3993,7 @@ "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the Parameter data type.

" + "smithy.api#documentation": "

A list of Parameter structures that describes the input parameters and their\n values used to create the change set. For more information, see the Parameter data type.

" } }, "CreationTime": { @@ -4005,37 +4005,37 @@ "ExecutionStatus": { "target": "com.amazonaws.cloudformation#ExecutionStatus", "traits": { - "smithy.api#documentation": "

If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already\n updated.

" + "smithy.api#documentation": "

If the change set execution status is AVAILABLE, you can execute the change\n set. If you can't execute the change set, the status indicates why. For example, a change set\n might be in an UNAVAILABLE state because CloudFormation is still creating it or in an\n OBSOLETE state because the stack was already updated.

" } }, "Status": { "target": "com.amazonaws.cloudformation#ChangeSetStatus", "traits": { - "smithy.api#documentation": "

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.

" + "smithy.api#documentation": "

The current status of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.

" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#ChangeSetStatusReason", "traits": { - "smithy.api#documentation": "

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

" + "smithy.api#documentation": "

A description of the change set's status. For example, if your attempt to create a change\n set failed, CloudFormation shows the error message.

" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you\n execute the change set.

" + "smithy.api#documentation": "

The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the\n change set.

" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.

" + "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.

" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set\n was created.

" + "smithy.api#documentation": "

If you execute the change set, the list of capabilities that were explicitly acknowledged\n when the change set was created.

" } }, "Tags": { @@ -4047,13 +4047,13 @@ "Changes": { "target": "com.amazonaws.cloudformation#Changes", "traits": { - "smithy.api#documentation": "

A list of Change structures that describes the resources CloudFormation changes if you execute the change\n set.

" + "smithy.api#documentation": "

A list of Change structures that describes the resources CloudFormation changes\n if you execute the change set.

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

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page,\n this value is null.

" + "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is\n no additional page, this value is null.

" } }, "IncludeNestedStacks": { @@ -4065,25 +4065,25 @@ "ParentChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

" + "smithy.api#documentation": "

Specifies the change set ID of the parent change set in the current nested change set\n hierarchy.

" } }, "RootChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "

Specifies the change set ID of the root change set in the current nested change set hierarchy.

" + "smithy.api#documentation": "

Specifies the change set ID of the root change set in the current nested change set\n hierarchy.

" } }, "OnStackFailure": { "target": "com.amazonaws.cloudformation#OnStackFailure", "traits": { - "smithy.api#documentation": "

Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must\n not be specified. This must be one of these values:

\n
    \n
  • \n

    \n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.

    \n
    • \n
  • \n

    \n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.

    \n
    • \n
  • \n

    \n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.

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

Determines what action will be taken if stack creation fails. When this parameter is\n specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these\n values:

\n
    \n
  • \n

    \n DELETE - Deletes the change set if the stack creation fails. This is only\n valid when the ChangeSetType parameter is set to CREATE. If the\n deletion of the stack fails, the status of the stack is DELETE_FAILED.

    \n
    • \n
  • \n

    \n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent\n to specifying true for the DisableRollback parameter to the\n ExecuteChangeSet API operation.

    \n
    • \n
  • \n

    \n ROLLBACK - if the stack creation fails, roll back the stack. This is\n equivalent to specifying false for the DisableRollback parameter\n to the ExecuteChangeSet API operation.

    \n
    • \n
" } }, "ImportExistingResources": { "target": "com.amazonaws.cloudformation#ImportExistingResources", "traits": { - "smithy.api#documentation": "

Indicates if the change set imports resources that already exist.

\n \n

This parameter can only import resources that have custom names in templates. To import\n resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

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

Indicates if the change set imports resources that already exist.

\n \n

This parameter can only import resources that have custom names in\n templates. To import resources that do not accept custom names, such as EC2 instances, use\n the resource import\n feature instead.

\n " } } }, @@ -4106,7 +4106,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a generated template. The output includes details about the progress of the creation of a generated\n template started by a CreateGeneratedTemplate API action or the update of a generated template started\n with an UpdateGeneratedTemplate API action.

" + "smithy.api#documentation": "

Describes a generated template. The output includes details about the progress of the\n creation of a generated template started by a CreateGeneratedTemplate API action\n or the update of a generated template started with an UpdateGeneratedTemplate API\n action.

" } }, "com.amazonaws.cloudformation#DescribeGeneratedTemplateInput": { @@ -4131,7 +4131,7 @@ "GeneratedTemplateId": { "target": "com.amazonaws.cloudformation#GeneratedTemplateId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

" } }, "GeneratedTemplateName": { @@ -4143,7 +4143,7 @@ "Resources": { "target": "com.amazonaws.cloudformation#ResourceDetails", "traits": { - "smithy.api#documentation": "

A list of objects describing the details of the resources in the template generation.

" + "smithy.api#documentation": "

A list of objects describing the details of the resources in the template\n generation.

" } }, "Status": { @@ -4155,7 +4155,7 @@ "StatusReason": { "target": "com.amazonaws.cloudformation#TemplateStatusReason", "traits": { - "smithy.api#documentation": "

The reason for the current template generation status. This will provide more details if a failure\n happened.

" + "smithy.api#documentation": "

The reason for the current template generation status. This will provide more details if a\n failure happened.

" } }, "CreationTime": { @@ -4179,19 +4179,19 @@ "StackId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

The stack ARN of the base stack if a base stack was provided when generating the template.

" + "smithy.api#documentation": "

The stack ARN of the base stack if a base stack was provided when generating the\n template.

" } }, "TemplateConfiguration": { "target": "com.amazonaws.cloudformation#TemplateConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.

" + "smithy.api#documentation": "

The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.

" } }, "TotalWarnings": { "target": "com.amazonaws.cloudformation#TotalWarnings", "traits": { - "smithy.api#documentation": "

The number of warnings generated for this template. The warnings are found in the details of each of the\n resources in the template.

" + "smithy.api#documentation": "

The number of warnings generated for this template. The warnings are found in the details\n of each of the resources in the template.

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

Retrieves information about the account's OrganizationAccess status. This API can be called either\n by the management account or the delegated administrator by using the CallAs parameter. This API can\n also be called without the CallAs parameter by the management account.

" + "smithy.api#documentation": "

Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.

" } }, "com.amazonaws.cloudformation#DescribeOrganizationsAccessInput": { @@ -4225,7 +4225,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

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

Returns information about a CloudFormation extension publisher.

\n

If you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.

\n

For more information about registering as a publisher, see:

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

Returns information about a CloudFormation extension publisher.

\n

If you don't supply a PublisherId, and you have registered as an extension\n publisher, DescribePublisher returns information about your own publisher\n account.

\n

For more information about registering as a publisher, see:

\n ", "smithy.api#idempotent": {} } }, @@ -4271,7 +4271,7 @@ "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { - "smithy.api#documentation": "

The ID of the extension publisher.

\n

If you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.

" + "smithy.api#documentation": "

The ID of the extension publisher.

\n

If you don't supply a PublisherId, and you have registered as an extension\n publisher, DescribePublisher returns information about your own publisher\n account.

" } } }, @@ -4291,13 +4291,13 @@ "PublisherStatus": { "target": "com.amazonaws.cloudformation#PublisherStatus", "traits": { - "smithy.api#documentation": "

Whether the publisher is verified. Currently, all registered publishers are verified.

" + "smithy.api#documentation": "

Whether the publisher is verified. Currently, all registered publishers are\n verified.

" } }, "IdentityProvider": { "target": "com.amazonaws.cloudformation#IdentityProvider", "traits": { - "smithy.api#documentation": "

The type of account used as the identity provider when registering this publisher with CloudFormation.

" + "smithy.api#documentation": "

The type of account used as the identity provider when registering this publisher with\n CloudFormation.

" } }, "PublisherProfile": { @@ -4350,19 +4350,19 @@ "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An\n example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .

" } }, "Status": { "target": "com.amazonaws.cloudformation#ResourceScanStatus", "traits": { - "smithy.api#documentation": "

Status of the resource scan.

\n
\n
INPROGRESS
\n
\n

The resource scan is still in progress.

\n
\n
COMPLETE
\n
\n

The resource scan is complete.

\n
\n
EXPIRED
\n
\n

The resource scan has expired.

\n
\n
FAILED
\n
\n

The resource scan has failed.

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

Status of the resource scan.

\n
\n
\n \n INPROGRESS\n \n
\n
\n

The resource scan is still in progress.

\n
\n
\n \n COMPLETE\n \n
\n
\n

The resource scan is complete.

\n
\n
\n \n EXPIRED\n \n
\n
\n

The resource scan has expired.

\n
\n
\n \n FAILED\n \n
\n
\n

The resource scan has failed.

\n
\n
" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#ResourceScanStatusReason", "traits": { - "smithy.api#documentation": "

The reason for the resource scan status, providing more information if a failure happened.

" + "smithy.api#documentation": "

The reason for the resource scan status, providing more information if a failure\n happened.

" } }, "StartTime": { @@ -4386,19 +4386,19 @@ "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

The list of resource types for the specified scan. Resource types are only available for scans with a\n Status set to COMPLETE or FAILED .

" + "smithy.api#documentation": "

The list of resource types for the specified scan. Resource types are only available for\n scans with a Status set to COMPLETE or FAILED .

" } }, "ResourcesScanned": { "target": "com.amazonaws.cloudformation#ResourcesScanned", "traits": { - "smithy.api#documentation": "

The number of resources that were listed. This is only available for scans with a Status set to\n COMPLETE, EXPIRED, or FAILED .

" + "smithy.api#documentation": "

The number of resources that were listed. This is only available for scans with a\n Status set to COMPLETE, EXPIRED, or FAILED\n .

" } }, "ResourcesRead": { "target": "com.amazonaws.cloudformation#ResourcesRead", "traits": { - "smithy.api#documentation": "

The number of resources that were read. This is only available for scans with a Status set to\n COMPLETE, EXPIRED, or FAILED .

\n \n

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

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

The number of resources that were read. This is only available for scans with a\n Status set to COMPLETE, EXPIRED, or FAILED\n .

\n \n

This field may be 0 if the resource scan failed with a\n ResourceScanLimitExceededException.

\n " } } }, @@ -4415,7 +4415,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput" }, "traits": { - "smithy.api#documentation": "

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.

\n

Use DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the\n operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use\n DescribeStackResourceDrifts to return drift information about the stack and its resources.

" + "smithy.api#documentation": "

Returns information about a stack drift detection operation. A stack drift detection\n operation detects whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. A stack is considered to have\n drifted if one or more of its resources have drifted. For more information about stack and\n resource drift, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.

\n

Use DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to\n monitor the progress of the operation using DescribeStackDriftDetectionStatus.\n Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.

" } }, "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput": { @@ -4425,7 +4425,7 @@ "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.

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

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of drift results CloudFormation retains for any given stack, and for\n how long, may vary.

", "smithy.api#required": {} } } @@ -4449,21 +4449,21 @@ "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of reports CloudFormation retains for any given stack, and for how long, may vary.

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

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of reports CloudFormation retains for any given stack, and for how\n long, may vary.

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

Status of the stack's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.

    \n
    • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template configuration.

    \n
    • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

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

Status of the stack's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A\n stack is considered to have drifted if one or more of its resources have drifted.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its\n expected template configuration.

    \n
    • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
    • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
    • \n
" } }, "DetectionStatus": { "target": "com.amazonaws.cloudformation#StackDriftDetectionStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The status of the stack drift detection operation.

\n
    \n
  • \n

    \n DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all\n resources in the stack that support drift detection. (Resources that don't currently support stack detection remain\n unchecked.)

    \n

    If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation,\n only the resources with those logical IDs are checked for drift.

    \n
    • \n
  • \n

    \n DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the\n stack. Results will be available for resources on which CloudFormation successfully completed drift detection.

    \n
    • \n
  • \n

    \n DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

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

The status of the stack drift detection operation.

\n
    \n
  • \n

    \n DETECTION_COMPLETE: The stack drift detection operation has successfully\n completed for all resources in the stack that support drift detection. (Resources that\n don't currently support stack detection remain unchecked.)

    \n

    If you specified logical resource IDs for CloudFormation to use as a filter for the stack\n drift detection operation, only the resources with those logical IDs are checked for\n drift.

    \n
    • \n
  • \n

    \n DETECTION_FAILED: The stack drift detection operation has failed for at\n least one resource in the stack. Results will be available for resources on which\n CloudFormation successfully completed drift detection.

    \n
    • \n
  • \n

    \n DETECTION_IN_PROGRESS: The stack drift detection operation is currently\n in progress.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -4476,7 +4476,7 @@ "DriftedStackResourceCount": { "target": "com.amazonaws.cloudformation#BoxedInteger", "traits": { - "smithy.api#documentation": "

Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a\n status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is\n IN_SYNC.

" + "smithy.api#documentation": "

Total number of stack resources that have drifted. This is NULL until the drift detection\n operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks\n whose drift status is IN_SYNC.

" } }, "Timestamp": { @@ -4501,7 +4501,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackEventsOutput" }, "traits": { - "smithy.api#documentation": "

Returns all stack related events for a specified stack in reverse chronological order. For more information\n about a stack's event history, see CloudFormation stack creation\n events in the CloudFormation User Guide.

\n \n

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).

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

Returns all stack related events for a specified stack in reverse chronological order. For\n more information about a stack's event history, see Understand CloudFormation stack creation events in the\n CloudFormation User Guide.

\n \n

You can list events for stacks that have failed to create or have been deleted by\n specifying the unique stack identifier (stack ID).

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4515,7 +4515,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

" + "smithy.api#documentation": "

The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

" } }, "NextToken": { @@ -4542,7 +4542,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page\n exists, this value is null.

" + "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of events. If\n no additional page exists, this value is null.

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

Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and\n Amazon Web Services Region.

\n

For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.

" + "smithy.api#documentation": "

Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account,\n and Amazon Web Services Region.

\n

For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.

" } }, "com.amazonaws.cloudformation#DescribeStackInstanceInput": { @@ -4578,7 +4578,7 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the unique stack ID of the stack set that you want to get stack instance information for.

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

The name or the unique stack ID of the stack set that you want to get stack instance\n information for.

", "smithy.api#required": {} } }, @@ -4601,7 +4601,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -4632,7 +4632,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackResourceOutput" }, "traits": { - "smithy.api#documentation": "

Returns a description of the specified resource in the specified stack.

\n

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has\n been deleted.

" + "smithy.api#documentation": "

Returns a description of the specified resource in the specified stack.

\n

For deleted stacks, DescribeStackResource returns resource information for up to 90 days\n after the stack has been deleted.

" } }, "com.amazonaws.cloudformation#DescribeStackResourceDrifts": { @@ -4644,7 +4644,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsOutput" }, "traits": { - "smithy.api#documentation": "

Returns drift information for the resources that have been checked for drift in the specified stack. This\n includes actual and expected configuration values for resources where CloudFormation detects configuration drift.

\n

For a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.

\n

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.

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

Returns drift information for the resources that have been checked for drift in the\n specified stack. This includes actual and expected configuration values for resources where\n CloudFormation detects configuration drift.

\n

For a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n aren't included. Resources that don't currently support drift detection aren't checked, and so\n not included. For a list of resources that support drift detection, see Resource\n type support for imports and drift detection.

\n

Use DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all supported resources for a given\n stack.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4666,7 +4666,7 @@ "StackResourceDriftStatusFilters": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", "traits": { - "smithy.api#documentation": "

The resource drift status values to use as filters for the resource drift results returned.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected template values.

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected template configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation doesn't currently return this value.

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

The resource drift status values to use as filters for the resource drift results\n returned.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected\n template values.

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation doesn't currently return this value.

    \n
    • \n
" } }, "NextToken": { @@ -4678,7 +4678,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#BoxedMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

" } } }, @@ -4693,14 +4693,14 @@ "target": "com.amazonaws.cloudformation#StackResourceDrifts", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Drift information for the resources that have been checked for drift in the specified stack. This includes\n actual and expected configuration values for resources where CloudFormation detects drift.

\n

For a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.

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

Drift information for the resources that have been checked for drift in the specified\n stack. This includes actual and expected configuration values for resources where CloudFormation\n detects drift.

\n

For a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n aren't included. Resources that do not currently support drift detection aren't checked, and\n so not included. For a list of resources that support drift detection, see Resource\n type support for imports and drift detection.

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call DescribeStackResourceDrifts\n again and assign that token to the request object's NextToken parameter. If the\n request returns all results, NextToken is set to null.

" } } }, @@ -4715,7 +4715,7 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

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

The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

", "smithy.api#required": {} } }, @@ -4739,7 +4739,7 @@ "StackResourceDetail": { "target": "com.amazonaws.cloudformation#StackResourceDetail", "traits": { - "smithy.api#documentation": "

A StackResourceDetail structure containing the description of the specified resource in the\n specified stack.

" + "smithy.api#documentation": "

A StackResourceDetail structure containing the description of the specified\n resource in the specified stack.

" } } }, @@ -4757,7 +4757,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackResourcesOutput" }, "traits": { - "smithy.api#documentation": "

Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.

\n \n

Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.

\n \n

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.

\n

You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.

\n \n

A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.

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

Returns Amazon Web Services resource descriptions for running and deleted stacks. If\n StackName is specified, all the associated resources that are part of the stack\n are returned. If PhysicalResourceId is specified, the associated resources of the\n stack that the resource belongs to are returned.

\n \n

Only the first 100 resources will be returned. If your stack has more resources than\n this, you should use ListStackResources instead.

\n \n

For deleted stacks, DescribeStackResources returns resource information for\n up to 90 days after the stack has been deleted.

\n

You must specify either StackName or PhysicalResourceId, but not\n both. In addition, you can specify LogicalResourceId to filter the returned\n result. For more information about resources, the LogicalResourceId and\n PhysicalResourceId, see the CloudFormation User Guide.

\n \n

A ValidationError is returned if you specify both StackName\n and PhysicalResourceId in the same request.

\n " } }, "com.amazonaws.cloudformation#DescribeStackResourcesInput": { @@ -4766,7 +4766,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

\n

Required: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.

" + "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack, which aren't always\n interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

\n

Required: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.

" } }, "LogicalResourceId": { @@ -4778,7 +4778,7 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

\n

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n find which stack the instance belongs to and what other resources are part of the stack.

\n

Required: Conditional. If you don't specify PhysicalResourceId, you must specify\n StackName.

\n

Default: There is no default value.

" + "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.

\n

For example, for an Amazon Elastic Compute Cloud (EC2) instance,\n PhysicalResourceId corresponds to the InstanceId. You can pass the\n EC2 InstanceId to DescribeStackResources to find which stack the\n instance belongs to and what other resources are part of the stack.

\n

Required: Conditional. If you don't specify PhysicalResourceId, you must\n specify StackName.

\n

Default: There is no default value.

" } } }, @@ -4833,7 +4833,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -4883,7 +4883,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -4928,7 +4928,7 @@ "target": "com.amazonaws.cloudformation#DescribeStacksOutput" }, "traits": { - "smithy.api#documentation": "

Returns the description for the specified stack; if no stack name was specified, then it returns the description\n for all the stacks created. For more information about a stack's event history, see CloudFormation stack creation\n events in the CloudFormation User Guide.

\n \n

If the stack doesn't exist, a ValidationError is returned.

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

Returns the description for the specified stack; if no stack name was specified, then it\n returns the description for all the stacks created. For more information about a stack's event\n history, see Understand CloudFormation stack creation events in the\n CloudFormation User Guide.

\n \n

If the stack doesn't exist, a ValidationError is returned.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5384,7 +5384,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "\n

If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and\n DescribeStacks permissions.

\n

Consider using the ListStacks API if you're not passing a parameter to\n StackName.

\n

The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:

\n

{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }

\n \n

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

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

If you don't pass a parameter to StackName, the API returns a response\n that describes all resources in the account, which can impact performance. This requires\n ListStacks and DescribeStacks permissions.

\n

Consider using the ListStacks API if you're not passing a parameter to\n StackName.

\n

The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the\n request:

\n

{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }]\n }

\n \n

The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

" } }, "NextToken": { @@ -5411,7 +5411,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.

" + "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.

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

Returns detailed information about an extension that has been registered.

\n

If you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.

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

Returns detailed information about an extension that has been registered.

\n

If you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.

", "smithy.api#idempotent": {} } }, @@ -5447,25 +5447,25 @@ "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The kind of extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The kind of extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "Arn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.

\n

If you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.

" + "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

\n

If you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.

" } }, "PublisherId": { @@ -5503,31 +5503,31 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

If the extension is a public third-party type you have activated with a type name alias, CloudFormation returns the\n type name alias. For more information, see ActivateType.

" + "smithy.api#documentation": "

The name of the extension.

\n

If the extension is a public third-party type you have activated with a type name alias,\n CloudFormation returns the type name alias. For more information, see ActivateType.

" } }, "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.

\n

This applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more\n information, see RegisterType.

\n

To set the default version of an extension, use SetTypeDefaultVersion.

" + "smithy.api#documentation": "

The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.

\n

This applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns\n null. For more information, see RegisterType.

\n

To set the default version of an extension, use SetTypeDefaultVersion.

" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

Whether the specified extension version is set as the default version.

\n

This applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation returns\n null.

" + "smithy.api#documentation": "

Whether the specified extension version is set as the default version.

\n

This applies only to private extensions you have registered in your account, and\n extensions published by Amazon Web Services. For public third-party extensions, whether they are activated\n in your account, CloudFormation returns null.

" } }, "TypeTestsStatus": { "target": "com.amazonaws.cloudformation#TypeTestsStatus", "traits": { - "smithy.api#documentation": "

The contract test status of the registered extension version. To return the extension test status of a specific\n extension version, you must specify VersionId.

\n

This applies only to registered private extension versions. CloudFormation doesn't return this information for\n public extensions, whether they are activated in your account.

\n
    \n
  • \n

    \n PASSED: The extension has passed all its contract tests.

    \n

    An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation Command Line Interface User\n Guide.

    \n
    • \n
  • \n

    \n FAILED: The extension has failed one or more contract tests.

    \n
    • \n
  • \n

    \n IN_PROGRESS: Contract tests are currently being performed on the extension.

    \n
    • \n
  • \n

    \n NOT_TESTED: Contract tests haven't been performed on the extension.

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

The contract test status of the registered extension version. To return the extension test\n status of a specific extension version, you must specify VersionId.

\n

This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.

\n
    \n
  • \n

    \n PASSED: The extension has passed all its contract tests.

    \n

    An extension must have a test status of PASSED before it can be\n published. For more information, see Publishing\n extensions to make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide.

    \n
    • \n
  • \n

    \n FAILED: The extension has failed one or more contract tests.

    \n
    • \n
  • \n

    \n IN_PROGRESS: Contract tests are currently being performed on the\n extension.

    \n
    • \n
  • \n

    \n NOT_TESTED: Contract tests haven't been performed on the\n extension.

    \n
    • \n
" } }, "TypeTestsStatusDescription": { "target": "com.amazonaws.cloudformation#TypeTestsStatusDescription", "traits": { - "smithy.api#documentation": "

The description of the test status. To return the extension test status of a specific extension version, you\n must specify VersionId.

\n

This applies only to registered private extension versions. CloudFormation doesn't return this information for\n public extensions, whether they are activated in your account.

" + "smithy.api#documentation": "

The description of the test status. To return the extension test status of a specific\n extension version, you must specify VersionId.

\n

This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.

" } }, "Description": { @@ -5539,43 +5539,43 @@ "Schema": { "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { - "smithy.api#documentation": "

The schema that defines the extension.

\n

For more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.

" + "smithy.api#documentation": "

The schema that defines the extension.

\n

For more information about extension schemas, see Resource type\n schema in the CloudFormation Command Line Interface (CLI) User Guide.

" } }, "ProvisioningType": { "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { - "smithy.api#documentation": "

For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning\n type during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

\n
    \n
  • \n

    \n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.

    \n
    • \n
  • \n

    \n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.

    \n
    • \n
  • \n

    \n NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore\n can't actually be provisioned.

    \n
      \n
    • \n

      create

      \n
      • \n
    • \n

      read

      \n
      • \n
    • \n

      delete

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

For resource type extensions, the provisioning behavior of the resource type. CloudFormation\n determines the provisioning type during registration, based on the types of handlers in the\n schema handler package submitted.

\n

Valid values include:

\n
    \n
  • \n

    \n FULLY_MUTABLE: The resource type includes an update handler to process\n updates to the type during stack update operations.

    \n
    • \n
  • \n

    \n IMMUTABLE: The resource type doesn't include an update handler, so the\n type can't be updated and must instead be replaced during stack update operations.

    \n
    • \n
  • \n

    \n NON_PROVISIONABLE: The resource type doesn't include all the following\n handlers, and therefore can't actually be provisioned.

    \n
      \n
    • \n

      create

      \n
      • \n
    • \n

      read

      \n
      • \n
    • \n

      delete

      \n
      • \n
    \n
    • \n
" } }, "DeprecatedStatus": { "target": "com.amazonaws.cloudformation#DeprecatedStatus", "traits": { - "smithy.api#documentation": "

The deprecation status of the extension version.

\n

Valid values include:

\n
    \n
  • \n

    \n LIVE: The extension is activated or registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.

    \n
    • \n
  • \n

    \n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.

    \n
    • \n
\n

For public third-party extensions, CloudFormation returns null.

" + "smithy.api#documentation": "

The deprecation status of the extension version.

\n

Valid values include:

\n
    \n
  • \n

    \n LIVE: The extension is activated or registered and can be used in\n CloudFormation operations, dependent on its provisioning behavior and visibility scope.

    \n
    • \n
  • \n

    \n DEPRECATED: The extension has been deactivated or deregistered and can no\n longer be used in CloudFormation operations.

    \n
    • \n
\n

For public third-party extensions, CloudFormation returns null.

" } }, "LoggingConfig": { "target": "com.amazonaws.cloudformation#LoggingConfig", "traits": { - "smithy.api#documentation": "

Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns null. For more information, see RegisterType.

" + "smithy.api#documentation": "

Contains logging configuration information for private extensions. This applies only to\n private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For\n more information, see RegisterType.

" } }, "RequiredActivatedTypes": { "target": "com.amazonaws.cloudformation#RequiredActivatedTypes", "traits": { - "smithy.api#documentation": "

For extensions that are modules, the public third-party extensions that must be activated in your account in\n order for the module itself to be activated.

" + "smithy.api#documentation": "

For extensions that are modules, the public third-party extensions that must be activated\n in your account in order for the module itself to be activated.

" } }, "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This applies only to\n private extensions you have registered in your account. For more information, see RegisterType.

\n

If the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n that includes\n the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account.\n CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM execution role used to register the extension.\n This applies only to private extensions you have registered in your account. For more\n information, see RegisterType.

\n

If the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution\n role\n that includes the necessary permissions to call those Amazon Web Services APIs,\n and provision that execution role in your account. CloudFormation then assumes that execution role\n to provide your extension with the appropriate credentials.

" } }, "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "

The scope at which the extension is visible and usable in CloudFormation operations.

\n

Valid values include:

\n
    \n
  • \n

    \n PRIVATE: The extension is only visible and usable within the account in which it is registered.\n CloudFormation marks any extensions you register as PRIVATE.

    \n
    • \n
  • \n

    \n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services\n account.

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

The scope at which the extension is visible and usable in CloudFormation operations.

\n

Valid values include:

\n
    \n
  • \n

    \n PRIVATE: The extension is only visible and usable within the account in\n which it is registered. CloudFormation marks any extensions you register as\n PRIVATE.

    \n
    • \n
  • \n

    \n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services\n account.

    \n
    • \n
" } }, "SourceUrl": { @@ -5593,61 +5593,61 @@ "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

When the specified extension version was registered. This applies only to:

\n
    \n
  • \n

    Private extensions you have registered in your account. For more information, see RegisterType.

    \n
    • \n
  • \n

    Public extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.

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

When the specified extension version was registered. This applies only to:

\n
    \n
  • \n

    Private extensions you have registered in your account. For more information, see\n RegisterType.

    \n
    • \n
  • \n

    Public extensions you have activated in your account with auto-update specified. For\n more information, see ActivateType.

    \n
    • \n
" } }, "TimeCreated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

When the specified private extension version was registered or activated in your account.

" + "smithy.api#documentation": "

When the specified private extension version was registered or activated in your\n account.

" } }, "ConfigurationSchema": { "target": "com.amazonaws.cloudformation#ConfigurationSchema", "traits": { - "smithy.api#documentation": "

A JSON string that represent the current configuration data for the extension in this account and Region.

\n

To set the configuration data for an extension, use SetTypeConfiguration. For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.

" + "smithy.api#documentation": "

A JSON string that represent the current configuration data for the extension in this\n account and Region.

\n

To set the configuration data for an extension, use SetTypeConfiguration. For more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.

" } }, "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { - "smithy.api#documentation": "

The publisher ID of the extension publisher.

\n

This applies only to public third-party extensions. For private registered extensions, and extensions provided\n by Amazon Web Services, CloudFormation returns null.

" + "smithy.api#documentation": "

The publisher ID of the extension publisher.

\n

This applies only to public third-party extensions. For private registered extensions, and\n extensions provided by Amazon Web Services, CloudFormation returns null.

" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the type name of the public\n extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.

" + "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the type name\n of the public extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use aliases to refer to extensions in the\n CloudFormation User Guide.

" } }, "OriginalTypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of\n the public extension.

" + "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the Amazon\n Resource Name (ARN) of the public extension.

" } }, "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "

The version number of a public third-party extension.

\n

This applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns null.

" + "smithy.api#documentation": "

The version number of a public third-party extension.

\n

This applies only if you specify a public extension you have activated in your account, or\n specify a public extension without specifying a version. For all other extensions, CloudFormation\n returns null.

" } }, "LatestPublicVersion": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "

The latest version of a public extension that is available for use.

\n

This only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.

" + "smithy.api#documentation": "

The latest version of a public extension that is available for\n use.

\n

This only applies if you specify a public extension, and you don't specify a version. For\n all other requests, CloudFormation returns null.

" } }, "IsActivated": { "target": "com.amazonaws.cloudformation#IsActivated", "traits": { - "smithy.api#documentation": "

Whether the extension is activated in the account and Region.

\n

This only applies to public third-party extensions. For all other extensions, CloudFormation returns\n null.

" + "smithy.api#documentation": "

Whether the extension is activated in the account and Region.

\n

This only applies to public third-party extensions. For all other extensions, CloudFormation\n returns null.

" } }, "AutoUpdate": { "target": "com.amazonaws.cloudformation#AutoUpdate", "traits": { - "smithy.api#documentation": "

Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions for\n use in your account in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Whether CloudFormation automatically updates the extension in this account and Region when a\n new minor version is published by the extension publisher. Major versions\n released by the publisher must be manually updated. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.

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

Returns information about an extension's registration, including its current status and type and version\n identifiers.

\n

When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.

\n

Once the registration request has completed, use DescribeType to return detailed information\n about an extension.

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

Returns information about an extension's registration, including its current status and\n type and version identifiers.

\n

When you initiate a registration request using RegisterType, you can\n then use DescribeTypeRegistration to monitor the progress of that\n registration request.

\n

Once the registration request has completed, use DescribeType to return\n detailed information about an extension.

", "smithy.api#idempotent": {}, "smithy.waiters#waitable": { "TypeRegistrationComplete": { @@ -5708,7 +5708,7 @@ "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier for this registration request.

\n

This registration token is generated by CloudFormation when you initiate a registration request using RegisterType.

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

The identifier for this registration request.

\n

This registration token is generated by CloudFormation when you initiate a registration\n request using RegisterType.

", "smithy.api#required": {} } } @@ -5735,13 +5735,13 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension being registered.

\n

For registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension being registered.

\n

For registration requests with a ProgressStatus of other than\n COMPLETE, this will be null.

" } }, "TypeVersionArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this specific version of the extension being registered.

\n

For registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this specific version of the extension being\n registered.

\n

For registration requests with a ProgressStatus of other than\n COMPLETE, this will be null.

" } } }, @@ -5784,7 +5784,7 @@ "target": "com.amazonaws.cloudformation#DetectStackDriftOutput" }, "traits": { - "smithy.api#documentation": "

Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.

\n

Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.

\n

For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.

\n

\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.

\n

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.

" + "smithy.api#documentation": "

Detects whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For each resource in the stack that\n supports drift detection, CloudFormation compares the actual configuration of the resource with\n its expected template configuration. Only resource properties explicitly defined in the stack\n template are checked for drift. A stack is considered to have drifted if one or more of its\n resources differ from their expected template configurations. For more information, see Detect unmanaged configuration changes to stacks and resources with drift\n detection.

\n

Use DetectStackDrift to detect drift on all supported resources for a given\n stack, or DetectStackResourceDrift to detect drift on individual\n resources.

\n

For a list of stack resources that currently support drift detection, see Resource\n type support for imports and drift detection.

\n

\n DetectStackDrift can take up to several minutes, depending on the number of\n resources contained within the stack. Use DescribeStackDriftDetectionStatus\n to monitor the progress of a detect stack drift operation. Once the drift detection operation\n has completed, use DescribeStackResourceDrifts to return drift information\n about the stack and its resources.

\n

When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks\n belonging to that stack. Perform DetectStackDrift directly on the nested stack\n itself.

" } }, "com.amazonaws.cloudformation#DetectStackDriftInput": { @@ -5816,7 +5816,7 @@ "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.

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

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of drift results CloudFormation retains for any given stack, and for\n how long, may vary.

", "smithy.api#required": {} } } @@ -5834,7 +5834,7 @@ "target": "com.amazonaws.cloudformation#DetectStackResourceDriftOutput" }, "traits": { - "smithy.api#documentation": "

Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.

\n

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

\n

Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.

" + "smithy.api#documentation": "

Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. This information includes actual and\n expected property values for resources in which CloudFormation detects drift. Only resource\n properties explicitly defined in the stack template are checked for drift. For more\n information about stack and resource drift, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.

\n

Use DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack that\n support drift detection.

\n

Resources that don't currently support drift detection can't be checked. For a list of\n resources that support drift detection, see Resource\n type support for imports and drift detection.

" } }, "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { @@ -5868,7 +5868,7 @@ "target": "com.amazonaws.cloudformation#StackResourceDrift", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Information about whether the resource's actual configuration has drifted from its expected template\n configuration, including actual and expected property values and any differences detected.

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

Information about whether the resource's actual configuration has drifted from its\n expected template configuration, including actual and expected property values and any\n differences detected.

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

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift\n detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation performs drift\n detection on a stack set.

\n

\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.

\n

Once the operation has completed, use the following actions to return drift information:

\n
    \n
  • \n

    Use DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)

    \n
    • \n
  • \n

    Use ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.

    \n
    • \n
  • \n

    Use DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.

    \n
    • \n
\n

For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.

\n

You can only run a single drift detection operation on a given stack set at one time.

\n

To stop a drift detection stack set operation, use StopStackSetOperation.

" + "smithy.api#documentation": "

Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it\n performs drift detection on the stack associated with each stack instance in the stack set.\n For more information, see How CloudFormation performs drift\n detection on a stack set.

\n

\n DetectStackSetDrift returns the OperationId of the stack set\n drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection\n operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each\n stack.

\n

Once the operation has completed, use the following actions to return drift\n information:

\n
    \n
  • \n

    Use DescribeStackSet to return detailed information about the stack\n set, including detailed information about the last completed drift\n operation performed on the stack set. (Information about drift operations that are in\n progress isn't included.)

    \n
    • \n
  • \n

    Use ListStackInstances to return a list of stack instances belonging\n to the stack set, including the drift status and last drift time checked of each\n instance.

    \n
    • \n
  • \n

    Use DescribeStackInstance to return detailed information about a\n specific stack instance, including its drift status and last drift time checked.

    \n
    • \n
\n

For more information about performing a drift detection operation on a stack set, see\n Detecting unmanaged changes in stack sets.

\n

You can only run a single drift detection operation on a given stack set at one\n time.

\n

To stop a drift detection stack set operation, use StopStackSetOperation.

" } }, "com.amazonaws.cloudformation#DetectStackSetDriftInput": { @@ -5914,7 +5914,7 @@ "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.

" + "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

" } }, "OperationId": { @@ -5927,7 +5927,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -5941,7 +5941,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The ID of the drift detection stack set operation.

\n

You can use this operation ID with DescribeStackSetOperation to monitor the progress of the\n drift detection operation.

" + "smithy.api#documentation": "

The ID of the drift detection stack set operation.

\n

You can use this operation ID with DescribeStackSetOperation to monitor\n the progress of the drift detection operation.

" } } }, @@ -6013,7 +6013,7 @@ "target": "com.amazonaws.cloudformation#EstimateTemplateCostOutput" }, "traits": { - "smithy.api#documentation": "

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly\n Calculator URL with a query string that describes the resources required to run the template.

" + "smithy.api#documentation": "

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple\n Monthly Calculator URL with a query string that describes the resources required to run the\n template.

" } }, "com.amazonaws.cloudformation#EstimateTemplateCostInput": { @@ -6022,13 +6022,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.

\n

Conditional: You must pass TemplateBody or TemplateURL. If both\n are passed, only TemplateBody is used.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that's\n located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must\n start with https://.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.

" } }, "Parameters": { @@ -6049,7 +6049,7 @@ "Url": { "target": "com.amazonaws.cloudformation#Url", "traits": { - "smithy.api#documentation": "

An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to\n run the template.

" + "smithy.api#documentation": "

An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources\n required to run the template.

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

Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to\n view the status of the update.

\n

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't\n valid for the updated stack.

\n

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a\n temporary stack policy that overrides the current policy.

\n

To create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.

" + "smithy.api#documentation": "

Updates a stack using the input information that was provided when the specified change\n set was created. After the call successfully completes, CloudFormation starts updating the stack.\n Use the DescribeStacks action to view the status of the update.

\n

When you execute a change set, CloudFormation deletes all other change sets associated with\n the stack because they aren't valid for the updated stack.

\n

If a stack policy is associated with the stack, CloudFormation enforces the policy during the\n update. You can't specify a temporary stack policy that overrides the current policy.

\n

To create a change set for the entire stack hierarchy, IncludeNestedStacks\n must have been set to True.

" } }, "com.amazonaws.cloudformation#ExecuteChangeSetInput": { @@ -6111,32 +6111,32 @@ "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

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

The name or Amazon Resource Name (ARN) of the change set that you want use to update the\n specified stack.

", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's\n associated with the change set you want to execute.

" + "smithy.api#documentation": "

If you specified the name of a change set, specify the stack name or Amazon Resource Name\n (ARN) that's associated with the change set you want to execute.

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

A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name.\n You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

" + "smithy.api#documentation": "

A unique identifier for this ExecuteChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to execute a\n change set to update a stack with the same name. You might retry ExecuteChangeSet\n requests to ensure that CloudFormation successfully received them.

" } }, "DisableRollback": { "target": "com.amazonaws.cloudformation#DisableRollback", "traits": { - "smithy.api#documentation": "

Preserves the state of previously provisioned resources when an operation fails. This parameter can't be\n specified when the OnStackFailure parameter to the CreateChangeSet API operation was\n specified.

\n
    \n
  • \n

    \n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.

    \n
    • \n
  • \n

    \n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.

    \n
    • \n
\n

Default: True\n

" + "smithy.api#documentation": "

Preserves the state of previously provisioned resources when an operation fails. This\n parameter can't be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.

\n
    \n
  • \n

    \n True - if the stack creation fails, do nothing. This is equivalent to\n specifying DO_NOTHING for the OnStackFailure parameter to the\n CreateChangeSet API operation.

    \n
    • \n
  • \n

    \n False - if the stack creation fails, roll back the stack. This is\n equivalent to specifying ROLLBACK for the OnStackFailure\n parameter to the CreateChangeSet API operation.

    \n
    • \n
\n

Default: True\n

" } }, "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.

\n

Default: false\n

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.

\n

Default: false\n

" } } }, @@ -6216,13 +6216,13 @@ "Name": { "target": "com.amazonaws.cloudformation#ExportName", "traits": { - "smithy.api#documentation": "

The name of exported output value. Use this name and the Fn::ImportValue function to import the\n associated value into other stacks. The name is defined in the Export field in the associated stack's\n Outputs section.

" + "smithy.api#documentation": "

The name of exported output value. Use this name and the Fn::ImportValue\n function to import the associated value into other stacks. The name is defined in the\n Export field in the associated stack's Outputs section.

" } }, "Value": { "target": "com.amazonaws.cloudformation#ExportValue", "traits": { - "smithy.api#documentation": "

The value of the exported output, such as a resource physical ID. This value is defined in the\n Export field in the associated stack's Outputs section.

" + "smithy.api#documentation": "

The value of the exported output, such as a resource physical ID. This value is defined in\n the Export field in the associated stack's Outputs section.

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

Retrieves a generated template. If the template is in an InProgress or Pending status\n then the template returned will be the template when the template was last in a Complete status. If the\n template has not yet been in a Complete status then an empty template will be returned.

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

Retrieves a generated template. If the template is in an InProgress or\n Pending status then the template returned will be the template when the\n template was last in a Complete status. If the template has not yet been in a\n Complete status then an empty template will be returned.

", "smithy.api#examples": [ { "title": "To get a generated template in JSON format", @@ -6473,7 +6473,7 @@ "target": "com.amazonaws.cloudformation#GeneratedTemplateName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

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

The name or Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

", "smithy.api#required": {} } } @@ -6494,7 +6494,7 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

The template body of the generated template, in the language specified by the Language\n parameter.

" + "smithy.api#documentation": "

The template body of the generated template, in the language specified by the\n Language parameter.

" } } }, @@ -6511,7 +6511,7 @@ "target": "com.amazonaws.cloudformation#GetStackPolicyOutput" }, "traits": { - "smithy.api#documentation": "

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n returned.

" + "smithy.api#documentation": "

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null\n value is returned.

" } }, "com.amazonaws.cloudformation#GetStackPolicyInput": { @@ -6521,7 +6521,7 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique stack ID that's associated with the stack whose policy you want to get.

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

The name or unique stack ID that's associated with the stack whose policy you want to\n get.

", "smithy.api#required": {} } } @@ -6537,7 +6537,7 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)

" + "smithy.api#documentation": "

Structure containing the stack policy body. (For more information, see Prevent updates to stack resources in the\n CloudFormation User Guide.)

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

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

\n

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been\n deleted.

\n \n

If the template doesn't exist, a ValidationError is returned.

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

Returns the template body for a specified stack. You can get the template for running or\n deleted stacks.

\n

For deleted stacks, GetTemplate returns the template for up to 90 days after\n the stack has been deleted.

\n \n

If the template doesn't exist, a ValidationError is returned.

\n " } }, "com.amazonaws.cloudformation#GetTemplateInput": { @@ -6569,19 +6569,19 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

" + "smithy.api#documentation": "

The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If\n you specify a name, you must also specify the StackName.

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the\n associated template. If you specify a name, you must also specify the\n StackName.

" } }, "TemplateStage": { "target": "com.amazonaws.cloudformation#TemplateStage", "traits": { - "smithy.api#documentation": "

For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has processed all\n transforms, specify Processed.

\n

If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.

" + "smithy.api#documentation": "

For templates that include transforms, the stage of the template that CloudFormation returns.\n To get the user-submitted template, specify Original. To get the template after\n CloudFormation has processed all transforms, specify Processed.

\n

If the template doesn't include transforms, Original and\n Processed return the same template. By default, CloudFormation specifies\n Processed.

" } } }, @@ -6596,13 +6596,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

CloudFormation returns the same template that was used when the stack was created.

" + "smithy.api#documentation": "

Structure containing the template body.

\n

CloudFormation returns the same template that was used when the stack was created.

" } }, "StagesAvailable": { "target": "com.amazonaws.cloudformation#StageList", "traits": { - "smithy.api#documentation": "

The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.

" + "smithy.api#documentation": "

The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the\n Original template is always available. After CloudFormation finishes creating the\n change set, the Processed template becomes available.

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

Returns information about a new or existing template. The GetTemplateSummary action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.

\n

You can use the GetTemplateSummary action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.

\n

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError is returned.

" + "smithy.api#documentation": "

Returns information about a new or existing template. The GetTemplateSummary\n action is useful for viewing parameter information, such as default parameter values and\n parameter types, before you create or update a stack or stack set.

\n

You can use the GetTemplateSummary action when you submit a template, or you\n can get template information for a stack set, or a running or deleted stack.

\n

For deleted stacks, GetTemplateSummary returns the template information for\n up to 90 days after the stack has been deleted. If the template doesn't exist, a\n ValidationError is returned.

" } }, "com.amazonaws.cloudformation#GetTemplateSummaryInput": { @@ -6634,31 +6634,31 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with\n https://.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location\n for an Amazon S3 bucket must start with https://.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#documentation": "

The name or the stack ID that's associated with the stack, which aren't always\n interchangeable. For running stacks, you can specify either the stack's name or its unique\n stack ID. For deleted stack, you must specify the unique stack ID.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" } }, "StackSetName": { "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { - "smithy.api#documentation": "

The name or unique ID of the stack set from which the stack was created.

\n

Conditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.

" + "smithy.api#documentation": "

The name or unique ID of the stack set from which the stack was created.

\n

Conditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } }, "TemplateSummaryConfig": { @@ -6679,7 +6679,7 @@ "Parameters": { "target": "com.amazonaws.cloudformation#ParameterDeclarations", "traits": { - "smithy.api#documentation": "

A list of parameter declarations that describe various properties for each parameter.

" + "smithy.api#documentation": "

A list of parameter declarations that describe various properties for each\n parameter.

" } }, "Description": { @@ -6691,25 +6691,25 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

The capabilities found within the template. If your template contains IAM resources, you must specify the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return\n an InsufficientCapabilities error.

\n

For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.

" + "smithy.api#documentation": "

The capabilities found within the template. If your template contains IAM resources, you\n must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for\n this parameter when you use the CreateStack or UpdateStack\n actions with your template; otherwise, those actions return an\n InsufficientCapabilities error.

\n

For more information, see Acknowledging IAM resources in CloudFormation templates.

" } }, "CapabilitiesReason": { "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { - "smithy.api#documentation": "

The list of resources that generated the values in the Capabilities response element.

" + "smithy.api#documentation": "

The list of resources that generated the values in the Capabilities response\n element.

" } }, "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

" + "smithy.api#documentation": "

A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and\n Custom::MyCustomInstance.

" } }, "Version": { "target": "com.amazonaws.cloudformation#Version", "traits": { - "smithy.api#documentation": "

The Amazon Web Services template format version, which identifies the capabilities of the template.

" + "smithy.api#documentation": "

The Amazon Web Services template format version, which identifies the capabilities of the\n template.

" } }, "Metadata": { @@ -6727,7 +6727,7 @@ "ResourceIdentifierSummaries": { "target": "com.amazonaws.cloudformation#ResourceIdentifierSummaries", "traits": { - "smithy.api#documentation": "

A list of resource identifier summaries that describe the target resources of an import operation and the\n properties you can provide during the import to identify the target resources. For example, BucketName\n is a possible identifier property for an AWS::S3::Bucket resource.

" + "smithy.api#documentation": "

A list of resource identifier summaries that describe the target resources of an import\n operation and the properties you can provide during the import to identify the target\n resources. For example, BucketName is a possible identifier property for an\n AWS::S3::Bucket resource.

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

Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a\n new stack set in the same account as the source stack or in a different administrator account and Region, by\n specifying the stack ID of the stack you intend to import.

" + "smithy.api#documentation": "

Import existing stacks into a new stack sets. Use the stack import operation to import up\n to 10 stacks into a new stack set in the same account as the source stack or in a different\n administrator account and Region, by specifying the stack ID of the stack you intend to\n import.

" } }, "com.amazonaws.cloudformation#ImportStacksToStackSetInput": { @@ -7063,14 +7063,14 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the stack set. The name must be unique in the Region where you create your stack set.

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

The name of the stack set. The name must be unique in the Region where you create your\n stack set.

", "smithy.api#required": {} } }, "StackIds": { "target": "com.amazonaws.cloudformation#StackIdList", "traits": { - "smithy.api#documentation": "

The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a\n time.

\n

Specify either StackIds or StackIdsUrl.

" + "smithy.api#documentation": "

The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per\n stack set at a time.

\n

Specify either StackIds or StackIdsUrl.

" } }, "StackIdsUrl": { @@ -7082,13 +7082,13 @@ "OrganizationalUnitIds": { "target": "com.amazonaws.cloudformation#OrganizationalUnitIdList", "traits": { - "smithy.api#documentation": "

The list of OU ID's to which the stacks being imported has to be mapped as deployment target.

" + "smithy.api#documentation": "

The list of OU ID's to which the stacks being imported has to be mapped as deployment\n target.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.

" + "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

" } }, "OperationId": { @@ -7101,7 +7101,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    For service managed stack sets, specify DELEGATED_ADMIN.

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

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    For service managed stack sets, specify DELEGATED_ADMIN.

    \n
    • \n
" } } }, @@ -7293,7 +7293,7 @@ "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" }, "traits": { - "smithy.api#documentation": "

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are\n in the CREATE_IN_PROGRESS or CREATE_PENDING state.

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

Returns the ID and status of each active change set for a stack. For example, CloudFormation\n lists change sets that are in the CREATE_IN_PROGRESS or\n CREATE_PENDING state.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7308,14 +7308,14 @@ "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

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

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change\n sets.

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

A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.

" + "smithy.api#documentation": "

A string (provided by the ListChangeSets response output) that\n identifies the next page of change sets that you want to retrieve.

" } } }, @@ -7330,13 +7330,13 @@ "Summaries": { "target": "com.amazonaws.cloudformation#ChangeSetSummaries", "traits": { - "smithy.api#documentation": "

A list of ChangeSetSummary structures that provides the ID and status of each change set for the\n specified stack.

" + "smithy.api#documentation": "

A list of ChangeSetSummary structures that provides the ID and status of each\n change set for the specified stack.

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

If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n page, this value is null.

" + "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of change sets. If\n there is no additional page, this value is null.

" } } }, @@ -7354,7 +7354,7 @@ "target": "com.amazonaws.cloudformation#ListExportsOutput" }, "traits": { - "smithy.api#documentation": "

Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.

\n

For more information, see CloudFormation export stack output\n values.

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

Lists all exported output values in the account and Region in which you call this action.\n Use this action to see the exported output values that you can import into other stacks. To\n import values, use the \n Fn::ImportValue function.

\n

For more information, see Get exported outputs from a deployed CloudFormation stack.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7368,7 +7368,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.

" + "smithy.api#documentation": "

A string (provided by the ListExports response output) that identifies\n the next page of exported output values that you asked to retrieve.

" } } }, @@ -7388,7 +7388,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is\n no additional page, this value is null.

" + "smithy.api#documentation": "

If the output exceeds 100 exported output values, a string that identifies the next page\n of exports. If there is no additional page, this value is null.

" } } }, @@ -7426,7 +7426,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { - "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is\n 100.

" + "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListGeneratedTemplates API action\n will return at most 50 results in each response. The maximum value is 100.

" } } }, @@ -7446,7 +7446,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListGeneratedTemplates again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListGeneratedTemplates again\n and use that value for the NextToken parameter. If the request returns all\n results, NextToken is set to an empty string.

" } } }, @@ -7463,7 +7463,7 @@ "target": "com.amazonaws.cloudformation#ListImportsOutput" }, "traits": { - "smithy.api#documentation": "

Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

\n

For more information about importing an exported output value, see the Fn::ImportValue\n function.

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

Lists all stacks that are importing an exported output value. To modify or remove an\n exported output value, first use this action to see which stacks are using it. To see the\n exported output values in your account, see ListExports.

\n

For more information about importing an exported output value, see the Fn::ImportValue function.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7478,14 +7478,14 @@ "target": "com.amazonaws.cloudformation#ExportName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the exported output value. CloudFormation returns the stack names that are importing this value.

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

The name of the exported output value. CloudFormation returns the stack names that are\n importing this value.

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

A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.

" + "smithy.api#documentation": "

A string (provided by the ListImports response output) that identifies\n the next page of stacks that are importing the specified exported output value.

" } } }, @@ -7505,7 +7505,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

A string that identifies the next page of exports. If there is no additional page, this value is null.

" + "smithy.api#documentation": "

A string that identifies the next page of exports. If there is no additional page, this\n value is null.

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

Lists the related resources for a list of resources from a resource scan. The response indicates whether each\n returned resource is already managed by CloudFormation.

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

Lists the related resources for a list of resources from a resource scan. The response\n indicates whether each returned resource is already managed by CloudFormation.

", "smithy.api#examples": [ { "title": "To list resource scan related resources", @@ -7611,7 +7611,7 @@ "target": "com.amazonaws.cloudformation#ScannedResourceIdentifiers", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The list of resources for which you want to get the related resources. Up to 100 resources can be\n provided.

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

The list of resources for which you want to get the related resources. Up to 100 resources\n can be provided.

", "smithy.api#required": {} } }, @@ -7624,7 +7624,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#BoxedMaxResults", "traits": { - "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum\n value is 100.

" + "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListResourceScanRelatedResources API\n action will return up to 100 results in each response. The maximum value is 100.

" } } }, @@ -7638,13 +7638,13 @@ "RelatedResources": { "target": "com.amazonaws.cloudformation#RelatedResources", "traits": { - "smithy.api#documentation": "

List of up to MaxResults resources in the specified resource scan related to the specified\n resources.

" + "smithy.api#documentation": "

List of up to MaxResults resources in the specified resource scan related to\n the specified resources.

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScanRelatedResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call\n ListResourceScanRelatedResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken\n is set to an empty string.

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

Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type\n prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates\n whether each returned resource is already managed by CloudFormation.

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

Lists the resources from a resource scan. The results can be filtered by resource\n identifier, resource type prefix, tag key, and tag value. Only resources that match all\n specified filters are returned. The response indicates whether each returned resource is\n already managed by CloudFormation.

", "smithy.api#examples": [ { "title": "To list the resources in your resource scan", @@ -7748,13 +7748,13 @@ "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

If specified, the returned resources will have the specified resource identifier (or one of them in the case\n where the resource has multiple identifiers).

" + "smithy.api#documentation": "

If specified, the returned resources will have the specified resource identifier (or one\n of them in the case where the resource has multiple identifiers).

" } }, "ResourceTypePrefix": { "target": "com.amazonaws.cloudformation#ResourceTypePrefix", "traits": { - "smithy.api#documentation": "

If specified, the returned resources will be of any of the resource types with the specified prefix.

" + "smithy.api#documentation": "

If specified, the returned resources will be of any of the resource types with the\n specified prefix.

" } }, "TagKey": { @@ -7778,7 +7778,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", "traits": { - "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. By default the\n ListResourceScanResources API action will return at most 100 results in each response. The maximum value\n is 100.

" + "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. By default the ListResourceScanResources API action\n will return at most 100 results in each response. The maximum value is 100.

" } } }, @@ -7792,13 +7792,13 @@ "Resources": { "target": "com.amazonaws.cloudformation#ScannedResources", "traits": { - "smithy.api#documentation": "

List of up to MaxResults resources in the specified resource scan that match all of the specified\n filters.

" + "smithy.api#documentation": "

List of up to MaxResults resources in the specified resource scan that match\n all of the specified filters.

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScanResources again and use that value for the\n NextToken parameter. If the request returns all results, NextToken is set to an empty\n string.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListResourceScanResources\n again and use that value for the NextToken parameter. If the request returns all\n results, NextToken is set to an empty string.

" } } }, @@ -7815,7 +7815,7 @@ "target": "com.amazonaws.cloudformation#ListResourceScansOutput" }, "traits": { - "smithy.api#documentation": "

List the resource scans from newest to oldest. By default it will return up to 10 resource scans.

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

List the resource scans from newest to oldest. By default it will return up to 10 resource\n scans.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7836,7 +7836,7 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#ResourceScannerMaxResults", "traits": { - "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a NextToken value\n that you can use for the NextToken parameter to get the next set of results. The default value is 10.\n The maximum value is 100.

" + "smithy.api#documentation": "

If the number of available results exceeds this maximum, the response includes a\n NextToken value that you can use for the NextToken parameter to\n get the next set of results. The default value is 10. The maximum value is 100.

" } } }, @@ -7856,7 +7856,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListResourceScans again and use that value for the NextToken\n parameter. If the request returns all results, NextToken is set to an empty string.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListResourceScans again and\n use that value for the NextToken parameter. If the request returns all results,\n NextToken is set to an empty string.

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

Returns drift information for resources in a stack instance.

\n \n

\n ListStackInstanceResourceDrifts returns drift information for the most recent drift detection\n operation. If an operation is in progress, it may only return partial results.

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

Returns drift information for resources in a stack instance.

\n \n

\n ListStackInstanceResourceDrifts returns drift information for the most\n recent drift detection operation. If an operation is in progress, it may only return partial\n results.

\n " } }, "com.amazonaws.cloudformation#ListStackInstanceResourceDriftsInput": { @@ -7901,19 +7901,19 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

" } }, "StackInstanceResourceDriftStatuses": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", "traits": { - "smithy.api#documentation": "

The resource drift status of the stack instance.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected template values.

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected template configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation doesn't currently return this value.

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

The resource drift status of the stack instance.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected\n template values.

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation doesn't currently return this value.

    \n
    • \n
" } }, "StackInstanceAccount": { @@ -7943,7 +7943,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -7957,13 +7957,13 @@ "Summaries": { "target": "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummaries", "traits": { - "smithy.api#documentation": "

A list of StackInstanceResourceDriftsSummary structures that contain information about the\n specified stack instances.

" + "smithy.api#documentation": "

A list of StackInstanceResourceDriftsSummary structures that contain\n information about the specified stack instances.

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

If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

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

Returns summary information about stack instances that are associated with the specified stack set. You can\n filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that\n have a specific status.

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

Returns summary information about stack instances that are associated with the specified\n stack set. You can filter for stack instances that are associated with a specific\n Amazon Web Services account name or Region, or that have a specific status.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8008,13 +8008,13 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the previous request didn't return all the remaining results, the response's NextToken parameter\n value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign\n that token to the request object's NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

If the previous request didn't return all the remaining results, the response's\n NextToken parameter value is set to a token. To retrieve the next set of\n results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

" } }, "Filters": { @@ -8038,7 +8038,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -8052,13 +8052,13 @@ "Summaries": { "target": "com.amazonaws.cloudformation#StackInstanceSummaries", "traits": { - "smithy.api#documentation": "

A list of StackInstanceSummary structures that contain information about the specified stack\n instances.

" + "smithy.api#documentation": "

A list of StackInstanceSummary structures that contain information about the\n specified stack instances.

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackInstances again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListStackInstances again and\n assign that token to the request object's NextToken parameter. If the request\n returns all results, NextToken is set to null.

" } } }, @@ -8075,7 +8075,7 @@ "target": "com.amazonaws.cloudformation#ListStackResourcesOutput" }, "traits": { - "smithy.api#documentation": "

Returns descriptions of all resources of the specified stack.

\n

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been\n deleted.

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

Returns descriptions of all resources of the specified stack.

\n

For deleted stacks, ListStackResources returns resource information for up to 90 days\n after the stack has been deleted.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8090,14 +8090,14 @@ "target": "com.amazonaws.cloudformation#StackName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

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

The name or the unique stack ID that is associated with the stack, which aren't always\n interchangeable:

\n
    \n
  • \n

    Running stacks: You can specify either the stack's name or its unique stack ID.

    \n
    • \n
  • \n

    Deleted stacks: You must specify the unique stack ID.

    \n
    • \n
\n

Default: There is no default value.

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

A string that identifies the next page of stack resources that you want to retrieve.

" + "smithy.api#documentation": "

A string that identifies the next page of stack resources that you want to\n retrieve.

" } } }, @@ -8118,7 +8118,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page\n exists, this value is null.

" + "smithy.api#documentation": "

If the output exceeds 1 MB, a string that identifies the next page of stack resources. If\n no additional page exists, this value is null.

" } } }, @@ -8151,26 +8151,26 @@ "target": "com.amazonaws.cloudformation#StackSetNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to get automatic deployment targets for.

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

The name or unique ID of the stack set that you want to get automatic deployment targets\n for.

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

A string that identifies the next page of stack set deployment targets that you want to retrieve.

" + "smithy.api#documentation": "

A string that identifies the next page of stack set deployment targets that you want to\n retrieve.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for StackSets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for StackSets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -8190,7 +8190,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the\n request returns all results, NextToken is set to an empty string.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the\n NextToken parameter. If the request returns all results, NextToken\n is set to an empty string.

" } } }, @@ -8246,19 +8246,19 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the previous request didn't return all the remaining results, the response object's NextToken\n parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperationResults again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.

" + "smithy.api#documentation": "

If the previous request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of\n results, call ListStackSetOperationResults again and assign that token to the\n request object's NextToken parameter. If there are no remaining results, the\n previous response object's NextToken parameter is set to\n null.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } }, "Filters": { @@ -8278,13 +8278,13 @@ "Summaries": { "target": "com.amazonaws.cloudformation#StackSetOperationResultSummaries", "traits": { - "smithy.api#documentation": "

A list of StackSetOperationResultSummary structures that contain information about the specified\n operation results, for accounts and Amazon Web Services Regions that are included in the operation.

" + "smithy.api#documentation": "

A list of StackSetOperationResultSummary structures that contain information\n about the specified operation results, for accounts and Amazon Web Services Regions that are included in the\n operation.

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

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.

" + "smithy.api#documentation": "

If the request doesn't return all results, NextToken is set to a token. To\n retrieve the next set of results, call ListOperationResults again and assign that\n token to the request object's NextToken parameter. If there are no remaining\n results, NextToken is set to null.

" } } }, @@ -8322,26 +8322,26 @@ "target": "com.amazonaws.cloudformation#StackSetName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack set that you want to get operation summaries for.

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

The name or unique ID of the stack set that you want to get operation summaries\n for.

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

If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperations again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call ListStackSetOperations again and assign that token to the request\n object's NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -8355,13 +8355,13 @@ "Summaries": { "target": "com.amazonaws.cloudformation#StackSetOperationSummaries", "traits": { - "smithy.api#documentation": "

A list of StackSetOperationSummary structures that contain summary information about operations for\n the specified stack set.

" + "smithy.api#documentation": "

A list of StackSetOperationSummary structures that contain summary\n information about operations for the specified stack set.

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

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.

" + "smithy.api#documentation": "

If the request doesn't return all results, NextToken is set to a token. To\n retrieve the next set of results, call ListOperationResults again and assign that\n token to the request object's NextToken parameter. If there are no remaining\n results, NextToken is set to null.

" } } }, @@ -8378,7 +8378,7 @@ "target": "com.amazonaws.cloudformation#ListStackSetsOutput" }, "traits": { - "smithy.api#documentation": "

Returns summary information about stack sets that are associated with the user.

\n
    \n
  • \n

    [Self-managed permissions] If you set the CallAs parameter to SELF while signed in\n to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.

    \n
    • \n
  • \n

    [Service-managed permissions] If you set the CallAs parameter to SELF while signed\n in to the organization's management account, ListStackSets returns all stack sets in the\n management account.

    \n
    • \n
  • \n

    [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN\n while signed in to your member account, ListStackSets returns all stack sets with service-managed\n permissions in the management account.

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

Returns summary information about stack sets that are associated with the user.

\n
    \n
  • \n

    [Self-managed permissions] If you set the CallAs parameter to\n SELF while signed in to your Amazon Web Services account, ListStackSets\n returns all self-managed stack sets in your Amazon Web Services account.

    \n
    • \n
  • \n

    [Service-managed permissions] If you set the CallAs parameter to\n SELF while signed in to the organization's management account,\n ListStackSets returns all stack sets in the management account.

    \n
    • \n
  • \n

    [Service-managed permissions] If you set the CallAs parameter to\n DELEGATED_ADMIN while signed in to your member account,\n ListStackSets returns all stack sets with service-managed permissions in\n the management account.

    \n
    • \n
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8393,13 +8393,13 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "

If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSets again and assign that token to the request object's NextToken parameter. If\n there are no remaining results, the previous response object's NextToken parameter is set to\n null.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call ListStackSets again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

" } }, "Status": { @@ -8411,7 +8411,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the management account or as a delegated administrator in a member\n account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -8425,13 +8425,13 @@ "Summaries": { "target": "com.amazonaws.cloudformation#StackSetSummaries", "traits": { - "smithy.api#documentation": "

A list of StackSetSummary structures that contain information about the user's stack sets.

" + "smithy.api#documentation": "

A list of StackSetSummary structures that contain information about the\n user's stack sets.

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

If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.

" + "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call ListStackInstances again\n and assign that token to the request object's NextToken parameter. If the request\n returns all results, NextToken is set to null.

" } } }, @@ -8448,7 +8448,7 @@ "target": "com.amazonaws.cloudformation#ListStacksOutput" }, "traits": { - "smithy.api#documentation": "

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary\n information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter\n is specified, summary information for all stacks is returned (including existing stacks and stacks that have been\n deleted).

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

Returns the summary information for stacks whose status matches the specified\n StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days\n after the stack is deleted. If no StackStatusFilter is specified, summary information for all\n stacks is returned (including existing stacks and stacks that have been deleted).

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8468,7 +8468,7 @@ "StackStatusFilter": { "target": "com.amazonaws.cloudformation#StackStatusFilter", "traits": { - "smithy.api#documentation": "

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified\n status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

" + "smithy.api#documentation": "

Stack status to use as a filter. Specify one or more stack status codes to list only\n stacks with the specified status codes. For a complete list of stack status codes, see the\n StackStatus parameter of the Stack data type.

" } } }, @@ -8483,13 +8483,13 @@ "StackSummaries": { "target": "com.amazonaws.cloudformation#StackSummaries", "traits": { - "smithy.api#documentation": "

A list of StackSummary structures containing information about the specified stacks.

" + "smithy.api#documentation": "

A list of StackSummary structures containing information about the specified\n stacks.

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

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.

" + "smithy.api#documentation": "

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.

" } } }, @@ -8527,19 +8527,19 @@ "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The kind of extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The kind of extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "RegistrationStatusFilter": { @@ -8551,13 +8551,13 @@ "MaxResults": { "target": "com.amazonaws.cloudformation#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

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

If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

" } } }, @@ -8571,13 +8571,13 @@ "RegistrationTokenList": { "target": "com.amazonaws.cloudformation#RegistrationTokenList", "traits": { - "smithy.api#documentation": "

A list of extension registration tokens.

\n

Use DescribeTypeRegistration to return detailed information about a type registration\n request.

" + "smithy.api#documentation": "

A list of extension registration tokens.

\n

Use DescribeTypeRegistration to return detailed information about a type\n registration request.

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.

" } } }, @@ -8614,37 +8614,37 @@ "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The kind of the extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The kind of the extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The name of the extension for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "Arn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension for which you want version summary\n information.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

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

If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all of the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

" } }, "DeprecatedStatus": { "target": "com.amazonaws.cloudformation#DeprecatedStatus", "traits": { - "smithy.api#documentation": "

The deprecation status of the extension versions that you want to get summary information about.

\n

Valid values include:

\n
    \n
  • \n

    \n LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on\n its provisioning behavior and visibility scope.

    \n
    • \n
  • \n

    \n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

    \n
    • \n
\n

The default is LIVE.

" + "smithy.api#documentation": "

The deprecation status of the extension versions that you want to get summary information\n about.

\n

Valid values include:

\n
    \n
  • \n

    \n LIVE: The extension version is registered and can be used in CloudFormation\n operations, dependent on its provisioning behavior and visibility scope.

    \n
    • \n
  • \n

    \n DEPRECATED: The extension version has been deregistered and can no longer\n be used in CloudFormation operations.

    \n
    • \n
\n

The default is LIVE.

" } }, "PublisherId": { @@ -8664,13 +8664,13 @@ "TypeVersionSummaries": { "target": "com.amazonaws.cloudformation#TypeVersionSummaries", "traits": { - "smithy.api#documentation": "

A list of TypeVersionSummary structures that contain information about the specified extension's\n versions.

" + "smithy.api#documentation": "

A list of TypeVersionSummary structures that contain information about the\n specified extension's versions.

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

If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.

" + "smithy.api#documentation": "

If the request doesn't return all of the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call this action again and assign that token\n to the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.

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

Returns summary information about extension that have been registered with CloudFormation.

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

Returns summary information about extension that have been registered with\n CloudFormation.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -8708,19 +8708,19 @@ "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "

The scope at which the extensions are visible and usable in CloudFormation operations.

\n

Valid values include:

\n
    \n
  • \n

    \n PRIVATE: Extensions that are visible and usable within this account and Region. This\n includes:

    \n
      \n
    • \n

      Private extensions you have registered in this account and Region.

      \n
      • \n
    • \n

      Public extensions that you have activated in this account and Region.

      \n
      • \n
    \n
    • \n
  • \n

    \n PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.

    \n
    • \n
\n

The default is PRIVATE.

" + "smithy.api#documentation": "

The scope at which the extensions are visible and usable in CloudFormation operations.

\n

Valid values include:

\n
    \n
  • \n

    \n PRIVATE: Extensions that are visible and usable within this account and\n Region. This includes:

    \n
      \n
    • \n

      Private extensions you have registered in this account and Region.

      \n
      • \n
    • \n

      Public extensions that you have activated in this account and Region.

      \n
      • \n
    \n
    • \n
  • \n

    \n PUBLIC: Extensions that are publicly visible and available to be\n activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to\n third-party publishers.

    \n
    • \n
\n

The default is PRIVATE.

" } }, "ProvisioningType": { "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { - "smithy.api#documentation": "

For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type\n during registration, based on the types of handlers in the schema handler package submitted.

\n

Valid values include:

\n
    \n
  • \n

    \n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.

    \n
    • \n
  • \n

    \n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.

    \n
    • \n
  • \n

    \n NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and\n therefore can't actually be provisioned.

    \n
    • \n
\n

The default is FULLY_MUTABLE.

" + "smithy.api#documentation": "

For resource types, the provisioning behavior of the resource type. CloudFormation determines\n the provisioning type during registration, based on the types of handlers in the schema\n handler package submitted.

\n

Valid values include:

\n
    \n
  • \n

    \n FULLY_MUTABLE: The resource type includes an update handler to process\n updates to the type during stack update operations.

    \n
    • \n
  • \n

    \n IMMUTABLE: The resource type doesn't include an update handler, so the\n type can't be updated and must instead be replaced during stack update operations.

    \n
    • \n
  • \n

    \n NON_PROVISIONABLE: The resource type doesn't include create, read, and\n delete handlers, and therefore can't actually be provisioned.

    \n
    • \n
\n

The default is FULLY_MUTABLE.

" } }, "DeprecatedStatus": { "target": "com.amazonaws.cloudformation#DeprecatedStatus", "traits": { - "smithy.api#documentation": "

The deprecation status of the extension that you want to get summary information about.

\n

Valid values include:

\n
    \n
  • \n

    \n LIVE: The extension is registered for use in CloudFormation operations.

    \n
    • \n
  • \n

    \n DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.

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

The deprecation status of the extension that you want to get summary information\n about.

\n

Valid values include:

\n
    \n
  • \n

    \n LIVE: The extension is registered for use in CloudFormation\n operations.

    \n
    • \n
  • \n

    \n DEPRECATED: The extension has been deregistered and can no longer be used\n in CloudFormation operations.

    \n
    • \n
" } }, "Type": { @@ -8732,19 +8732,19 @@ "Filters": { "target": "com.amazonaws.cloudformation#TypeFilters", "traits": { - "smithy.api#documentation": "

Filter criteria to use in determining which extensions to return.

\n

Filters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.

" + "smithy.api#documentation": "

Filter criteria to use in determining which extensions to return.

\n

Filters must be compatible with Visibility to return valid results. For\n example, specifying AWS_TYPES for Category and PRIVATE\n for Visibility returns an empty list of types, but specifying PUBLIC\n for Visibility returns the desired list.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" + "smithy.api#documentation": "

The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.

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

If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action again\n and assign that token to the request object's NextToken parameter. If there are no remaining results,\n the previous response object's NextToken parameter is set to null.

" + "smithy.api#documentation": "

If the previous paginated request didn't return all the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

" } } }, @@ -8758,13 +8758,13 @@ "TypeSummaries": { "target": "com.amazonaws.cloudformation#TypeSummaries", "traits": { - "smithy.api#documentation": "

A list of TypeSummary structures that contain information about the specified extensions.

" + "smithy.api#documentation": "

A list of TypeSummary structures that contain information about the specified\n extensions.

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

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.

" + "smithy.api#documentation": "

If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.

" } } }, @@ -8789,7 +8789,7 @@ "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries to CloudWatch Logs.

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

The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log\n entries to CloudWatch Logs.

", "smithy.api#required": {} } }, @@ -8888,18 +8888,18 @@ "TypeHierarchy": { "target": "com.amazonaws.cloudformation#TypeHierarchy", "traits": { - "smithy.api#documentation": "

A concatenated list of the module type or types containing the resource. Module types are listed starting with\n the inner-most nested module, and separated by /.

\n

In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.

\n

\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n

" + "smithy.api#documentation": "

A concatenated list of the module type or types containing the resource. Module types are\n listed starting with the inner-most nested module, and separated by /.

\n

In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.

\n

\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n

" } }, "LogicalIdHierarchy": { "target": "com.amazonaws.cloudformation#LogicalIdHierarchy", "traits": { - "smithy.api#documentation": "

A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed\n starting with the inner-most nested module, and separated by /.

\n

In the following example, the resource was created from a module, moduleA, that's nested inside a\n parent module, moduleB.

\n

\n moduleA/moduleB\n

\n

For more information, see Referencing resources in a module\n in the CloudFormation User Guide.

" + "smithy.api#documentation": "

A concatenated list of the logical IDs of the module or modules containing the resource.\n Modules are listed starting with the inner-most nested module, and separated by\n /.

\n

In the following example, the resource was created from a module, moduleA,\n that's nested inside a parent module, moduleB.

\n

\n moduleA/moduleB\n

\n

For more information, see Reference module resources in\n CloudFormation templates in the CloudFormation User Guide.

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

Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.

\n

For more information about modules, see Using modules to encapsulate and reuse resource\n configurations in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.

\n

For more information about modules, see Create reusable resource configurations\n that can be included across templates with CloudFormation modules in the\n CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { @@ -9253,7 +9253,7 @@ "ParameterKey": { "target": "com.amazonaws.cloudformation#ParameterKey", "traits": { - "smithy.api#documentation": "

The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

" + "smithy.api#documentation": "

The key associated with the parameter. If you don't specify a key and value for a particular\n parameter, CloudFormation uses the default value that's specified in your template.

" } }, "ParameterValue": { @@ -9265,13 +9265,13 @@ "UsePreviousValue": { "target": "com.amazonaws.cloudformation#UsePreviousValue", "traits": { - "smithy.api#documentation": "

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If\n you specify true, do not specify a parameter value.

" + "smithy.api#documentation": "

During a stack update, use the existing parameter value that the stack is using for a given\n parameter key. If you specify true, do not specify a parameter value.

" } }, "ResolvedValue": { "target": "com.amazonaws.cloudformation#ParameterValue", "traits": { - "smithy.api#documentation": "

Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.

" + "smithy.api#documentation": "

Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only\n for Systems Manager parameter types in the template. For more information, see Use\n CloudFormation-supplied parameter types in the CloudFormation User Guide.

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

A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be defined in\n the stack template, CloudFormation returns only the AllowedValues property.

" + "smithy.api#documentation": "

A set of criteria that CloudFormation uses to validate parameter values. Although other\n constraints might be defined in the stack template, CloudFormation returns only the\n AllowedValues property.

" } }, "com.amazonaws.cloudformation#ParameterDeclaration": { @@ -9317,7 +9317,7 @@ "NoEcho": { "target": "com.amazonaws.cloudformation#NoEcho", "traits": { - "smithy.api#documentation": "

Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.

" + "smithy.api#documentation": "

Flag that indicates whether the parameter value is shown as plain text in logs and in the\n Amazon Web Services Management Console.

" } }, "Description": { @@ -9414,7 +9414,7 @@ } }, "traits": { - "smithy.api#documentation": "

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a resource that contains the targeted resource.

" + "smithy.api#documentation": "

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough to\n uniquely identify that resource. Each context key-value pair specifies a resource that contains\n the targeted resource.

" } }, "com.amazonaws.cloudformation#PolicyAction": { @@ -9489,7 +9489,7 @@ "target": "com.amazonaws.cloudformation#PropertyValue", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The expected property value of the resource property, as defined in the stack template and any values specified\n as template parameters.

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

The expected property value of the resource property, as defined in the stack template and\n any values specified as template parameters.

", "smithy.api#required": {} } }, @@ -9505,13 +9505,13 @@ "target": "com.amazonaws.cloudformation#DifferenceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of property difference.

\n
    \n
  • \n

    \n ADD: A value has been added to a resource property that's an array or list data type.

    \n
    • \n
  • \n

    \n REMOVE: The property has been removed from the current resource configuration.

    \n
    • \n
  • \n

    \n NOT_EQUAL: The current property value differs from its expected value (as defined in the stack\n template and any values specified as template parameters).

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

The type of property difference.

\n
    \n
  • \n

    \n ADD: A value has been added to a resource property that's an array or list\n data type.

    \n
    • \n
  • \n

    \n REMOVE: The property has been removed from the current resource\n configuration.

    \n
    • \n
  • \n

    \n NOT_EQUAL: The current property value differs from its expected value (as\n defined in the stack template and any values specified as template parameters).

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

Information about a resource property whose actual value differs from its expected value, as defined in the\n stack template and any values specified as template parameters. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.

" + "smithy.api#documentation": "

Information about a resource property whose actual value differs from its expected value, as\n defined in the stack template and any values specified as template parameters. These will be\n present only for resources whose StackResourceDriftStatus is MODIFIED.\n For more information, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.

" } }, "com.amazonaws.cloudformation#PropertyDifferences": { @@ -9578,7 +9578,7 @@ } ], "traits": { - "smithy.api#documentation": "

Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public\n extensions are available for use by all CloudFormation users. For more information about publishing extensions, see\n Publishing extensions to\n make them available for public use in the CloudFormation CLI User Guide.

\n

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

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

Publishes the specified extension to the CloudFormation registry as a public extension in this\n Region. Public extensions are available for use by all CloudFormation users. For more information\n about publishing extensions, see Publishing extensions to\n make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide.

\n

To publish an extension, you must be registered as a publisher with CloudFormation. For more\n information, see RegisterPublisher.

", "smithy.api#idempotent": {} } }, @@ -9588,25 +9588,25 @@ "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "

The type of the extension.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The type of the extension.

\n

Conditional: You must specify Arn, or TypeName and\n Type.

" } }, "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify Arn, or TypeName and\n Type.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify Arn, or TypeName and\n Type.

" } }, "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "

The version number to assign to this version of the extension.

\n

Use the following format, and adhere to semantic versioning when assigning a version number to your\n extension:

\n

\n MAJOR.MINOR.PATCH\n

\n

For more information, see Semantic Versioning 2.0.0.

\n

If you don't specify a version number, CloudFormation increments the version number by one minor version\n release.

\n

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.

" + "smithy.api#documentation": "

The version number to assign to this version of the extension.

\n

Use the following format, and adhere to semantic versioning when assigning a version\n number to your extension:

\n

\n MAJOR.MINOR.PATCH\n

\n

For more information, see Semantic Versioning\n 2.0.0.

\n

If you don't specify a version number, CloudFormation increments the version number by one\n minor version release.

\n

You cannot specify a version number the first time you publish a type. CloudFormation\n automatically sets the first version number to be 1.0.0.

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

Reports progress of a resource handler to CloudFormation.

\n

Reserved for use by the CloudFormation CLI. Don't use this API\n in your code.

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

Reports progress of a resource handler to CloudFormation.

\n

Reserved for use by the CloudFormation\n CLI. Don't use this API in your code.

", "smithy.api#idempotent": {} } }, @@ -9706,7 +9706,7 @@ "target": "com.amazonaws.cloudformation#ClientToken", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

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

Reserved for use by the CloudFormation\n CLI.

", "smithy.api#required": {} } }, @@ -9714,38 +9714,38 @@ "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

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

Reserved for use by the CloudFormation\n CLI.

", "smithy.api#required": {} } }, "CurrentOperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { - "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" + "smithy.api#documentation": "

Reserved for use by the CloudFormation\n CLI.

" } }, "StatusMessage": { "target": "com.amazonaws.cloudformation#StatusMessage", "traits": { - "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" + "smithy.api#documentation": "

Reserved for use by the CloudFormation\n CLI.

" } }, "ErrorCode": { "target": "com.amazonaws.cloudformation#HandlerErrorCode", "traits": { - "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" + "smithy.api#documentation": "

Reserved for use by the CloudFormation\n CLI.

" } }, "ResourceModel": { "target": "com.amazonaws.cloudformation#ResourceModel", "traits": { - "smithy.api#documentation": "

Reserved for use by the CloudFormation CLI.

" + "smithy.api#documentation": "

Reserved for use by the CloudFormation\n CLI.

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

Reserved for use by the CloudFormation CLI.

" + "smithy.api#documentation": "

Reserved for use by the CloudFormation\n CLI.

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

Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are\n available for use by all CloudFormation users. This publisher ID applies to your account in all Amazon Web Services Regions.

\n

For information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User\n Guide.

\n

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

Registers your account as a publisher of public extensions in the CloudFormation registry.\n Public extensions are available for use by all CloudFormation users. This publisher ID applies to\n your account in all Amazon Web Services Regions.

\n

For information about requirements for registering as a public extension publisher, see\n Prerequisite: Registering your account to publish CloudFormation extensions in the\n CloudFormation Command Line Interface (CLI) User Guide.

\n

", "smithy.api#idempotent": {} } }, @@ -9816,13 +9816,13 @@ "AcceptTermsAndConditions": { "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", "traits": { - "smithy.api#documentation": "

Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the terms and\n conditions in order to register to publish public extensions to the CloudFormation registry.

\n

The default is false.

" + "smithy.api#documentation": "

Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must\n accept the terms and conditions in order to register to publish public extensions to the\n CloudFormation registry.

\n

The default is false.

" } }, "ConnectionArn": { "target": "com.amazonaws.cloudformation#ConnectionArn", "traits": { - "smithy.api#documentation": "

If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.

\n

For more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User Guide.

" + "smithy.api#documentation": "

If you are using a Bitbucket or GitHub account for identity verification, the Amazon\n Resource Name (ARN) for your connection to that account.

\n

For more information, see Prerequisite: Registering your account to publish CloudFormation extensions in the\n CloudFormation Command Line Interface (CLI) User Guide.

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

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in\n CloudFormation templates in your Amazon Web Services account, and includes:

\n
    \n
  • \n

    Validating the extension schema.

    \n
    • \n
  • \n

    Determining which handlers, if any, have been specified for the extension.

    \n
    • \n
  • \n

    Making the extension available for use in your account.

    \n
    • \n
\n

For more information about how to develop extensions and ready them for registration, see Creating Resource\n Providers in the CloudFormation CLI User Guide.

\n

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use DeregisterType to deregister specific extension versions if necessary.

\n

Once you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.

\n

Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.

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

Registers an extension with the CloudFormation service. Registering an extension makes it\n available for use in CloudFormation templates in your Amazon Web Services account, and includes:

\n
    \n
  • \n

    Validating the extension schema.

    \n
    • \n
  • \n

    Determining which handlers, if any, have been specified for the extension.

    \n
    • \n
  • \n

    Making the extension available for use in your account.

    \n
    • \n
\n

For more information about how to develop extensions and ready them for registration, see\n Creating resource types using the CloudFormation CLI in the\n CloudFormation Command Line Interface (CLI) User Guide.

\n

You can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per Region. Use DeregisterType\n to deregister specific extension versions if necessary.

\n

Once you have initiated a registration request using RegisterType, you\n can use DescribeTypeRegistration to monitor the progress of the registration\n request.

\n

Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.

", "smithy.api#idempotent": {} } }, @@ -9875,7 +9875,7 @@ "target": "com.amazonaws.cloudformation#TypeName", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the extension being registered.

\n

We suggest that extension names adhere to the following patterns:

\n
    \n
  • \n

    For resource types,\n company_or_organization::service::type.

    \n
    • \n
  • \n

    For modules,\n company_or_organization::service::type::MODULE.

    \n
    • \n
  • \n

    For hooks,\n MyCompany::Testing::MyTestHook.

    \n
    • \n
\n \n

The following organization namespaces are reserved and can't be used in your extension names:

\n
    \n
  • \n

    \n Alexa\n

    \n
    • \n
  • \n

    \n AMZN\n

    \n
    • \n
  • \n

    \n Amazon\n

    \n
    • \n
  • \n

    \n AWS\n

    \n
    • \n
  • \n

    \n Custom\n

    \n
    • \n
  • \n

    \n Dev\n

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

The name of the extension being registered.

\n

We suggest that extension names adhere to the following patterns:

\n
    \n
  • \n

    For resource types, company_or_organization::service::type.

    \n
    • \n
  • \n

    For modules, company_or_organization::service::type::MODULE.

    \n
    • \n
  • \n

    For hooks, MyCompany::Testing::MyTestHook.

    \n
    • \n
\n \n

The following organization namespaces are reserved and can't be used in your extension\n names:

\n
    \n
  • \n

    \n Alexa\n

    \n
    • \n
  • \n

    \n AMZN\n

    \n
    • \n
  • \n

    \n Amazon\n

    \n
    • \n
  • \n

    \n AWS\n

    \n
    • \n
  • \n

    \n Custom\n

    \n
    • \n
  • \n

    \n Dev\n

    \n
    • \n
\n ", "smithy.api#required": {} } }, @@ -9883,7 +9883,7 @@ "target": "com.amazonaws.cloudformation#S3Url", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A URL to the S3 bucket containing the extension project package that contains the necessary files for the\n extension you want to register.

\n

For information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.

\n \n

The user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User Guide.

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

A URL to the S3 bucket containing the extension project package that contains the\n necessary files for the extension you want to register.

\n

For information about generating a schema handler package for the extension you want to\n register, see submit in\n the CloudFormation Command Line Interface (CLI) User Guide.

\n \n

The user registering the extension must be able to access the package in the S3 bucket.\n That's, the user needs to have GetObject permissions for the schema\n handler package. For more information, see Actions, Resources, and Condition Keys for\n Amazon S3 in the Identity and Access Management User Guide.

\n ", "smithy.api#required": {} } }, @@ -9896,13 +9896,13 @@ "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

\n

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the\n CloudFormation service principal (resources.cloudformation.amazonaws.com). For more information about adding\n trust relationships, see Modifying a\n role trust policy in the Identity and Access Management User Guide.

\n

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an \n IAM execution role\n that includes\n the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account.\n When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary\n session token, which it then passes to the resource type handler, thereby supplying your resource type with the\n appropriate credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking\n the extension.

\n

For CloudFormation to assume the specified execution role, the role must contain a trust\n relationship with the CloudFormation service principal\n (resources.cloudformation.amazonaws.com). For more information about adding\n trust relationships, see Modifying a role trust policy in the Identity and Access Management User\n Guide.

\n

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an\n \n IAM\n execution role\n that includes the necessary permissions to call those\n Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke\n the resource type handler, CloudFormation assumes this execution role to create a temporary\n session token, which it then passes to the resource type handler, thereby supplying your\n resource type with the appropriate credentials.

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

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same registration request,\n even if the request is submitted multiple times.

" + "smithy.api#documentation": "

A unique identifier that acts as an idempotency key for this registration request.\n Specifying a client request token prevents CloudFormation from generating more than one version of\n an extension from the same registration request, even if the request is submitted multiple\n times.

" } } }, @@ -9916,7 +9916,7 @@ "RegistrationToken": { "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { - "smithy.api#documentation": "

The identifier for this registration request.

\n

Use this registration token when calling DescribeTypeRegistration, which returns information\n about the status and IDs of the extension registration.

" + "smithy.api#documentation": "

The identifier for this registration request.

\n

Use this registration token when calling DescribeTypeRegistration, which\n returns information about the status and IDs of the extension registration.

" } } }, @@ -10031,13 +10031,13 @@ "TypeNameAlias": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

An alias assigned to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You must use the\n alias to refer to the extension in your templates, API calls, and CloudFormation console.

" + "smithy.api#documentation": "

An alias assigned to the public extension, in this account and Region. If you specify an\n alias for the extension, CloudFormation treats the alias as the extension type name within this\n account and Region. You must use the alias to refer to the extension in your templates, API\n calls, and CloudFormation console.

" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The type name of the public extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The type name of the public extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use\n aliases to refer to extensions in the CloudFormation User Guide.

" } }, "PublisherId": { @@ -10054,7 +10054,7 @@ } }, "traits": { - "smithy.api#documentation": "

For extensions that are modules, a public third-party extension that must be activated in your account in order\n for the module itself to be activated.

\n

For more information, see Activating public modules for use in your\n account in the CloudFormation User Guide.

" + "smithy.api#documentation": "

For extensions that are modules, a public third-party extension that must be activated in\n your account in order for the module itself to be activated.

\n

For more information, see Requirements for activating third-party public modules in the\n CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#RequiredActivatedTypes": { @@ -10142,13 +10142,13 @@ "PolicyAction": { "target": "com.amazonaws.cloudformation#PolicyAction", "traits": { - "smithy.api#documentation": "

The action that will be taken on the physical resource when the change set is executed.

\n
    \n
  • \n

    \n Delete The resource will be deleted.

    \n
    • \n
  • \n

    \n Retain The resource will be retained.

    \n
    • \n
  • \n

    \n Snapshot The resource will have a snapshot taken.

    \n
    • \n
  • \n

    \n ReplaceAndDelete The resource will be replaced and then deleted.

    \n
    • \n
  • \n

    \n ReplaceAndRetain The resource will be replaced and then retained.

    \n
    • \n
  • \n

    \n ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

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

The action that will be taken on the physical resource when the change set is\n executed.

\n
    \n
  • \n

    \n Delete The resource will be deleted.

    \n
    • \n
  • \n

    \n Retain The resource will be retained.

    \n
    • \n
  • \n

    \n Snapshot The resource will have a snapshot taken.

    \n
    • \n
  • \n

    \n ReplaceAndDelete The resource will be replaced and then deleted.

    \n
    • \n
  • \n

    \n ReplaceAndRetain The resource will be replaced and then retained.

    \n
    • \n
  • \n

    \n ReplaceAndSnapshot The resource will be replaced and then have a snapshot\n taken.

    \n
    • \n
" } }, "Action": { "target": "com.amazonaws.cloudformation#ChangeAction", "traits": { - "smithy.api#documentation": "

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify\n (changes a resource), Remove (deletes a resource), Import (imports a resource), or\n Dynamic (exact action for the resource can't be determined).

" + "smithy.api#documentation": "

The action that CloudFormation takes on the resource, such as Add (adds a new\n resource), Modify (changes a resource), Remove (deletes a resource),\n Import (imports a resource), or Dynamic (exact action for the resource\n can't be determined).

" } }, "LogicalResourceId": { @@ -10160,7 +10160,7 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they\n haven't been created.

" + "smithy.api#documentation": "

The resource's physical ID (resource name). Resources that you are adding don't have\n physical IDs because they haven't been created.

" } }, "ResourceType": { @@ -10172,19 +10172,19 @@ "Replacement": { "target": "com.amazonaws.cloudformation#Replacement", "traits": { - "smithy.api#documentation": "

For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and\n deleting the old one. This value depends on the value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the RequiresRecreation field is\n Always and the Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is Conditionally.

\n

If you have multiple changes with different RequiresRecreation values, the Replacement\n value depends on the change with the most impact. A RequiresRecreation value of Always has\n the most impact, followed by Conditionally, and then Never.

" + "smithy.api#documentation": "

For the Modify action, indicates whether CloudFormation will replace the resource\n by creating a new one and deleting the old one. This value depends on the value of the\n RequiresRecreation property in the ResourceTargetDefinition structure.\n For example, if the RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is\n Conditional.

\n

If you have multiple changes with different RequiresRecreation values, the\n Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact, followed by\n Conditional, and then Never.

" } }, "Scope": { "target": "com.amazonaws.cloudformation#Scope", "traits": { - "smithy.api#documentation": "

For the Modify action, indicates which resource attribute is triggering this update, such as a\n change in the resource attribute's Metadata, Properties, or Tags.

" + "smithy.api#documentation": "

For the Modify action, indicates which resource attribute is triggering this\n update, such as a change in the resource attribute's Metadata,\n Properties, or Tags.

" } }, "Details": { "target": "com.amazonaws.cloudformation#ResourceChangeDetails", "traits": { - "smithy.api#documentation": "

For the Modify action, a list of ResourceChangeDetail structures that describes the\n changes that CloudFormation will make to the resource.

" + "smithy.api#documentation": "

For the Modify action, a list of ResourceChangeDetail structures\n that describes the changes that CloudFormation will make to the resource.

" } }, "ChangeSetId": { @@ -10196,24 +10196,24 @@ "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { - "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.

" + "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.

" } }, "BeforeContext": { "target": "com.amazonaws.cloudformation#BeforeContext", "traits": { - "smithy.api#documentation": "

An encoded JSON string containing the context of the resource before the change is executed.

" + "smithy.api#documentation": "

An encoded JSON string containing the context of the resource before the change is\n executed.

" } }, "AfterContext": { "target": "com.amazonaws.cloudformation#AfterContext", "traits": { - "smithy.api#documentation": "

An encoded JSON string containing the context of the resource after the change is executed.

" + "smithy.api#documentation": "

An encoded JSON string containing the context of the resource after the change is\n executed.

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

The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if\n you execute this change set.

" + "smithy.api#documentation": "

The ResourceChange structure describes the resource and the action that\n CloudFormation will perform on it if you execute this change set.

" } }, "com.amazonaws.cloudformation#ResourceChangeDetail": { @@ -10222,30 +10222,30 @@ "Target": { "target": "com.amazonaws.cloudformation#ResourceTargetDefinition", "traits": { - "smithy.api#documentation": "

A ResourceTargetDefinition structure that describes the field that CloudFormation will change and whether\n the resource will be recreated.

" + "smithy.api#documentation": "

A ResourceTargetDefinition structure that describes the field that CloudFormation\n will change and whether the resource will be recreated.

" } }, "Evaluation": { "target": "com.amazonaws.cloudformation#EvaluationType", "traits": { - "smithy.api#documentation": "

Indicates whether CloudFormation can determine the target value, and whether the target value will change before you\n execute a change set.

\n

For Static evaluations, CloudFormation can determine that the target value will change, and its value. For\n example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows\n that this property value will change, and its value, so this is a Static evaluation.

\n

For Dynamic evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.

" + "smithy.api#documentation": "

Indicates whether CloudFormation can determine the target value, and whether the target value\n will change before you execute a change set.

\n

For Static evaluations, CloudFormation can determine that the target value will\n change, and its value. For example, if you directly modify the InstanceType property\n of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this\n is a Static evaluation.

\n

For Dynamic evaluations, can't determine the target value because it depends on\n the result of an intrinsic function, such as a Ref or Fn::GetAtt\n intrinsic function, when the stack is updated. For example, if your template includes a reference\n to a resource that's conditionally recreated, the value of the reference (the physical ID of the\n resource) might change, depending on if the resource is recreated. If the resource is recreated,\n it will have a new physical ID, so all references to that resource will also be updated.

" } }, "ChangeSource": { "target": "com.amazonaws.cloudformation#ChangeSource", "traits": { - "smithy.api#documentation": "

The group to which the CausingEntity value belongs. There are five entity groups:

\n
    \n
  • \n

    \n ResourceReference entities are Ref intrinsic functions that refer to resources in\n the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.

    \n
    • \n
  • \n

    \n ParameterReference entities are Ref intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }.

    \n
    • \n
  • \n

    \n ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource\n attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.

    \n
    • \n
  • \n

    \n DirectModification entities are changes that are made directly to the template.

    \n
    • \n
  • \n

    \n Automatic entities are AWS::CloudFormation::Stack resource types, which are also\n known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation sets the ChangeSource to Automatic because the nested stack's template might\n have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the parent\n stack.

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

The group to which the CausingEntity value belongs. There are five entity\n groups:

\n
    \n
  • \n

    \n ResourceReference entities are Ref intrinsic functions that refer to\n resources in the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.

    \n
    • \n
  • \n

    \n ParameterReference entities are Ref intrinsic functions that get\n template parameter values, such as { \"Ref\" : \"MyPasswordParameter\" }.

    \n
    • \n
  • \n

    \n ResourceAttribute entities are Fn::GetAtt intrinsic functions that\n get resource attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\",\n \"PublicDnsName\" ] }.

    \n
    • \n
  • \n

    \n DirectModification entities are changes that are made directly to the\n template.

    \n
    • \n
  • \n

    \n Automatic entities are AWS::CloudFormation::Stack resource types,\n which are also known as nested stacks. If you made no changes to the\n AWS::CloudFormation::Stack resource, CloudFormation sets the\n ChangeSource to Automatic because the nested stack's template might\n have changed. Changes to a nested stack's template aren't visible to CloudFormation until you run\n an update on the parent stack.

    \n
    • \n
" } }, "CausingEntity": { "target": "com.amazonaws.cloudformation#CausingEntity", "traits": { - "smithy.api#documentation": "

The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).

\n

If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.

" + "smithy.api#documentation": "

The identity of the entity that triggered this change. This entity is a member of the group\n that's specified by the ChangeSource field. For example, if you modified the value\n of the KeyPairName parameter, the CausingEntity is the name of the\n parameter (KeyPairName).

\n

If the ChangeSource value is DirectModification, no value is given\n for CausingEntity.

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

For a resource with Modify as the action, the ResourceChange structure describes the\n changes CloudFormation will make to that resource.

" + "smithy.api#documentation": "

For a resource with Modify as the action, the ResourceChange\n structure describes the changes CloudFormation will make to that resource.

" } }, "com.amazonaws.cloudformation#ResourceChangeDetails": { @@ -10261,7 +10261,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types in the CloudFormation User Guide\n

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

The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection in the\n CloudFormation User Guide\n

", "smithy.api#required": {} } }, @@ -10275,13 +10275,13 @@ "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.

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

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

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

A resource included in a generated template. This data type is used with the\n CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.

" + "smithy.api#documentation": "

A resource included in a generated template. This data type is used with the\n CreateGeneratedTemplate and UpdateGeneratedTemplate API\n actions.

" } }, "com.amazonaws.cloudformation#ResourceDefinitions": { @@ -10302,7 +10302,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide\n

" + "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide\n

" } }, "LogicalResourceId": { @@ -10314,13 +10314,13 @@ "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", "traits": { - "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name\n of one of the primary identifiers for the resource. (Primary identifiers are specified in the\n primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For\n example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the\n key-value pair could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.

" + "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies the resource in the generated template.\n The key is the name of one of the primary identifiers for the resource. (Primary identifiers are\n specified in the primaryIdentifier list in the resource schema.) The value is the\n value of that primary identifier. For example, for a AWS::DynamoDB::Table resource,\n the primary identifiers is TableName so the key-value pair could be\n \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

" } }, "ResourceStatus": { "target": "com.amazonaws.cloudformation#GeneratedTemplateResourceStatus", "traits": { - "smithy.api#documentation": "

Status of the processing of a resource in a generated template.

\n
\n
InProgress
\n
\n

The resource processing is still in progress.

\n
\n
Complete
\n
\n

The resource processing is complete.

\n
\n
Pending
\n
\n

The resource processing is pending.

\n
\n
Failed
\n
\n

The resource processing has failed.

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

Status of the processing of a resource in a generated template.

\n
\n
\n \n InProgress\n \n
\n
\n

The resource processing is still in progress.

\n
\n
\n \n Complete\n \n
\n
\n

The resource processing is complete.

\n
\n
\n \n Pending\n \n
\n
\n

The resource processing is pending.

\n
\n
\n \n Failed\n \n
\n
\n

The resource processing has failed.

\n
\n
" } }, "ResourceStatusReason": { @@ -10400,24 +10400,24 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

The template resource type of the target resources, such as AWS::S3::Bucket.

" + "smithy.api#documentation": "

The template resource type of the target resources, such as\n AWS::S3::Bucket.

" } }, "LogicalResourceIds": { "target": "com.amazonaws.cloudformation#LogicalResourceIds", "traits": { - "smithy.api#documentation": "

The logical IDs of the target resources of the specified ResourceType, as defined in the import\n template.

" + "smithy.api#documentation": "

The logical IDs of the target resources of the specified ResourceType, as\n defined in the import template.

" } }, "ResourceIdentifiers": { "target": "com.amazonaws.cloudformation#ResourceIdentifiers", "traits": { - "smithy.api#documentation": "

The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.

" + "smithy.api#documentation": "

The resource properties you can provide during the import to identify your target\n resources. For example, BucketName is a possible identifier property for\n AWS::S3::Bucket resources.

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

Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of\n that type.

" + "smithy.api#documentation": "

Describes the target resources of a specific type in your import template (for example,\n all AWS::S3::Bucket resources) and the properties you can provide during the\n import to identify resources of that type.

" } }, "com.amazonaws.cloudformation#ResourceIdentifiers": { @@ -10545,13 +10545,13 @@ "Status": { "target": "com.amazonaws.cloudformation#ResourceScanStatus", "traits": { - "smithy.api#documentation": "

Status of the resource scan.

\n
\n
INPROGRESS
\n
\n

The resource scan is still in progress.

\n
\n
COMPLETE
\n
\n

The resource scan is complete.

\n
\n
EXPIRED
\n
\n

The resource scan has expired.

\n
\n
FAILED
\n
\n

The resource scan has failed.

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

Status of the resource scan.

\n
\n
\n \n INPROGRESS\n \n
\n
\n

The resource scan is still in progress.

\n
\n
\n \n COMPLETE\n \n
\n
\n

The resource scan is complete.

\n
\n
\n \n EXPIRED\n \n
\n
\n

The resource scan has expired.

\n
\n
\n \n FAILED\n \n
\n
\n

The resource scan has failed.

\n
\n
" } }, "StatusReason": { "target": "com.amazonaws.cloudformation#ResourceScanStatusReason", "traits": { - "smithy.api#documentation": "

The reason for the resource scan status, providing more information if a failure happened.

" + "smithy.api#documentation": "

The reason for the resource scan status, providing more information if a failure\n happened.

" } }, "StartTime": { @@ -10574,7 +10574,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of the resource scan. This is returned by the ListResourceScan API action.

" + "smithy.api#documentation": "

A summary of the resource scan. This is returned by the ListResourceScan API\n action.

" } }, "com.amazonaws.cloudformation#ResourceScannerMaxResults": { @@ -10752,19 +10752,19 @@ "Attribute": { "target": "com.amazonaws.cloudformation#ResourceAttribute", "traits": { - "smithy.api#documentation": "

Indicates which resource attribute is triggering this update, such as a change in the resource attribute's\n Metadata, Properties, or Tags.

" + "smithy.api#documentation": "

Indicates which resource attribute is triggering this update, such as a change in the\n resource attribute's Metadata, Properties, or Tags.

" } }, "Name": { "target": "com.amazonaws.cloudformation#PropertyName", "traits": { - "smithy.api#documentation": "

If the Attribute value is Properties, the name of the property. For all other\n attributes, the value is null.

" + "smithy.api#documentation": "

If the Attribute value is Properties, the name of the property.\n For all other attributes, the value is null.

" } }, "RequiresRecreation": { "target": "com.amazonaws.cloudformation#RequiresRecreation", "traits": { - "smithy.api#documentation": "

If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

If the Attribute value is Properties, indicates whether a change\n to this property causes the resource to be recreated. The value can be Never,\n Always, or Conditionally. To determine the conditions for a\n Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.

" } }, "Path": { @@ -10776,13 +10776,13 @@ "BeforeValue": { "target": "com.amazonaws.cloudformation#BeforeValue", "traits": { - "smithy.api#documentation": "

The value of the property before the change is executed. Large values can be truncated.

" + "smithy.api#documentation": "

The value of the property before the change is executed. Large values can be\n truncated.

" } }, "AfterValue": { "target": "com.amazonaws.cloudformation#AfterValue", "traits": { - "smithy.api#documentation": "

The value of the property after the change is executed. Large values can be truncated.

" + "smithy.api#documentation": "

The value of the property after the change is executed. Large values can be\n truncated.

" } }, "AttributeChangeType": { @@ -10793,7 +10793,7 @@ } }, "traits": { - "smithy.api#documentation": "

The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be\n recreated.

" + "smithy.api#documentation": "

The field that CloudFormation will change, such as the name of a resource's property, and\n whether the resource will be recreated.

" } }, "com.amazonaws.cloudformation#ResourceToImport": { @@ -10803,7 +10803,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported\n resource types, see Resources that support import\n operations in the CloudFormation User Guide.

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

The type of resource to import into your stack, such as AWS::S3::Bucket. For a\n list of supported resource types, see Resource type\n support for imports and drift detection in the\n CloudFormation User Guide.

", "smithy.api#required": {} } }, @@ -10819,7 +10819,7 @@ "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A key-value pair that identifies the target resource. The key is an identifier property (for example,\n BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for\n example, MyS3Bucket).

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

A key-value pair that identifies the target resource. The key is an identifier property (for\n example, BucketName for AWS::S3::Bucket resources) and the value is the\n actual property value (for example, MyS3Bucket).

", "smithy.api#required": {} } } @@ -10951,18 +10951,18 @@ "RollbackTriggers": { "target": "com.amazonaws.cloudformation#RollbackTriggers", "traits": { - "smithy.api#documentation": "

The triggers to monitor during stack creation or update actions.

\n

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update\n operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those\n triggers replace any list of triggers previously specified for the stack. This means:

\n
    \n
  • \n

    To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

    \n
    • \n
  • \n

    To specify new or updated rollback triggers, you must specify all the triggers that you\n want used for this stack, even triggers you've specified before (for example, when creating the stack or during a\n previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied\n to the stack.

    \n
    • \n
  • \n

    To remove all currently specified triggers, specify an empty list for this parameter.

    \n
    • \n
\n

If a specified trigger is missing, the entire stack operation fails and is rolled back.

" + "smithy.api#documentation": "

The triggers to monitor during stack creation or update actions.

\n

By default, CloudFormation saves the rollback triggers specified for a stack and applies them to\n any subsequent update operations for the stack, unless you specify otherwise. If you do specify\n rollback triggers for this parameter, those triggers replace any list of triggers previously\n specified for the stack. This means:

\n
    \n
  • \n

    To use the rollback triggers previously specified for this stack, if any, don't specify\n this parameter.

    \n
    • \n
  • \n

    To specify new or updated rollback triggers, you must specify all the\n triggers that you want used for this stack, even triggers you've specified before (for example,\n when creating the stack or during a previous stack update). Any triggers that you don't include\n in the updated list of triggers are no longer applied to the stack.

    \n
    • \n
  • \n

    To remove all currently specified triggers, specify an empty list for this\n parameter.

    \n
    • \n
\n

If a specified trigger is missing, the entire stack operation fails and is rolled\n back.

" } }, "MonitoringTimeInMinutes": { "target": "com.amazonaws.cloudformation#MonitoringTimeInMinutes", "traits": { - "smithy.api#documentation": "

The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack\n creation or update operation deploys all necessary resources.

\n

The default is 0 minutes.

\n

If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits the specified\n period of time before cleaning up old resources after update operations. You can use this monitoring period to\n perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

\n

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack\n creation and update operations. Then, for update operations, it begins disposing of old resources immediately once\n the operation completes.

" + "smithy.api#documentation": "

The amount of time, in minutes, during which CloudFormation should monitor all the rollback\n triggers after the stack creation or update operation deploys all necessary resources.

\n

The default is 0 minutes.

\n

If you specify a monitoring period but don't specify any rollback triggers, CloudFormation still\n waits the specified period of time before cleaning up old resources after update operations. You\n can use this monitoring period to perform any manual stack validation desired, and manually\n cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

\n

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback\n triggers during stack creation and update operations. Then, for update operations, it begins\n disposing of old resources immediately once the operation completes.

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

Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations,\n and for the specified monitoring period afterwards.

\n

Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and\n updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've\n specified. For more information, see Monitor and Roll Back Stack\n Operations.

" + "smithy.api#documentation": "

Structure containing the rollback triggers for CloudFormation to monitor during stack creation\n and updating operations, and for the specified monitoring period afterwards.

\n

Rollback triggers enable you to have CloudFormation monitor the state of your application during\n stack creation and updating, and to roll back that operation if the application breaches the\n threshold of any of the alarms you've specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers.

" } }, "com.amazonaws.cloudformation#RollbackStack": { @@ -10979,7 +10979,7 @@ } ], "traits": { - "smithy.api#documentation": "

When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n operation fails. You can check the status of the stack through the DescribeStacks operation.

\n

Rolls back the specified stack to the last known stable state from CREATE_FAILED or\n UPDATE_FAILED stack statuses.

\n

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state\n includes any status in a *_COMPLETE. This includes the following stack statuses.

\n
    \n
  • \n

    \n CREATE_COMPLETE\n

    \n
    • \n
  • \n

    \n UPDATE_COMPLETE\n

    \n
    • \n
  • \n

    \n UPDATE_ROLLBACK_COMPLETE\n

    \n
    • \n
  • \n

    \n IMPORT_COMPLETE\n

    \n
    • \n
  • \n

    \n IMPORT_ROLLBACK_COMPLETE\n

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

When specifying RollbackStack, you preserve the state of previously\n provisioned resources when an operation fails. You can check the status of the stack through\n the DescribeStacks operation.

\n

Rolls back the specified stack to the last known stable state from\n CREATE_FAILED or UPDATE_FAILED stack statuses.

\n

This operation will delete a stack if it doesn't contain a last known stable state. A last\n known stable state includes any status in a *_COMPLETE. This includes the\n following stack statuses.

\n
    \n
  • \n

    \n CREATE_COMPLETE\n

    \n
    • \n
  • \n

    \n UPDATE_COMPLETE\n

    \n
    • \n
  • \n

    \n UPDATE_ROLLBACK_COMPLETE\n

    \n
    • \n
  • \n

    \n IMPORT_COMPLETE\n

    \n
    • \n
  • \n

    \n IMPORT_ROLLBACK_COMPLETE\n

    \n
    • \n
" } }, "com.amazonaws.cloudformation#RollbackStackInput": { @@ -10996,7 +10996,7 @@ "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the\n stack.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the\n stack.

" } }, "ClientRequestToken": { @@ -11008,7 +11008,7 @@ "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.

\n

Default: false\n

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.

\n

Default: false\n

" } } }, @@ -11037,7 +11037,7 @@ "target": "com.amazonaws.cloudformation#Arn", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the rollback trigger.

\n

If a specified trigger is missing, the entire stack operation fails and is rolled back.

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

The Amazon Resource Name (ARN) of the rollback trigger.

\n

If a specified trigger is missing, the entire stack operation fails and is rolled\n back.

", "smithy.api#required": {} } }, @@ -11045,13 +11045,13 @@ "target": "com.amazonaws.cloudformation#Type", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

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

The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

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

A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes\n to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.

" + "smithy.api#documentation": "

A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the\n alarms you specify goes to ALARM state during the stack operation or within the specified\n monitoring period afterwards, CloudFormation rolls back the entire stack operation.

" } }, "com.amazonaws.cloudformation#RollbackTriggers": { @@ -11091,13 +11091,13 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n Resource type support In the CloudFormation User Guide\n

" + "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide\n

" } }, "ResourceIdentifier": { "target": "com.amazonaws.cloudformation#JazzResourceIdentifierProperties", "traits": { - "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.

" + "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

" } }, "ManagedByStack": { @@ -11108,7 +11108,7 @@ } }, "traits": { - "smithy.api#documentation": "

A scanned resource returned by ListResourceScanResources or\n ListResourceScanRelatedResources.

" + "smithy.api#documentation": "

A scanned resource returned by ListResourceScanResources or\n ListResourceScanRelatedResources.

" } }, "com.amazonaws.cloudformation#ScannedResourceIdentifier": { @@ -11118,7 +11118,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see\n IaC\n generator supported resource types In the CloudFormation User Guide.

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

The type of the resource, such as AWS::DynamoDB::Table. For the list of\n supported resources, see Resource type\n support for imports and drift detection In the\n CloudFormation User Guide.

", "smithy.api#required": {} } }, @@ -11126,13 +11126,13 @@ "target": "com.amazonaws.cloudformation#JazzResourceIdentifierProperties", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the\n primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list\n in the resource schema.) The value is the value of that primary identifier. For example, for a\n AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair\n could be \"TableName\": \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension\n development.

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

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the\n name of one of the primary identifiers for the resource. (Primary identifiers are specified in\n the primaryIdentifier list in the resource schema.) The value is the value of that\n primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary\n identifiers is TableName so the key-value pair could be \"TableName\":\n \"MyDDBTable\". For more information, see primaryIdentifier in the CloudFormation Command Line Interface (CLI) User Guide.

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

Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API\n action.

" + "smithy.api#documentation": "

Identifies a scanned resource. This is used with the\n ListResourceScanRelatedResources API action.

" } }, "com.amazonaws.cloudformation#ScannedResourceIdentifiers": { @@ -11179,13 +11179,13 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

" + "smithy.api#documentation": "

Structure containing the stack policy body. For more information, see Prevent updates to stack resources in the CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for an Amazon S3 bucket must\n start with https://. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

" + "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as the stack. The location for\n an Amazon S3 bucket must start with https://. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.

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

Specifies the configuration data for a registered CloudFormation extension, in the given account and Region.

\n

To view the current configuration data for an extension, refer to the ConfigurationSchema element\n of DescribeType. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.

\n \n

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User Guide.

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

Specifies the configuration data for a registered CloudFormation extension, in the given\n account and Region.

\n

To view the current configuration data for an extension, refer to the\n ConfigurationSchema element of DescribeType. For\n more information, see Edit configuration\n data for extensions in your account in the\n CloudFormation User Guide.

\n \n

It's strongly recommended that you use dynamic references to restrict sensitive\n configuration definitions, such as third-party credentials. For more details on dynamic\n references, see Specify values stored in\n other services using dynamic references in the\n CloudFormation User Guide.

\n " } }, "com.amazonaws.cloudformation#SetTypeConfigurationInput": { @@ -11220,33 +11220,33 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account\n and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account\n and Region.

\n

Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an\n extension, but not for a specific extension version.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.

\n

Do not include the extension versions suffix at the end of the ARN. You can set the\n configuration for an extension, but not for a specific extension version.

" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The configuration data for the extension, in this account and Region.

\n

The configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of DescribeType. For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.

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

The configuration data for the extension, in this account and Region.

\n

The configuration data must be formatted as JSON, and validate against the schema returned\n in the ConfigurationSchema response element of DescribeType. For\n more information, see Defining the account-level configuration of an extension in the\n CloudFormation Command Line Interface (CLI) User Guide.

", "smithy.api#required": {} } }, "ConfigurationAlias": { "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", "traits": { - "smithy.api#documentation": "

An alias by which to refer to this extension configuration data.

\n

Conditional: Specifying a configuration alias is required when setting a configuration for a resource type\n extension.

" + "smithy.api#documentation": "

An alias by which to refer to this extension configuration data.

\n

Conditional: Specifying a configuration alias is required when setting a configuration for\n a resource type extension.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify ConfigurationArn, or Type and\n TypeName.

" + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify ConfigurationArn, or Type and\n TypeName.

" } }, "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "

The type of extension.

\n

Conditional: You must specify ConfigurationArn, or Type and\n TypeName.

" + "smithy.api#documentation": "

The type of extension.

\n

Conditional: You must specify ConfigurationArn, or Type and\n TypeName.

" } } }, @@ -11260,7 +11260,7 @@ "ConfigurationArn": { "target": "com.amazonaws.cloudformation#TypeConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration data, in this account and Region.

\n

Conditional: You must specify ConfigurationArn, or Type and\n TypeName.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration data, in this account and\n Region.

\n

Conditional: You must specify ConfigurationArn, or Type and\n TypeName.

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

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

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

Specify the default version of an extension. The default version of an extension will be\n used in CloudFormation operations.

", "smithy.api#idempotent": {} } }, @@ -11295,25 +11295,25 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension for which you want version summary information.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension for which you want version summary\n information.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "

The kind of extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The kind of extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify either TypeName and Type, or Arn.

" + "smithy.api#documentation": "

The name of the extension.

\n

Conditional: You must specify either TypeName and Type, or\n Arn.

" } }, "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.

" + "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

" } } }, @@ -11337,7 +11337,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation doesn't\n proceed with a stack creation or update until resources receive the required number of signals or the timeout period\n is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.

" + "smithy.api#documentation": "

Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update\n policy. CloudFormation doesn't proceed with a stack creation or update until resources receive the\n required number of signals or the timeout period is exceeded. The SignalResource\n operation is useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.

" } }, "com.amazonaws.cloudformation#SignalResourceInput": { @@ -11347,7 +11347,7 @@ "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The stack name or unique stack ID that includes the resource that you want to signal.

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

The stack name or unique stack ID that includes the resource that you want to\n signal.

", "smithy.api#required": {} } }, @@ -11355,7 +11355,7 @@ "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in\n the template.

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

The logical ID of the resource that you want to signal. The logical ID is the name of the\n resource that given in the template.

", "smithy.api#required": {} } }, @@ -11363,7 +11363,7 @@ "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the\n instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as\n signaling a wait condition), each signal requires a different unique ID.

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

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the\n instance ID that you are signaling as the unique ID. If you send multiple signals to a single\n resource (such as signaling a wait condition), each signal requires a different unique\n ID.

", "smithy.api#required": {} } }, @@ -11371,7 +11371,7 @@ "target": "com.amazonaws.cloudformation#ResourceSignalStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The status of the signal, which is either success or failure. A failure signal causes CloudFormation to immediately\n fail the stack creation or update.

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

The status of the signal, which is either success or failure. A failure signal causes\n CloudFormation to immediately fail the stack creation or update.

", "smithy.api#required": {} } } @@ -11433,13 +11433,13 @@ "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { - "smithy.api#documentation": "

The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.

" + "smithy.api#documentation": "

The time the stack was last updated. This field will only be returned if the stack has been\n updated at least once.

" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified\n monitoring period afterwards.

" + "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.

" } }, "StackStatus": { @@ -11489,7 +11489,7 @@ "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.\n During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a\n stack operation, CloudFormation uses this role's credentials to make calls on your behalf.

" } }, "Tags": { @@ -11501,43 +11501,43 @@ "EnableTerminationProtection": { "target": "com.amazonaws.cloudformation#EnableTerminationProtection", "traits": { - "smithy.api#documentation": "

Whether termination protection is enabled for the stack.

\n

For nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.\n For more information, see Protecting a Stack From Being Deleted\n in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Whether termination protection is enabled for the stack.

\n

For nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack. For more information, see Protect a CloudFormation\n stack from being deleted in the CloudFormation User Guide.

" } }, "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this\n stack. For the first level of nested stacks, the root stack is also the parent stack.

\n

For more information, see Working with Nested Stacks in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the direct\n parent of this stack. For the first level of nested stacks, the root stack is also the parent\n stack.

\n

For more information, see Embed stacks within other\n stacks using nested stacks in the CloudFormation User Guide.

" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which\n the nested stack ultimately belongs.

\n

For more information, see Working with Nested Stacks in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.

\n

For more information, see Embed stacks within other\n stacks using nested stacks in the CloudFormation User Guide.

" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformation", "traits": { - "smithy.api#documentation": "

Information about whether a stack's actual configuration differs, or has drifted, from its\n expected configuration, as defined in the stack template and any values specified as template parameters. For more\n information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + "smithy.api#documentation": "

Information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.

" } }, "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.

\n

Default: false\n

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls\n back. This includes newly created resources marked with a deletion policy of\n Retain.

\n

Default: false\n

" } }, "DeletionMode": { "target": "com.amazonaws.cloudformation#DeletionMode", "traits": { - "smithy.api#documentation": "

Specifies the deletion mode for the stack. Possible values are:

\n
    \n
  • \n

    \n STANDARD - Use the standard behavior. Specifying this value is the same as not specifying this\n parameter.

    \n
    • \n
  • \n

    \n FORCE_DELETE_STACK - Delete the stack if it's stuck in a DELETE_FAILED state due to\n resource deletion failure.

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

Specifies the deletion mode for the stack. Possible values are:

\n
    \n
  • \n

    \n STANDARD - Use the standard behavior. Specifying this value is the same as\n not specifying this parameter.

    \n
    • \n
  • \n

    \n FORCE_DELETE_STACK - Delete the stack if it's stuck in a\n DELETE_FAILED state due to resource deletion failure.

    \n
    • \n
" } }, "DetailedStatus": { "target": "com.amazonaws.cloudformation#DetailedStatus", "traits": { - "smithy.api#documentation": "

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or\n resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets\n CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more\n information, see CloudFormation stack deployment in\n the CloudFormation User Guide.

" + "smithy.api#documentation": "

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is\n present, the resource or resource configuration phase has completed and the stabilization of the\n resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the\n resources in the stack have reached that event. For more information, see Understand\n CloudFormation stack creation events in the CloudFormation User Guide.

" } } }, @@ -11587,19 +11587,19 @@ "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.

    \n
    • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template configuration.

    \n
    • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

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

Status of the stack's actual configuration compared to its expected template\n configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.

    \n
    • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
    • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
    • \n
", "smithy.api#required": {} } }, "LastCheckTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources\n that support drift detection.

" + "smithy.api#documentation": "

Most recent time when a drift detection operation was initiated on the stack, or any of its\n individual resources that support drift detection.

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

Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. A stack is considered to have drifted if one or more of its resources have\n drifted.

" + "smithy.api#documentation": "

Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. A stack is considered to have drifted if one or\n more of its resources have drifted.

" } }, "com.amazonaws.cloudformation#StackDriftInformationSummary": { @@ -11609,19 +11609,19 @@ "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Status of the stack's actual configuration compared to its expected template configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.

    \n
    • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template configuration.

    \n
    • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

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

Status of the stack's actual configuration compared to its expected template\n configuration.

\n
    \n
  • \n

    \n DRIFTED: The stack differs from its expected template configuration. A stack\n is considered to have drifted if one or more of its resources have drifted.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.

    \n
    • \n
  • \n

    \n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.

    \n
    • \n
  • \n

    \n UNKNOWN: This value is reserved for future use.

    \n
    • \n
", "smithy.api#required": {} } }, "LastCheckTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources\n that support drift detection.

" + "smithy.api#documentation": "

Most recent time when a drift detection operation was initiated on the stack, or any of its\n individual resources that support drift detection.

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

Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. A stack is considered to have drifted if one or more of its resources have\n drifted.

" + "smithy.api#documentation": "

Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. A stack is considered to have drifted if one or\n more of its resources have drifted.

" } }, "com.amazonaws.cloudformation#StackDriftStatus": { @@ -11695,7 +11695,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)

" + "smithy.api#documentation": "

Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.

" } }, "Timestamp": { @@ -11727,7 +11727,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The token passed to the operation that generated this event.

\n

All events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

The token passed to the operation that generated this event.

\n

All events triggered by a given stack operation are assigned the same client request token,\n which you can use to track operations. For example, if you execute a CreateStack\n operation with the token token1, then all the StackEvents generated by\n that operation will have ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } }, "HookType": { @@ -11763,7 +11763,7 @@ "DetailedStatus": { "target": "com.amazonaws.cloudformation#DetailedStatus", "traits": { - "smithy.api#documentation": "

An optional field containing information about the detailed status of the stack event.

\n
    \n
  • \n

    \n CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more\n information, see CloudFormation stack deployment\n in the CloudFormation User Guide.

    \n
    • \n
\n
    \n
  • \n

    \n VALIDATION_FAILED - template validation failed because of invalid properties in the template. The\n ResourceStatusReason field shows what properties are defined incorrectly.

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

An optional field containing information about the detailed status of the stack\n event.

\n \n
    \n
  • \n

    \n VALIDATION_FAILED - template validation failed because of invalid properties\n in the template. The ResourceStatusReason field shows what properties are defined\n incorrectly.

    \n
    • \n
" } } }, @@ -11873,7 +11873,7 @@ } }, "traits": { - "smithy.api#documentation": "

An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a\n reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist\n without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with\n only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the\n actual stack and the stack status.

" + "smithy.api#documentation": "

A CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a\n reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist\n without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with\n only one stack set. Each stack instance contains the ID of its associated stack set, in addition to the ID of the\n actual stack and the stack status.

" } }, "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { @@ -12066,7 +12066,7 @@ "target": "com.amazonaws.cloudformation#ResourceType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.

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

Type of resource. For more information, see Amazon Web Services resource and \n property types reference in the CloudFormation User Guide.

", "smithy.api#required": {} } }, @@ -12291,14 +12291,14 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

" + "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.

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

Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.

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

Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.

", "smithy.api#required": {} } }, @@ -12333,13 +12333,13 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", "traits": { - "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.

" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { - "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.

" + "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.

" } } }, @@ -12373,14 +12373,14 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

" + "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.

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

Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.

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

Type of resource. For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.

", "smithy.api#required": {} } }, @@ -12415,19 +12415,19 @@ "Metadata": { "target": "com.amazonaws.cloudformation#Metadata", "traits": { - "smithy.api#documentation": "

The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute\n in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The content of the Metadata attribute declared for the resource. For more\n information, see Metadata attribute\n in the CloudFormation User Guide.

" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", "traits": { - "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.

" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { - "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.

" + "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.

" } } }, @@ -12457,13 +12457,13 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a resource supported by\n CloudFormation.

" + "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.

" } }, "PhysicalResourceIdContext": { "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", "traits": { - "smithy.api#documentation": "

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a unique resource that contains the targeted resource.

" + "smithy.api#documentation": "

Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough to\n uniquely identify that resource. Each context key-value pair specifies a unique resource that\n contains the targeted resource.

" } }, "ResourceType": { @@ -12477,26 +12477,26 @@ "ExpectedProperties": { "target": "com.amazonaws.cloudformation#Properties", "traits": { - "smithy.api#documentation": "

A JSON structure containing the expected property values of the stack resource, as defined in the stack template\n and any values specified as template parameters.

\n

For resources whose StackResourceDriftStatus is DELETED, this structure will not be\n present.

" + "smithy.api#documentation": "

A JSON structure containing the expected property values of the stack resource, as defined\n in the stack template and any values specified as template parameters.

\n

For resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.

" } }, "ActualProperties": { "target": "com.amazonaws.cloudformation#Properties", "traits": { - "smithy.api#documentation": "

A JSON structure containing the actual property values of the stack resource.

\n

For resources whose StackResourceDriftStatus is DELETED, this structure will not be\n present.

" + "smithy.api#documentation": "

A JSON structure containing the actual property values of the stack resource.

\n

For resources whose StackResourceDriftStatus is DELETED, this\n structure will not be present.

" } }, "PropertyDifferences": { "target": "com.amazonaws.cloudformation#PropertyDifferences", "traits": { - "smithy.api#documentation": "

A collection of the resource properties whose actual values differ from their expected values. These will be\n present only for resources whose StackResourceDriftStatus is\n MODIFIED.

" + "smithy.api#documentation": "

A collection of the resource properties whose actual values differ from their expected\n values. These will be present only for resources whose StackResourceDriftStatus is\n MODIFIED.

" } }, "StackResourceDriftStatus": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Status of the resource's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration because the resource has\n been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected values (as defined in the\n stack template and any values specified as template parameters).

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected template configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation does not currently return this value.

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

Status of the resource's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected template configuration\n because the resource has been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: One or more resource properties differ from their expected values\n (as defined in the stack template and any values specified as template parameters).

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected template\n configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation does not currently return this value.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -12511,12 +12511,12 @@ "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { - "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.

" + "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.

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

Contains the drift information for a resource that has been checked for drift. This includes actual and expected\n property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the\n stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.

\n

Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.

\n

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

" + "smithy.api#documentation": "

Contains the drift information for a resource that has been checked for drift. This includes\n actual and expected property values for resources in which CloudFormation has detected drift. Only\n resource properties explicitly defined in the stack template are checked for drift. For more\n information, see Detect unmanaged\n configuration changes to stacks and resources with drift detection.

\n

Resources that don't currently support drift detection can't be checked. For a list of\n resources that support drift detection, see Resource type\n support for imports and drift detection.

\n

Use DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack that\n support drift detection.

" } }, "com.amazonaws.cloudformation#StackResourceDriftInformation": { @@ -12526,19 +12526,19 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Status of the resource's actual configuration compared to its expected configuration

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected configuration in that it has been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: The resource differs from its expected configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected\n configuration.

    \n

    Any resources that do not currently support drift detection have a status of NOT_CHECKED. For\n more information, see Resources that Support Drift\n Detection.

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected configuration.

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

Status of the resource's actual configuration compared to its expected configuration

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected configuration in that it has\n been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: The resource differs from its expected configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation has not checked if the resource differs from its\n expected configuration.

    \n

    Any resources that do not currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resource\n type support for imports and drift detection.

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected\n configuration.

    \n
    • \n
", "smithy.api#required": {} } }, "LastCheckTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

When CloudFormation last checked if the resource had drifted from its expected configuration.

" + "smithy.api#documentation": "

When CloudFormation last checked if the resource had drifted from its expected\n configuration.

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

Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.

" + "smithy.api#documentation": "

Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.

" } }, "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { @@ -12548,19 +12548,19 @@ "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Status of the resource's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected configuration in that it has been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: The resource differs from its expected configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.

    \n

    Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more\n information, see Resources that Support Drift\n Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources\n included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information\n about skipping resources during rollback operations, see Continue Rolling\n Back an Update in the CloudFormation User Guide.

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected configuration.

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

Status of the resource's actual configuration compared to its expected configuration.

\n
    \n
  • \n

    \n DELETED: The resource differs from its expected configuration in that it has\n been deleted.

    \n
    • \n
  • \n

    \n MODIFIED: The resource differs from its expected configuration.

    \n
    • \n
  • \n

    \n NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its\n expected configuration.

    \n

    Any resources that don't currently support drift detection have a status of\n NOT_CHECKED. For more information, see Resource\n type support for imports and drift detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in\n ResourcesToSkip will also have a status of NOT_CHECKED. For more\n information about skipping resources during rollback operations, see Continue rolling back an update in the CloudFormation User Guide.

    \n
    • \n
  • \n

    \n IN_SYNC: The resource's actual configuration matches its expected\n configuration.

    \n
    • \n
", "smithy.api#required": {} } }, "LastCheckTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

When CloudFormation last checked if the resource had drifted from its expected configuration.

" + "smithy.api#documentation": "

When CloudFormation last checked if the resource had drifted from its expected\n configuration.

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

Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.

" + "smithy.api#documentation": "

Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.

" } }, "com.amazonaws.cloudformation#StackResourceDriftStatus": { @@ -12630,14 +12630,14 @@ "PhysicalResourceId": { "target": "com.amazonaws.cloudformation#PhysicalResourceId", "traits": { - "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of the resource.

" + "smithy.api#documentation": "

The name or unique identifier that corresponds to a physical instance ID of the\n resource.

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

Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)

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

Type of resource. (For more information, see Amazon Web Services resource and\n property types reference in the CloudFormation User Guide.)

", "smithy.api#required": {} } }, @@ -12666,13 +12666,13 @@ "DriftInformation": { "target": "com.amazonaws.cloudformation#StackResourceDriftInformationSummary", "traits": { - "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + "smithy.api#documentation": "

Information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.

" } }, "ModuleInfo": { "target": "com.amazonaws.cloudformation#ModuleInfo", "traits": { - "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.

" + "smithy.api#documentation": "

Contains information about the module from which the resource was created, if the resource\n was created from a module included in the stack template.

" } } }, @@ -12728,7 +12728,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

The capabilities that are allowed in the stack set. Some stack set templates might include resources that can\n affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation\n Templates.\n

" + "smithy.api#documentation": "

The capabilities that are allowed in the stack set. Some stack set templates might include resources that can\n affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM resources in\n CloudFormation templates.

" } }, "Tags": { @@ -13009,7 +13009,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "

The status of the operation.

\n
    \n
  • \n

    \n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

    \n
    • \n
  • \n

    \n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.

    \n
    • \n
  • \n

    \n RUNNING: The operation is currently being performed.

    \n
    • \n
  • \n

    \n STOPPED: The user has canceled the operation.

    \n
    • \n
  • \n

    \n STOPPING: The operation is in the process of stopping, at user request.

    \n
    • \n
  • \n

    \n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.

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

The status of the operation.

\n
    \n
  • \n

    \n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

    \n
    • \n
  • \n

    \n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.

    \n
    • \n
  • \n

    \n RUNNING: The operation is currently being performed.

    \n
    • \n
  • \n

    \n STOPPED: The user has canceled the operation.

    \n
    • \n
  • \n

    \n STOPPING: The operation is in the process of stopping, at user request.

    \n
    • \n
  • \n

    \n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.

    \n
    • \n
" } }, "OperationPreferences": { @@ -13057,7 +13057,7 @@ "StackSetDriftDetectionDetails": { "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", "traits": { - "smithy.api#documentation": "

Detailed information about the drift status of the stack set. This includes information about drift operations\n currently being performed on the stack set.

\n

This information will only be present for stack set operations whose Action type is\n DETECT_DRIFT.

\n

For more information, see Detecting Unmanaged Changes in Stack Sets in\n the CloudFormation User Guide.

" + "smithy.api#documentation": "

Detailed information about the drift status of the stack set. This includes information about drift operations\n currently being performed on the stack set.

\n

This information will only be present for stack set operations whose Action type is\n DETECT_DRIFT.

\n

For more information, see Detect stack set drift in\n the CloudFormation User Guide.

" } }, "StatusReason": { @@ -13153,7 +13153,7 @@ } }, "traits": { - "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.

" + "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.

" } }, "com.amazonaws.cloudformation#StackSetOperationResultStatus": { @@ -13323,7 +13323,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "

The overall status of the operation.

\n
    \n
  • \n

    \n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

    \n
    • \n
  • \n

    \n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.

    \n
    • \n
  • \n

    \n RUNNING: The operation is currently being performed.

    \n
    • \n
  • \n

    \n STOPPED: The user has canceled the operation.

    \n
    • \n
  • \n

    \n STOPPING: The operation is in the process of stopping, at user request.

    \n
    • \n
  • \n

    \n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.

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

The overall status of the operation.

\n
    \n
  • \n

    \n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.

    \n
    • \n
  • \n

    \n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.

    \n
    • \n
  • \n

    \n RUNNING: The operation is currently being performed.

    \n
    • \n
  • \n

    \n STOPPED: The user has canceled the operation.

    \n
    • \n
  • \n

    \n STOPPING: The operation is in the process of stopping, at user request.

    \n
    • \n
  • \n

    \n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.

    \n
    • \n
" } }, "CreationTimestamp": { @@ -13353,7 +13353,7 @@ "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.

" + "smithy.api#documentation": "

The user-specified preferences for how CloudFormation performs a stack set operation.

\n

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.

" } } }, @@ -13638,7 +13638,7 @@ "LastUpdatedTime": { "target": "com.amazonaws.cloudformation#LastUpdatedTime", "traits": { - "smithy.api#documentation": "

The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.

" + "smithy.api#documentation": "

The time the stack was last updated. This field will only be returned if the stack has been\n updated at least once.

" } }, "DeletionTime": { @@ -13664,19 +13664,19 @@ "ParentId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this\n stack. For the first level of nested stacks, the root stack is also the parent stack.

\n

For more information, see Working with Nested Stacks in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the direct\n parent of this stack. For the first level of nested stacks, the root stack is also the parent\n stack.

\n

For more information, see Embed stacks within other\n stacks using nested stacks in the CloudFormation User Guide.

" } }, "RootId": { "target": "com.amazonaws.cloudformation#StackId", "traits": { - "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which\n the nested stack ultimately belongs.

\n

For more information, see Working with Nested Stacks in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

For nested stacks--stacks created as resources for another stack--the stack ID of the\n top-level stack to which the nested stack ultimately belongs.

\n

For more information, see Embed stacks within other\n stacks using nested stacks in the CloudFormation User Guide.

" } }, "DriftInformation": { "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", "traits": { - "smithy.api#documentation": "

Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.

" + "smithy.api#documentation": "

Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template\n and any values specified as template parameters. For more information, see Detect\n unmanaged configuration changes to stacks and resources with drift detection.

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

Starts a scan of the resources in this account in this Region. You can the status of a scan using the\n ListResourceScans API action.

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

Starts a scan of the resources in this account in this Region. You can the status of a\n scan using the ListResourceScans API action.

", "smithy.api#examples": [ { "title": "To start a resource scan", @@ -13748,7 +13748,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this StartResourceScan request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to start a new resource scan.

" + "smithy.api#documentation": "

A unique identifier for this StartResourceScan request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to start a new\n resource scan.

" } } }, @@ -13762,7 +13762,7 @@ "ResourceScanId": { "target": "com.amazonaws.cloudformation#ResourceScanId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource scan. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An\n example is\n arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772\n .

" } } }, @@ -13824,7 +13824,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

    \n
    • \n
" } } }, @@ -13861,7 +13861,7 @@ "target": "com.amazonaws.cloudformation#TagKey", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n Required. A string used to identify this tag. You can specify a maximum of 128 characters\n for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix:\n aws:.

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

\n Required. A string used to identify this tag. You can specify a maximum of\n 128 characters for a tag key. Tags owned by Amazon Web Services have the reserved prefix:\n aws:.

", "smithy.api#required": {} } }, @@ -13869,13 +13869,13 @@ "target": "com.amazonaws.cloudformation#TagValue", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n Required. A string containing the value for this tag. You can specify a maximum of 256\n characters for a tag value.

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

\n Required. A string containing the value for this tag. You can specify a\n maximum of 256 characters for a tag value.

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

The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.

" + "smithy.api#documentation": "

The Tag type enables you to specify a key-value pair that can be used to store information\n about an CloudFormation stack.

" } }, "com.amazonaws.cloudformation#TagKey": { @@ -13922,13 +13922,13 @@ "DeletionPolicy": { "target": "com.amazonaws.cloudformation#GeneratedTemplateDeletionPolicy", "traits": { - "smithy.api#documentation": "

The DeletionPolicy assigned to resources in the generated template. Supported values are:

\n
    \n
  • \n

    \n DELETE - delete all resources when the stack is deleted.

    \n
    • \n
  • \n

    \n RETAIN - retain all resources when the stack is deleted.

    \n
    • \n
\n

For more information, see DeletionPolicy attribute in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

The DeletionPolicy assigned to resources in the generated template. Supported\n values are:

\n
    \n
  • \n

    \n DELETE - delete all resources when the stack is deleted.

    \n
    • \n
  • \n

    \n RETAIN - retain all resources when the stack is deleted.

    \n
    • \n
\n

For more information, see DeletionPolicy\n attribute in the CloudFormation User Guide.

" } }, "UpdateReplacePolicy": { "target": "com.amazonaws.cloudformation#GeneratedTemplateUpdateReplacePolicy", "traits": { - "smithy.api#documentation": "

The UpdateReplacePolicy assigned to resources in the generated template. Supported values\n are:

\n
    \n
  • \n

    \n DELETE - delete all resources when the resource is replaced during an update operation.

    \n
    • \n
  • \n

    \n RETAIN - retain all resources when the resource is replaced during an update operation.

    \n
    • \n
\n

For more information, see UpdateReplacePolicy\n attribute in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The UpdateReplacePolicy assigned to resources in the generated template.\n Supported values are:

\n
    \n
  • \n

    \n DELETE - delete all resources when the resource is replaced during an update\n operation.

    \n
    • \n
  • \n

    \n RETAIN - retain all resources when the resource is replaced during an update\n operation.

    \n
    • \n
\n

For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide.

" } } }, @@ -13974,7 +13974,7 @@ "NoEcho": { "target": "com.amazonaws.cloudformation#NoEcho", "traits": { - "smithy.api#documentation": "

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

" + "smithy.api#documentation": "

Flag indicating whether the parameter should be displayed as plain text in logs and\n UIs.

" } }, "Description": { @@ -14064,7 +14064,7 @@ "GeneratedTemplateId": { "target": "com.amazonaws.cloudformation#GeneratedTemplateId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For\n example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

" } }, "GeneratedTemplateName": { @@ -14082,7 +14082,7 @@ "StatusReason": { "target": "com.amazonaws.cloudformation#TemplateStatusReason", "traits": { - "smithy.api#documentation": "

The reason for the current template generation status. This will provide more details if a failure\n happened.

" + "smithy.api#documentation": "

The reason for the current template generation status. This will provide more details if a\n failure happened.

" } }, "CreationTime": { @@ -14100,7 +14100,7 @@ "NumberOfResources": { "target": "com.amazonaws.cloudformation#NumberOfResources", "traits": { - "smithy.api#documentation": "

The number of resources in the generated template. This is a total of resources in pending, in-progress,\n completed, and failed states.

" + "smithy.api#documentation": "

The number of resources in the generated template. This is a total of resources in pending,\n in-progress, completed, and failed states.

" } } }, @@ -14114,7 +14114,7 @@ "TreatUnrecognizedResourceTypesAsWarnings": { "target": "com.amazonaws.cloudformation#TreatUnrecognizedResourceTypesAsWarnings", "traits": { - "smithy.api#documentation": "

If set to True, any unrecognized resource types generate warnings and not an error. Any\n unrecognized resource types are returned in the Warnings output parameter.

" + "smithy.api#documentation": "

If set to True, any unrecognized resource types generate warnings and not an\n error. Any unrecognized resource types are returned in the Warnings output\n parameter.

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

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

\n
    \n
  • \n

    For resource types, this includes passing all contracts tests defined for the type.

    \n
    • \n
  • \n

    For modules, this includes determining if the module's model meets all necessary requirements.

    \n
    • \n
\n

For more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.

\n

If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region\n for testing.

\n

To perform testing, CloudFormation assumes the execution role specified when the type was registered. For more\n information, see RegisterType.

\n

Once you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into DescribeType to monitor the current test\n status and test status description for the extension.

\n

An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.

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

Tests a registered extension to make sure it meets all necessary requirements for being\n published in the CloudFormation registry.

\n
    \n
  • \n

    For resource types, this includes passing all contracts tests defined for the\n type.

    \n
    • \n
  • \n

    For modules, this includes determining if the module's model meets all necessary\n requirements.

    \n
    • \n
\n

For more information, see Testing your public extension before publishing in the\n CloudFormation Command Line Interface (CLI) User Guide.

\n

If you don't specify a version, CloudFormation uses the default version of the extension in\n your account and Region for testing.

\n

To perform testing, CloudFormation assumes the execution role specified when the type was\n registered. For more information, see RegisterType.

\n

Once you've initiated testing on an extension using TestType, you can pass\n the returned TypeVersionArn into DescribeType to\n monitor the current test status and test status description for the extension.

\n

An extension must have a test status of PASSED before it can be published.\n For more information, see Publishing extensions\n to make them available for public use in the\n CloudFormation Command Line Interface (CLI) User Guide.

", "smithy.api#idempotent": {} } }, @@ -14158,31 +14158,31 @@ "Arn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the extension.

\n

Conditional: You must specify Arn, or TypeName and\n Type.

" } }, "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "

The type of the extension to test.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The type of the extension to test.

\n

Conditional: You must specify Arn, or TypeName and\n Type.

" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension to test.

\n

Conditional: You must specify Arn, or TypeName and Type.

" + "smithy.api#documentation": "

The name of the extension to test.

\n

Conditional: You must specify Arn, or TypeName and\n Type.

" } }, "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The version of the extension to test.

\n

You can specify the version id with either Arn, or with TypeName and\n Type.

\n

If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region\n for testing.

" + "smithy.api#documentation": "

The version of the extension to test.

\n

You can specify the version id with either Arn, or with TypeName\n and Type.

\n

If you don't specify a version, CloudFormation uses the default version of the extension in\n this account and Region for testing.

" } }, "LogDeliveryBucket": { "target": "com.amazonaws.cloudformation#S3Bucket", "traits": { - "smithy.api#documentation": "

The S3 bucket to which CloudFormation delivers the contract test execution logs.

\n

CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a\n test type status of PASSED or FAILED.

\n

The user calling TestType must be able to access items in the specified S3 bucket. Specifically,\n the user needs the following permissions:

\n
    \n
  • \n

    \n GetObject\n

    \n
    • \n
  • \n

    \n PutObject\n

    \n
    • \n
\n

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

" + "smithy.api#documentation": "

The S3 bucket to which CloudFormation delivers the contract test execution logs.

\n

CloudFormation delivers the logs by the time contract testing has completed and the extension\n has been assigned a test type status of PASSED or FAILED.

\n

The user calling TestType must be able to access items in the specified S3\n bucket. Specifically, the user needs the following permissions:

\n
    \n
  • \n

    \n GetObject\n

    \n
    • \n
  • \n

    \n PutObject\n

    \n
    • \n
\n

For more information, see Actions, Resources, and\n Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

" } } }, @@ -14342,31 +14342,31 @@ "Arn": { "target": "com.amazonaws.cloudformation#TypeConfigurationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration data, in this account and Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the configuration data, in this account and\n Region.

" } }, "Alias": { "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", "traits": { - "smithy.api#documentation": "

The alias specified for this configuration, if one was specified when the configuration was set.

" + "smithy.api#documentation": "

The alias specified for this configuration, if one was specified when the configuration was\n set.

" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { - "smithy.api#documentation": "

A JSON string specifying the configuration data for the extension, in this account and Region.

\n

If a configuration hasn't been set for a specified extension, CloudFormation returns {}.

" + "smithy.api#documentation": "

A JSON string specifying the configuration data for the extension, in this account and\n Region.

\n

If a configuration hasn't been set for a specified extension, CloudFormation returns\n {}.

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

When the configuration data was last updated for this extension.

\n

If a configuration hasn't been set for a specified extension, CloudFormation returns null.

" + "smithy.api#documentation": "

When the configuration data was last updated for this extension.

\n

If a configuration hasn't been set for a specified extension, CloudFormation returns\n null.

" } }, "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account\n and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account\n and Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.

" } }, "TypeName": { @@ -14383,7 +14383,7 @@ } }, "traits": { - "smithy.api#documentation": "

Detailed information concerning the specification of a CloudFormation extension in a given account and\n Region.

\n

For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.

" + "smithy.api#documentation": "

Detailed information concerning the specification of a CloudFormation extension in a given\n account and Region.

\n

For more information, see Edit configuration data\n for extensions in your account in the CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#TypeConfigurationDetailsList": { @@ -14398,13 +14398,13 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account\n and Region. For private extensions, this will be the ARN assigned when you call the RegisterType API operation in this account\n and Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the extension, in this account and Region.

\n

For public extensions, this will be the ARN assigned when you call the ActivateType API operation in this account and Region. For private extensions, this\n will be the ARN assigned when you call the RegisterType API\n operation in this account and Region.

" } }, "TypeConfigurationAlias": { "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", "traits": { - "smithy.api#documentation": "

The alias specified for this configuration, if one was specified when the configuration was set.

" + "smithy.api#documentation": "

The alias specified for this configuration, if one was specified when the configuration was\n set.

" } }, "TypeConfigurationArn": { @@ -14447,7 +14447,7 @@ "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { - "smithy.api#documentation": "

An message with details about the error that occurred.

" + "smithy.api#documentation": "

A message with details about the error that occurred.

" } } }, @@ -14467,13 +14467,13 @@ "Category": { "target": "com.amazonaws.cloudformation#Category", "traits": { - "smithy.api#documentation": "

The category of extensions to return.

\n
    \n
  • \n

    \n REGISTERED: Private extensions that have been registered for this account and Region.

    \n
    • \n
  • \n

    \n ACTIVATED: Public extensions that have been activated for this account and Region.

    \n
    • \n
  • \n

    \n THIRD_PARTY: Extensions available for use from publishers other than Amazon. This\n includes:

    \n
      \n
    • \n

      Private extensions registered in the account.

      \n
      • \n
    • \n

      Public extensions from publishers other than Amazon, whether activated or not.

      \n
      • \n
    \n
    • \n
  • \n

    \n AWS_TYPES: Extensions available for use from Amazon.

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

The category of extensions to return.

\n
    \n
  • \n

    \n REGISTERED: Private extensions that have been registered for this account and\n Region.

    \n
    • \n
  • \n

    \n ACTIVATED: Public extensions that have been activated for this account and\n Region.

    \n
    • \n
  • \n

    \n THIRD_PARTY: Extensions available for use from publishers other than Amazon.\n This includes:

    \n
      \n
    • \n

      Private extensions registered in the account.

      \n
      • \n
    • \n

      Public extensions from publishers other than Amazon, whether activated or not.

      \n
      • \n
    \n
    • \n
  • \n

    \n AWS_TYPES: Extensions available for use from Amazon.

    \n
    • \n
" } }, "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { - "smithy.api#documentation": "

The id of the publisher of the extension.

\n

Extensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES category to\n specify a list of types published by Amazon.

" + "smithy.api#documentation": "

The id of the publisher of the extension.

\n

Extensions published by Amazon aren't assigned a publisher ID. Use the\n AWS_TYPES category to specify a list of types published by Amazon.

" } }, "TypeNamePrefix": { @@ -14516,7 +14516,7 @@ "Message": { "target": "com.amazonaws.cloudformation#ErrorMessage", "traits": { - "smithy.api#documentation": "

An message with details about the error that occurred.

" + "smithy.api#documentation": "

A message with details about the error that occurred.

" } } }, @@ -14557,13 +14557,13 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

The name of the extension.

\n

If you specified a TypeNameAlias when you call the ActivateType API operation in your account\n and Region, CloudFormation considers that alias as the type name.

" + "smithy.api#documentation": "

The name of the extension.

\n

If you specified a TypeNameAlias when you call the ActivateType API\n operation in your account and Region, CloudFormation considers that alias as the type name.

" } }, "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.

\n

This applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more information, see\n RegisterType.

\n

To set the default version of an extension, use SetTypeDefaultVersion.

" + "smithy.api#documentation": "

The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.

\n

This applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon and published by third parties, CloudFormation returns\n null. For more information, see RegisterType.

\n

To set the default version of an extension, use SetTypeDefaultVersion.

" } }, "TypeArn": { @@ -14575,7 +14575,7 @@ "LastUpdated": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

When the specified extension version was registered. This applies only to:

\n
    \n
  • \n

    Private extensions you have registered in your account. For more information, see RegisterType.

    \n
    • \n
  • \n

    Public extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.

    \n
    • \n
\n

For all other extension types, CloudFormation returns null.

" + "smithy.api#documentation": "

When the specified extension version was registered. This applies only to:

\n
    \n
  • \n

    Private extensions you have registered in your account. For more information, see RegisterType.

    \n
    • \n
  • \n

    Public extensions you have activated in your account with auto-update specified. For more\n information, see ActivateType.

    \n
    • \n
\n

For all other extension types, CloudFormation returns null.

" } }, "Description": { @@ -14587,43 +14587,43 @@ "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { - "smithy.api#documentation": "

The ID of the extension publisher, if the extension is published by a third party. Extensions published by\n Amazon don't return a publisher ID.

" + "smithy.api#documentation": "

The ID of the extension publisher, if the extension is published by a third party.\n Extensions published by Amazon don't return a publisher ID.

" } }, "OriginalTypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the type name of the public\n extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.

" + "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the type name of\n the public extension.

\n

If you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the account and\n Region, not the type name of the public extension. For more information, see Use\n aliases to refer to extensions in the CloudFormation User Guide.

" } }, "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region.

\n

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the version of\n the public extension to be used for CloudFormation operations in this account and Region.

\n

How you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.

" } }, "LatestPublicVersion": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the latest version of the public\n extension that is available. For any extensions other than activated third-arty extensions,\n CloudFormation returns null.

\n

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the latest\n version of the public extension that is available. For any extensions other\n than activated third-party extensions, CloudFormation returns null.

\n

How you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.

" } }, "PublisherIdentity": { "target": "com.amazonaws.cloudformation#IdentityProvider", "traits": { - "smithy.api#documentation": "

The service used to verify the publisher identity.

\n

For more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension Development.

" + "smithy.api#documentation": "

The service used to verify the publisher identity.

\n

For more information, see Publishing extensions to make\n them available for public use in the CloudFormation Command Line Interface (CLI) User Guide.

" } }, "PublisherName": { "target": "com.amazonaws.cloudformation#PublisherName", "traits": { - "smithy.api#documentation": "

The publisher name, as defined in the public profile for that publisher in the service used to verify the\n publisher identity.

" + "smithy.api#documentation": "

The publisher name, as defined in the public profile for that publisher in the service used\n to verify the publisher identity.

" } }, "IsActivated": { "target": "com.amazonaws.cloudformation#IsActivated", "traits": { - "smithy.api#documentation": "

Whether the extension is activated for this account and Region.

\n

This applies only to third-party public extensions. Extensions published by Amazon are activated by\n default.

" + "smithy.api#documentation": "

Whether the extension is activated for this account and Region.

\n

This applies only to third-party public extensions. Extensions published by Amazon are\n activated by default.

" } } }, @@ -14704,13 +14704,13 @@ "VersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it's registered.

" + "smithy.api#documentation": "

The ID of a specific version of the extension. The version ID is the value at the end of the\n Amazon Resource Name (ARN) assigned to the extension version when it's registered.

" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "

Whether the specified extension version is set as the default version.

\n

This applies only to private extensions you have registered in your account, and extensions published by Amazon.\n For public third-party extensions, CloudFormation returns null.

" + "smithy.api#documentation": "

Whether the specified extension version is set as the default version.

\n

This applies only to private extensions you have registered in your account, and extensions\n published by Amazon. For public third-party extensions, CloudFormation returns\n null.

" } }, "Arn": { @@ -14734,7 +14734,7 @@ "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-arty\n extensions, CloudFormation returns null.

\n

How you specified AutoUpdate when enabling the extension affects whether CloudFormation automatically\n updates the extension in this account and Region when a new version is released. For more information, see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.

" + "smithy.api#documentation": "

For public extensions that have been activated for this account and Region, the version of\n the public extension to be used for CloudFormation operations in this account and Region. For any\n extensions other than activated third-party extensions, CloudFormation returns\n null.

\n

How you specified AutoUpdate when enabling the extension affects whether\n CloudFormation automatically updates the extension in this account and Region when a new version is\n released. For more information, see Automatically use new versions of extensions in the\n CloudFormation User Guide.

" } } }, @@ -14768,51 +14768,51 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a generated template. This can be used to change the name, add and remove resources, refresh resources,\n and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of\n the update to the generated template using the DescribeGeneratedTemplate API action.

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

Updates a generated template. This can be used to change the name, add and remove\n resources, refresh resources, and change the DeletionPolicy and\n UpdateReplacePolicy settings. You can check the status of the update to the\n generated template using the DescribeGeneratedTemplate API action.

", "smithy.api#examples": [ { - "title": "To update a generated template's name", - "documentation": "This example updates a generated template with a new name.", + "title": "To add resources to a generated template", + "documentation": "This example adds resources to a generated template", "input": { "GeneratedTemplateName": "JazzyTemplate", - "NewGeneratedTemplateName": "JazzierTemplate" + "AddResources": [ + { + "ResourceType": "AWS::S3::Bucket", + "ResourceIdentifier": { + "BucketName": "jazz-bucket" + } + }, + { + "ResourceType": "AWS::EC2::DHCPOptions", + "ResourceIdentifier": { + "DhcpOptionsId": "random-id123" + } + } + ] }, "output": { "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca" } }, { - "title": "To remove resources from a generated template", - "documentation": "This example removes resources from a generated template", + "title": "To update a generated template's name", + "documentation": "This example updates a generated template with a new name.", "input": { "GeneratedTemplateName": "JazzyTemplate", - "RemoveResources": [ - "LogicalResourceId1", - "LogicalResourceId2" - ] + "NewGeneratedTemplateName": "JazzierTemplate" }, "output": { "GeneratedTemplateId": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/88f09db1-d211-4cb7-964b-434e2b8469ca" } }, { - "title": "To add resources to a generated template", - "documentation": "This example adds resources to a generated template", + "title": "To remove resources from a generated template", + "documentation": "This example removes resources from a generated template", "input": { "GeneratedTemplateName": "JazzyTemplate", - "AddResources": [ - { - "ResourceType": "AWS::S3::Bucket", - "ResourceIdentifier": { - "BucketName": "jazz-bucket" - } - }, - { - "ResourceType": "AWS::EC2::DHCPOptions", - "ResourceIdentifier": { - "DhcpOptionsId": "random-id123" - } - } + "RemoveResources": [ + "LogicalResourceId1", + "LogicalResourceId2" ] }, "output": { @@ -14854,13 +14854,13 @@ "RefreshAllResources": { "target": "com.amazonaws.cloudformation#RefreshAllResources", "traits": { - "smithy.api#documentation": "

If true, update the resource properties in the generated template with their current live state.\n This feature is useful when the resource properties in your generated a template does not reflect the live state of\n the resource properties. This happens when a user update the resource properties after generating a template.

" + "smithy.api#documentation": "

If true, update the resource properties in the generated template with their\n current live state. This feature is useful when the resource properties in your generated a\n template does not reflect the live state of the resource properties. This happens when a user\n update the resource properties after generating a template.

" } }, "TemplateConfiguration": { "target": "com.amazonaws.cloudformation#TemplateConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details of the generated template, including the DeletionPolicy and\n UpdateReplacePolicy.

" + "smithy.api#documentation": "

The configuration details of the generated template, including the\n DeletionPolicy and UpdateReplacePolicy.

" } } }, @@ -14874,7 +14874,7 @@ "GeneratedTemplateId": { "target": "com.amazonaws.cloudformation#GeneratedTemplateId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the generated template. The format is\n arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}.\n For example,\n arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc\n .

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

Updates a stack as specified in the template. After the call completes successfully, the stack update starts.\n You can check the status of the stack through the DescribeStacks action.

\n

To get a copy of the template for an existing stack, you can use the GetTemplate\n action.

\n

For more information about creating an update template, updating a stack, and monitoring the progress of the\n update, see Updating a Stack.

" + "smithy.api#documentation": "

Updates a stack as specified in the template. After the call completes successfully, the\n stack update starts. You can check the status of the stack through the DescribeStacks action.

\n

To get a copy of the template for an existing stack, you can use the GetTemplate action.

\n

For more information about updating a stack and monitoring the progress of the update, see\n Managing\n Amazon Web Services resources as a single unit with CloudFormation stacks in the\n CloudFormation User Guide.

" } }, "com.amazonaws.cloudformation#UpdateStackInput": { @@ -14916,85 +14916,85 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)

\n

Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

\n

Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that's\n located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must\n start with https://.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.

" } }, "UsePreviousTemplate": { "target": "com.amazonaws.cloudformation#UsePreviousTemplate", "traits": { - "smithy.api#documentation": "

Reuse the existing template that is associated with the stack that you are updating.

\n

Conditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Reuse the existing template that is associated with the stack that you are\n updating.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.

" } }, "StackPolicyDuringUpdateBody": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateBody", "traits": { - "smithy.api#documentation": "

Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.

\n

If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.

" + "smithy.api#documentation": "

Structure containing the temporary overriding stack policy body. You can specify either\n the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is associated\n with the stack will be used.

" } }, "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "

Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with\n https://. You can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.

" + "smithy.api#documentation": "

Location of a file containing the temporary overriding stack policy. The URL must point to\n a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. The\n location for an Amazon S3 bucket must start with https://. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is associated\n with the stack will be used.

" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.

" + "smithy.api#documentation": "

A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.

" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly\n acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.

    \n

    If you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.

    \n \n

    You should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.

    \n

    Each macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.

    \n     \n

    For more information, see Using CloudFormation Macros to Perform Custom Processing\n on Templates.

    \n
    • \n
\n \n

Only one of the Capabilities and ResourceType parameters can be specified.

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

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually updating the stack. If your stack template contains one or more macros,\n and you choose to update a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    \n

    If you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from the\n template using this capability.

    \n \n

    You should only update stacks directly from a stack template that contains macros if\n you know what processing the macro performs.

    \n

    Each macro relies on an underlying Lambda service function for processing stack\n templates. Be aware that the Lambda function owner can update the function operation\n without CloudFormation being notified.

    \n     \n

    For more information, see Perform custom processing\n on CloudFormation templates with template macros.

    \n
    • \n
\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n " } }, "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with for this update stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for\n CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

\n \n

Only one of the Capabilities and ResourceType parameters can be specified.

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

The template resource types that you have permissions to work with for this update stack\n action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource that you're updating, the stack\n update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this\n parameter for CloudFormation-specific condition keys in IAM policies. For more information, see\n Control access with Identity and Access Management.

\n \n

Only one of the Capabilities and ResourceType parameters can\n be specified.

\n " } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to\n update the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses\n this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role\n is available, CloudFormation uses a temporary session that is generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to update the\n stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always\n uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was previously associated with\n the stack. If no role is available, CloudFormation uses a temporary session that is generated from\n your user credentials.

" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the\n specified monitoring period afterwards.

" + "smithy.api#documentation": "

The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.

" } }, "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

\n

You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.

" + "smithy.api#documentation": "

Structure containing a new stack policy body. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.

\n

You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you don't specify a stack policy, the current policy\n that is associated with the stack is unchanged.

" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "

Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. The location for an Amazon S3 bucket must start with\n https://. You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

\n

You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.

" + "smithy.api#documentation": "

Location of a file containing the updated stack policy. The URL must point to a policy\n (max size: 16KB) located in an S3 bucket in the same Region as the stack. The location for an\n Amazon S3 bucket must start with https://. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.

\n

You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you don't specify a stack policy, the current policy\n that is associated with the stack is unchanged.

" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack.\n Specify an empty list to remove all notification topics.

" + "smithy.api#documentation": "

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation\n associates with the stack. Specify an empty list to remove all notification topics.

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

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported resources in the\n stack. You can specify a maximum number of 50 tags.

\n

If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value,\n CloudFormation removes all associated tags.

" + "smithy.api#documentation": "

Key-value pairs to associate with this stack. CloudFormation also propagates these tags to\n supported resources in the stack. You can specify a maximum number of 50 tags.

\n

If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you\n specify an empty value, CloudFormation removes all associated tags.

" } }, "DisableRollback": { @@ -15006,13 +15006,13 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n UpdateStack requests to ensure that CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

A unique identifier for this UpdateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to update a stack\n with the same name. You might retry UpdateStack requests to ensure that\n CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } }, "RetainExceptOnCreate": { "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", "traits": { - "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation rolls back. This includes\n newly created resources marked with a deletion policy of Retain.

\n

Default: false\n

" + "smithy.api#documentation": "

When set to true, newly created resources are deleted when the operation\n rolls back. This includes newly created resources marked with a deletion policy of\n Retain.

\n

Default: false\n

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

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.

\n

You can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to\n create additional stack instances, use CreateStackInstances.

\n

During stack set updates, any parameters overridden for a stack instance aren't updated, but retain their\n overridden value.

\n

You can only update the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template. If you add a parameter to a template, before you can override the parameter value specified in the stack\n set you must first use UpdateStackSet to update all stack\n instances with the updated template and parameter value specified in the stack set. Once a stack instance has been\n updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.

" + "smithy.api#documentation": "

Updates the parameter values for stack instances for the specified accounts, within the\n specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and\n Region.

\n

You can only update stack instances in Amazon Web Services Regions and accounts where they already\n exist; to create additional stack instances, use CreateStackInstances.

\n

During stack set updates, any parameters overridden for a stack instance aren't updated,\n but retain their overridden value.

\n

You can only update the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet\n to update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.

" } }, "com.amazonaws.cloudformation#UpdateStackInstancesInput": { @@ -15067,27 +15067,27 @@ "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update\n parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the\n specified accounts and Amazon Web Services Regions.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to\n update parameter values for stack instances. The overridden parameter values will be applied\n to all stack instances in the specified accounts and Amazon Web Services Regions.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts for which you want to update parameter values\n for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are\n currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future\n won't use the overridden values.

\n

You can specify Accounts or DeploymentTargets, but not both.

" + "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts for which you want to\n update parameter values for stack instances. If your update targets OUs, the overridden\n parameter values only apply to the accounts that are currently in the target OUs and their\n child OUs. Accounts added to the target OUs and their child OUs in the future won't use the\n overridden values.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" } }, "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the specified accounts and\n Amazon Web Services Regions.

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

The names of one or more Amazon Web Services Regions in which you want to update parameter values for\n stack instances. The overridden parameter values will be applied to all stack instances in the\n specified accounts and Amazon Web Services Regions.

", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of input parameters whose values you want to update for the specified stack instances.

\n

Any overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets parameter values\n during stack instance update operations:

\n
    \n
  • \n

    To override the current value for a parameter, include the parameter and specify its value.

    \n
    • \n
  • \n

    To leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)

    \n
    • \n
  • \n

    To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.

    \n
    • \n
  • \n

    To leave all parameters set to their present values, don't specify this property at all.

    \n
    • \n
\n

During stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.

\n

You can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter\n to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to\n update all stack instances with the updated template and parameter value specified in the stack set. Once a stack\n instance has been updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.

" + "smithy.api#documentation": "

A list of input parameters whose values you want to update for the specified stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the specified\n accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how\n CloudFormation sets parameter values during stack instance update operations:

\n
    \n
  • \n

    To override the current value for a parameter, include the parameter and specify its\n value.

    \n
    • \n
  • \n

    To leave an overridden parameter set to its present value, include the parameter and\n specify UsePreviousValue as true. (You can't specify both a\n value and set UsePreviousValue to true.)

    \n
    • \n
  • \n

    To set an overridden parameter back to the value specified in the stack set, specify a\n parameter list but don't include the parameter in the list.

    \n
    • \n
  • \n

    To leave all parameters set to their present values, don't specify this property at\n all.

    \n
    • \n
\n

During stack set updates, any parameter values overridden for a stack instance aren't\n updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in the\n stack set; to add or delete a parameter itself, use UpdateStackSet to update the\n stack set template. If you add a parameter to a template, before you can override the\n parameter value specified in the stack set you must first use UpdateStackSet\n to update all stack instances with the updated template and parameter value specified in the\n stack set. Once a stack instance has been updated with the new parameter, you can then\n override the parameter value using UpdateStackInstances.

" } }, "OperationPreferences": { @@ -15099,14 +15099,14 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.

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

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

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

Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.

\n

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above\n a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

" + "smithy.api#documentation": "

Updates the stack set, and associated stack instances in the specified accounts and\n Amazon Web Services Regions.

\n

Even if the stack set operation created by updating the stack set fails (completely or\n partially, below or above a specified failure tolerance), the stack set is updated with your\n changes. Subsequent CreateStackInstances calls on the specified stack set\n use the updated stack set.

" } }, "com.amazonaws.cloudformation#UpdateStackSetInput": { @@ -15195,19 +15195,19 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.

" + "smithy.api#documentation": "

The structure that contains the template body, with a minimum length of 1 byte and a\n maximum length of 51,200 bytes.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,\n see Template\n Anatomy in the CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.

" + "smithy.api#documentation": "

The location of the file that contains the template body. The URL must point to a template\n (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager\n document.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" } }, "UsePreviousTemplate": { "target": "com.amazonaws.cloudformation#UsePreviousTemplate", "traits": { - "smithy.api#documentation": "

Use the existing template that's associated with the stack set that you're updating.

\n

Conditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Use the existing template that's associated with the stack set that you're\n updating.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody or TemplateURL—or set\n UsePreviousTemplate to true.

" } }, "Parameters": { @@ -15219,13 +15219,13 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must explicitly\n acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.

    \n \n

    Stack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions,\n if you reference a macro in your template the stack set operation will fail.

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

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack set and its associated stack\n instances.

\n
    \n
  • \n

    \n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n

    \n

    Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.

    \n

    The following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    \n
      \n
    • \n

      If you have IAM resources, you can specify either capability.

      \n
      • \n
    • \n

      If you have IAM resources with custom names, you must\n specify CAPABILITY_NAMED_IAM.

      \n
      • \n
    • \n

      If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.

      \n
      • \n
    \n

    If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.

    \n \n

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    \n
    • \n
  • \n

    \n CAPABILITY_AUTO_EXPAND\n

    \n

    Some templates reference macros. If your stack set template references one or more\n macros, you must update the stack set directly from the processed template, without first\n reviewing the resulting changes in a change set. To update the stack set directly, you\n must acknowledge this capability. For more information, see Using CloudFormation Macros to\n Perform Custom Processing on Templates.

    \n \n

    Stack sets with service-managed permissions do not currently support the use of\n macros in templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if\n you specify this capability for a stack set with service-managed permissions, if you\n reference a macro in your template the stack set operation will fail.

    \n     \n
    • \n
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also propagates these\n tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

\n

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with\n this stack set. This means:

\n
    \n
  • \n

    If you don't specify this parameter, CloudFormation doesn't modify the stack's tags.

    \n
    • \n
  • \n

    If you specify any tags using this parameter, you must specify all\n the tags that you want associated with this stack set, even tags you've specified before (for example, when\n creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

    \n
    • \n
  • \n

    If you specify an empty value, CloudFormation removes all currently associated tags.

    \n
    • \n
\n

If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the\n required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from\n the list of tags you specify, CloudFormation assumes that you want to remove those tags from the stack set, and checks to see\n if you have permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the stack set is not\n updated.

" + "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in the stacks.\n You can specify a maximum number of 50 tags.

\n

If you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:

\n
    \n
  • \n

    If you don't specify this parameter, CloudFormation doesn't modify the stack's\n tags.

    \n
    • \n
  • \n

    If you specify any tags using this parameter, you must specify\n all the tags that you want associated with this stack set, even\n tags you've specified before (for example, when creating the stack set or during a\n previous update of the stack set.). Any tags that you don't include in the updated list of\n tags are removed from the stack set, and therefore from the stacks and resources as\n well.

    \n
    • \n
  • \n

    If you specify an empty value, CloudFormation removes all currently associated\n tags.

    \n
    • \n
\n

If you specify new tags as part of an UpdateStackSet action, CloudFormation\n checks to see if you have the required IAM permission to tag resources. If you omit tags\n that are currently associated with the stack set from the list of tags you specify, CloudFormation\n assumes that you want to remove those tags from the stack set, and checks to see if you have\n permission to untag resources. If you don't have the necessary permission(s), the entire\n UpdateStackSet action fails with an access denied error, and the\n stack set is not updated.

" } }, "OperationPreferences": { @@ -15237,62 +15237,62 @@ "AdministrationRoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control which users or groups can\n manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack\n Set Operations in the CloudFormation User Guide.

\n

If you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.

\n

Specify an IAM role only if you are using customized administrator roles to control\n which users or groups can manage specific stack sets within the same administrator account.\n For more information, see Granting Permissions for\n Stack Set Operations in the CloudFormation User Guide.

\n

If you specified a customized administrator role when you created the stack set, you must\n specify a customized administrator role, even if it is the same customized administrator role\n used with this stack set previously.

" } }, "ExecutionRoleName": { "target": "com.amazonaws.cloudformation#ExecutionRoleName", "traits": { - "smithy.api#documentation": "

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role,\n CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which stack resources users\n and groups can include in their stack sets.

\n

If you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a\n customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long\n as you have permissions to perform operations on the stack set.

" + "smithy.api#documentation": "

The name of the IAM execution role to use to update the stack set. If you do not specify\n an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole\n role for the stack set operation.

\n

Specify an IAM role only if you are using customized execution roles to control which\n stack resources users and groups can include in their stack sets.

\n

If you specify a customized execution role, CloudFormation uses that role to update the stack.\n If you do not specify a customized execution role, CloudFormation performs the update using the\n role previously associated with the stack set, so long as you have permissions to perform\n operations on the stack set.

" } }, "DeploymentTargets": { "target": "com.amazonaws.cloudformation#DeploymentTargets", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts in which to update associated stack\n instances.

\n

To update all the stack instances associated with this stack set, do not specify DeploymentTargets\n or Regions.

\n

If the stack set update includes changes to the template (that is, if TemplateBody or\n TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances with a\n status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the\n stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing\n stack instance status.

" + "smithy.api#documentation": "

[Service-managed permissions] The Organizations accounts in which to update\n associated stack instances.

\n

To update all the stack instances associated with this stack set, do not specify\n DeploymentTargets or Regions.

\n

If the stack set update includes changes to the template (that is, if\n TemplateBody or TemplateURL is specified), or the\n Parameters, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.

" } }, "PermissionModel": { "target": "com.amazonaws.cloudformation#PermissionModels", "traits": { - "smithy.api#documentation": "

Describes how the IAM roles required for stack set operations are created. You cannot modify\n PermissionModel if there are stack instances associated with your stack set.

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

Describes how the IAM roles required for stack set operations are created. You cannot\n modify PermissionModel if there are stack instances associated with your stack\n set.

\n " } }, "AutoDeployment": { "target": "com.amazonaws.cloudformation#AutoDeployment", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).

\n

If you specify AutoDeployment, don't specify DeploymentTargets or\n Regions.

" + "smithy.api#documentation": "

[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations accounts that are added to a target organization or organizational unit\n (OU).

\n

If you specify AutoDeployment, don't specify DeploymentTargets\n or Regions.

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

The unique ID for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set\n operation only once, even if you retry the request multiple times. You might retry stack set operation requests to\n ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, CloudFormation generates one automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.

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

The unique ID for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation\n performs the stack set operation only once, even if you retry the request multiple times. You\n might retry stack set operation requests to ensure that CloudFormation successfully received\n them.

\n

If you don't specify an operation ID, CloudFormation generates one\n automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,\n you must also specify the Amazon Web Services Regions in which to update stack set instances.

\n

To update all the stack instances associated with this stack set, don't specify the\n Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation\n updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack\n instances with their existing stack instance status.

" + "smithy.api#documentation": "

[Self-managed permissions] The accounts in which to update associated stack instances. If\n you specify accounts, you must also specify the Amazon Web Services Regions in which to update stack set\n instances.

\n

To update all the stack instances associated with this stack set,\n don't specify the Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Amazon Web Services Regions, while\n leaving all other stack instances with their existing stack instance status.

" } }, "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "

The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must\n also specify accounts in which to update stack set instances.

\n

To update all the stack instances associated with this stack set, do not specify the\n Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack\n instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack\n instance status.

" + "smithy.api#documentation": "

The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions,\n you must also specify accounts in which to update stack set instances.

\n

To update all the stack instances associated with this stack set, do\n not specify the Accounts or Regions properties.

\n

If the stack set update includes changes to the template (that is, if the\n TemplateBody or TemplateURL properties are specified), or the\n Parameters property, CloudFormation marks all stack instances with a status of\n OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters,\n CloudFormation updates the stack instances in the specified accounts and Regions, while leaving\n all other stack instances with their existing stack instance status.

" } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n
    \n
  • \n

    If you are signed in to the management account, specify\n SELF.

    \n
    • \n
  • \n

    If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.

    \n

    Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a\n delegated administrator in the CloudFormation User Guide.

    \n
    • \n
" } }, "ManagedExecution": { "target": "com.amazonaws.cloudformation#ManagedExecution", "traits": { - "smithy.api#documentation": "

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.

" + "smithy.api#documentation": "

Describes whether StackSets performs non-conflicting operations concurrently and queues\n conflicting operations.

" } } }, @@ -15323,7 +15323,7 @@ "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput" }, "traits": { - "smithy.api#documentation": "

Updates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.

\n

For nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.

" + "smithy.api#documentation": "

Updates termination protection for the specified stack. If a user attempts to delete a\n stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protect a CloudFormation\n stack from being deleted in the CloudFormation User Guide.

\n

For nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack.

" } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { @@ -15341,7 +15341,7 @@ "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name or unique ID of the stack for which you want to set termination protection.

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

The name or unique ID of the stack for which you want to set termination\n protection.

", "smithy.api#required": {} } } @@ -15382,7 +15382,7 @@ "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" }, "traits": { - "smithy.api#documentation": "

Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation\n checks if the template is valid YAML. If both these checks fail, CloudFormation returns a template validation\n error.

" + "smithy.api#documentation": "

Validates a specified template. CloudFormation first checks if the template is valid JSON. If\n it isn't, CloudFormation checks if the template is valid YAML. If both these checks fail,\n CloudFormation returns a template validation error.

" } }, "com.amazonaws.cloudformation#ValidateTemplateInput": { @@ -15391,13 +15391,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + "smithy.api#documentation": "

Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. The location\n for an Amazon S3 bucket must start with https://.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.

" } } }, @@ -15424,13 +15424,13 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

The capabilities found within the template. If your template contains IAM resources, you must specify the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or\n UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities\n error.

\n

For more information, see Acknowledging IAM Resources in\n CloudFormation Templates.

" + "smithy.api#documentation": "

The capabilities found within the template. If your template contains IAM resources, you\n must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template;\n otherwise, those actions return an InsufficientCapabilities error.

\n

For more information, see Acknowledging IAM resources in CloudFormation templates.

" } }, "CapabilitiesReason": { "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { - "smithy.api#documentation": "

The list of resources that generated the values in the Capabilities response element.

" + "smithy.api#documentation": "

The list of resources that generated the values in the Capabilities response\n element.

" } }, "DeclaredTransforms": { @@ -15491,7 +15491,7 @@ "Type": { "target": "com.amazonaws.cloudformation#WarningType", "traits": { - "smithy.api#documentation": "

The type of this warning. For more information, see IaC generator and write-only\n properties in the CloudFormation User Guide.

\n
    \n
  • \n

    \n MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties.\n The IaC generator selects one set of mutually exclusive properties and converts the included properties into\n parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the\n corresponding property can be replaced with other exclusive properties.

    \n
    • \n
  • \n

    \n UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of\n unsupported properties would be a required write-only property that is an array, because a parameter cannot be an\n array. Another example is an optional write-only property.

    \n
    • \n
  • \n

    \n MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are found in the resource,\n and the type of that property can be any of several types.

    \n
    • \n
\n \n

Currently the resource and property reference documentation does not indicate if a property uses a type of\n oneOf or anyOf. You need to look at the resource provider schema.

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

The type of this warning. For more information, see Resolve\n write-only properties in the CloudFormation User Guide.

\n
    \n
  • \n

    \n MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive\n write-only properties. The IaC generator selects one set of mutually exclusive properties and\n converts the included properties into parameters. The parameter names have a suffix\n OneOf and the parameter descriptions indicate that the corresponding property can\n be replaced with other exclusive properties.

    \n
    • \n
  • \n

    \n UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource.\n One example of unsupported properties would be a required write-only property that is an array,\n because a parameter cannot be an array. Another example is an optional write-only\n property.

    \n
    • \n
  • \n

    \n MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are\n found in the resource, and the type of that property can be any of several types.

    \n
    • \n
\n \n

Currently the resource and property reference documentation does not indicate if a property\n uses a type of oneOf or anyOf. You need to look at the resource\n provider schema.

\n " } }, "Properties": { @@ -15523,7 +15523,7 @@ "PropertyPath": { "target": "com.amazonaws.cloudformation#PropertyPath", "traits": { - "smithy.api#documentation": "

The path of the property. For example, if this is for the S3Bucket member of the Code\n property, the property path would be Code/S3Bucket.

" + "smithy.api#documentation": "

The path of the property. For example, if this is for the S3Bucket member of\n the Code property, the property path would be Code/S3Bucket.

" } }, "Required": { @@ -15572,7 +15572,7 @@ "UnrecognizedResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

A list of all of the unrecognized resource types. This is only returned if the\n TemplateSummaryConfig parameter has the TreatUnrecognizedResourceTypesAsWarning\n configuration set to True.

" + "smithy.api#documentation": "

A list of all of the unrecognized resource types. This is only returned if the\n TemplateSummaryConfig parameter has the\n TreatUnrecognizedResourceTypesAsWarning configuration set to\n True.

" } } }, diff --git a/codegen/sdk/aws-models/cloudtrail.json b/codegen/sdk/aws-models/cloudtrail.json index a14db05d24a..cb7e5725ad4 100644 --- a/codegen/sdk/aws-models/cloudtrail.json +++ b/codegen/sdk/aws-models/cloudtrail.json @@ -251,7 +251,7 @@ } }, "traits": { - "smithy.api#documentation": "

Advanced event selectors let you create fine-grained selectors for CloudTrail management and data events. They help you control costs by logging only those\n events that are important to you. For more information about advanced event selectors, see\n Logging management events and \n Logging data events in the CloudTrail User Guide.

\n

You cannot apply both event selectors and advanced event selectors to a trail.

\n

\n Supported CloudTrail event record fields for management events\n

\n
    \n
  • \n

    \n eventCategory (required)

    \n
    • \n
  • \n

    \n eventSource\n

    \n
    • \n
  • \n

    \n readOnly\n

    \n
    • \n
\n

\n Supported CloudTrail event record fields for data events\n

\n
    \n
  • \n

    \n eventCategory (required)

    \n
    • \n
  • \n

    \n resources.type (required)

    \n
    • \n
  • \n

    \n readOnly\n

    \n
    • \n
  • \n

    \n eventName\n

    \n
    • \n
  • \n

    \n resources.ARN\n

    \n
    • \n
\n \n

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

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

Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those\n events that are important to you. For more information about configuring advanced event selectors, see\n the Logging data events, Logging network activity events, and Logging management events topics in the CloudTrail User Guide.

\n

You cannot apply both event selectors and advanced event selectors to a trail.

\n

\n Supported CloudTrail event record fields for management events\n

\n
    \n
  • \n

    \n eventCategory (required)

    \n
    • \n
  • \n

    \n eventSource\n

    \n
    • \n
  • \n

    \n readOnly\n

    \n
    • \n
\n

\n Supported CloudTrail event record fields for data events\n

\n
    \n
  • \n

    \n eventCategory (required)

    \n
    • \n
  • \n

    \n resources.type (required)

    \n
    • \n
  • \n

    \n readOnly\n

    \n
    • \n
  • \n

    \n eventName\n

    \n
    • \n
  • \n

    \n resources.ARN\n

    \n
    • \n
\n

\n Supported CloudTrail event record fields for network activity events\n

\n \n

Network activity events is in preview release for CloudTrail and is subject to change.

\n \n
    \n
  • \n

    \n eventCategory (required)

    \n
    • \n
  • \n

    \n eventSource (required)

    \n
    • \n
  • \n

    \n eventName\n

    \n
    • \n
  • \n

    \n errorCode - The only valid value for errorCode is VpceAccessDenied.

    \n
    • \n
  • \n

    \n vpcEndpointId\n

    \n
    • \n
\n \n

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

\n " } }, "com.amazonaws.cloudtrail#AdvancedEventSelectors": { @@ -266,7 +266,7 @@ "Field": { "target": "com.amazonaws.cloudtrail#SelectorField", "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

\n

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

\n
    \n
  • \n

    \n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.

    \n
    • \n
  • \n

    \n \n eventSource\n - For filtering\n management events only. This can be set to NotEquals\n kms.amazonaws.com or NotEquals\n rdsdata.amazonaws.com.

    \n
    • \n
  • \n

    \n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.

    \n
    • \n
  • \n

    \n \n eventCategory\n - This is required and\n must be set to Equals. \n

    \n
      \n
    • \n

      \n For CloudTrail management events, the value\n must be Management. \n

      \n
      • \n
    • \n

      \n For CloudTrail data events, the value\n must be Data. \n

      \n
      • \n
    \n

    The following are used only for event data stores:

    \n
      \n
    • \n

      \n For CloudTrail Insights events, the value\n must be Insight. \n

      \n
      • \n
    • \n

      \n For Config\n configuration items, the value must be ConfigurationItem.\n

      \n
      • \n
    • \n

      \n For Audit Manager evidence, the value must be Evidence.\n

      \n
      • \n
    • \n

      \n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n

      \n
      • \n
    \n
    • \n
  • \n

    \n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:

    \n
      \n
    • \n

      \n AWS::DynamoDB::Table\n

      \n
      • \n
    • \n

      \n AWS::Lambda::Function\n

      \n
      • \n
    • \n

      \n AWS::S3::Object\n

      \n
      • \n
    • \n

      \n AWS::AppConfig::Configuration\n

      \n
      • \n
    • \n

      \n AWS::B2BI::Transformer\n

      \n
      • \n
    • \n

      \n AWS::Bedrock::AgentAlias\n

      \n
      • \n
    • \n

      \n AWS::Bedrock::KnowledgeBase\n

      \n
      • \n
    • \n

      \n AWS::Cassandra::Table\n

      \n
      • \n
    • \n

      \n AWS::CloudFront::KeyValueStore\n

      \n
      • \n
    • \n

      \n AWS::CloudTrail::Channel\n

      \n
      • \n
    • \n

      \n AWS::CodeWhisperer::Customization\n

      \n
      • \n
    • \n

      \n AWS::CodeWhisperer::Profile\n

      \n
      • \n
    • \n

      \n AWS::Cognito::IdentityPool\n

      \n
      • \n
    • \n

      \n AWS::DynamoDB::Stream\n

      \n
      • \n
    • \n

      \n AWS::EC2::Snapshot\n

      \n
      • \n
    • \n

      \n AWS::EMRWAL::Workspace\n

      \n
      • \n
    • \n

      \n AWS::FinSpace::Environment\n

      \n
      • \n
    • \n

      \n AWS::Glue::Table\n

      \n
      • \n
    • \n

      \n AWS::GreengrassV2::ComponentVersion\n

      \n
      • \n
    • \n

      \n AWS::GreengrassV2::Deployment\n

      \n
      • \n
    • \n

      \n AWS::GuardDuty::Detector\n

      \n
      • \n
    • \n

      \n AWS::IoT::Certificate\n

      \n
      • \n
    • \n

      \n AWS::IoT::Thing\n

      \n
      • \n
    • \n

      \n AWS::IoTSiteWise::Asset\n

      \n
      • \n
    • \n

      \n AWS::IoTSiteWise::TimeSeries\n

      \n
      • \n
    • \n

      \n AWS::IoTTwinMaker::Entity\n

      \n
      • \n
    • \n

      \n AWS::IoTTwinMaker::Workspace\n

      \n
      • \n
    • \n

      \n AWS::KendraRanking::ExecutionPlan\n

      \n
      • \n
    • \n

      \n AWS::KinesisVideo::Stream\n

      \n
      • \n
    • \n

      \n AWS::ManagedBlockchain::Network\n

      \n
      • \n
    • \n

      \n AWS::ManagedBlockchain::Node\n

      \n
      • \n
    • \n

      \n AWS::MedicalImaging::Datastore\n

      \n
      • \n
    • \n

      \n AWS::NeptuneGraph::Graph\n

      \n
      • \n
    • \n

      \n AWS::PCAConnectorAD::Connector\n

      \n
      • \n
    • \n

      \n AWS::QApps:QApp\n

      \n
      • \n
    • \n

      \n AWS::QBusiness::Application\n

      \n
      • \n
    • \n

      \n AWS::QBusiness::DataSource\n

      \n
      • \n
    • \n

      \n AWS::QBusiness::Index\n

      \n
      • \n
    • \n

      \n AWS::QBusiness::WebExperience\n

      \n
      • \n
    • \n

      \n AWS::RDS::DBCluster\n

      \n
      • \n
    • \n

      \n AWS::S3::AccessPoint\n

      \n
      • \n
    • \n

      \n AWS::S3ObjectLambda::AccessPoint\n

      \n
      • \n
    • \n

      \n AWS::S3Outposts::Object\n

      \n
      • \n
    • \n

      \n AWS::SageMaker::Endpoint\n

      \n
      • \n
    • \n

      \n AWS::SageMaker::ExperimentTrialComponent\n

      \n
      • \n
    • \n

      \n AWS::SageMaker::FeatureGroup\n

      \n
      • \n
    • \n

      \n AWS::ServiceDiscovery::Namespace \n

      \n
      • \n
    • \n

      \n AWS::ServiceDiscovery::Service\n

      \n
      • \n
    • \n

      \n AWS::SCN::Instance\n

      \n
      • \n
    • \n

      \n AWS::SNS::PlatformEndpoint\n

      \n
      • \n
    • \n

      \n AWS::SNS::Topic\n

      \n
      • \n
    • \n

      \n AWS::SQS::Queue\n

      \n
      • \n
    • \n

      \n AWS::SSM::ManagedNode\n

      \n
      • \n
    • \n

      \n AWS::SSMMessages::ControlChannel\n

      \n
      • \n
    • \n

      \n AWS::SWF::Domain\n

      \n
      • \n
    • \n

      \n AWS::ThinClient::Device\n

      \n
      • \n
    • \n

      \n AWS::ThinClient::Environment\n

      \n
      • \n
    • \n

      \n AWS::Timestream::Database\n

      \n
      • \n
    • \n

      \n AWS::Timestream::Table\n

      \n
      • \n
    • \n

      \n AWS::VerifiedPermissions::PolicyStore\n

      \n
      • \n
    • \n

      \n AWS::XRay::Trace\n

      \n
      • \n
    \n

    You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.

    \n
    • \n
  • \n

    \n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type.

    \n \n

    You can't use the resources.ARN field to filter resource types that do not have ARNs.

    \n     \n

    The resources.ARN field can be set one of the following.

    \n

    If resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.

    \n

    The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.

    \n
      \n
    • \n

      \n arn::s3:::/\n

      \n
      • \n
    • \n

      \n arn::s3::://\n

      \n
      • \n
    \n

    When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::dynamodb:::table/\n

      \n
      • \n
    \n

    When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::lambda:::function:\n

      \n
      • \n
    \n

    When resources.type equals AWS::AppConfig::Configuration, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::appconfig:::application//environment//configuration/\n

      \n
      • \n
    \n

    When resources.type equals AWS::B2BI::Transformer, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::b2bi:::transformer/\n

      \n
      • \n
    \n

    When resources.type equals AWS::Bedrock::AgentAlias, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::bedrock:::agent-alias//\n

      \n
      • \n
    \n

    When resources.type equals AWS::Bedrock::KnowledgeBase, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::bedrock:::knowledge-base/\n

      \n
      • \n
    \n

    When resources.type equals AWS::Cassandra::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cassandra:::/keyspace//table/\n

      \n
      • \n
    \n

    When resources.type equals AWS::CloudFront::KeyValueStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cloudfront:::key-value-store/\n

      \n
      • \n
    \n

    When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cloudtrail:::channel/\n

      \n
      • \n
    \n

    When resources.type equals AWS::CodeWhisperer::Customization, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::codewhisperer:::customization/\n

      \n
      • \n
    \n

    When resources.type equals AWS::CodeWhisperer::Profile, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::codewhisperer:::profile/\n

      \n
      • \n
    \n

    When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::cognito-identity:::identitypool/\n

      \n
      • \n
    \n

    When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::dynamodb:::table//stream/\n

      \n
      • \n
    \n

    When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::ec2:::snapshot/\n

      \n
      • \n
    \n

    When resources.type equals AWS::EMRWAL::Workspace, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::emrwal:::workspace/\n

      \n
      • \n
    \n

    When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::finspace:::environment/\n

      \n
      • \n
    \n

    When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::glue:::table//\n

      \n
      • \n
    \n

    When resources.type equals AWS::GreengrassV2::ComponentVersion, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::greengrass:::components/\n

      \n
      • \n
    \n

    When resources.type equals AWS::GreengrassV2::Deployment, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::greengrass:::deployments/\n

      \n
      • \n
    \n

    When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::guardduty:::detector/\n

      \n
      • \n
    \n

    When resources.type equals AWS::IoT::Certificate,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iot:::cert/\n

      \n
      • \n
    \n

    When resources.type equals AWS::IoT::Thing,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iot:::thing/\n

      \n
      • \n
    \n

    When resources.type equals AWS::IoTSiteWise::Asset,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iotsitewise:::asset/\n

      \n
      • \n
    \n

    When resources.type equals AWS::IoTSiteWise::TimeSeries,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iotsitewise:::timeseries/\n

      \n
      • \n
    \n

    When resources.type equals AWS::IoTTwinMaker::Entity,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iottwinmaker:::workspace//entity/\n

      \n
      • \n
    \n

    When resources.type equals AWS::IoTTwinMaker::Workspace,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::iottwinmaker:::workspace/\n

      \n
      • \n
    \n

    When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::kendra-ranking:::rescore-execution-plan/\n

      \n
      • \n
    \n

    When resources.type equals AWS::KinesisVideo::Stream, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:

    \n
      \n
    • \n

      \n arn::kinesisvideo:::stream//\n

      \n
      • \n
    \n

    When resources.type equals AWS::ManagedBlockchain::Network,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::managedblockchain:::networks/\n

      \n
      • \n
    \n

    When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::managedblockchain:::nodes/\n

      \n
      • \n
    \n

    When resources.type equals AWS::MedicalImaging::Datastore,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::medical-imaging:::datastore/\n

      \n
      • \n
    \n

    When resources.type equals AWS::NeptuneGraph::Graph,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::neptune-graph:::graph/\n

      \n
      • \n
    \n

    When resources.type equals AWS::PCAConnectorAD::Connector,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::pca-connector-ad:::connector/\n

      \n
      • \n
    \n

    When resources.type equals AWS::QApps:QApp,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qapps:::application//qapp/\n

      \n
      • \n
    \n

    When resources.type equals AWS::QBusiness::Application,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application/\n

      \n
      • \n
    \n

    When resources.type equals AWS::QBusiness::DataSource,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//index//data-source/\n

      \n
      • \n
    \n

    When resources.type equals AWS::QBusiness::Index,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//index/\n

      \n
      • \n
    \n

    When resources.type equals AWS::QBusiness::WebExperience,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::qbusiness:::application//web-experience/\n

      \n
      • \n
    \n

    When resources.type equals AWS::RDS::DBCluster,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::rds:::cluster/\n

      \n
      • \n
    \n

    When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.

    \n
      \n
    • \n

      \n arn::s3:::accesspoint/\n

      \n
      • \n
    • \n

      \n arn::s3:::accesspoint//object/\n

      \n
      • \n
    \n

    When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:

    \n
      \n
    • \n

      \n arn::s3-object-lambda:::accesspoint/\n

      \n
      • \n
    \n

    When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::s3-outposts:::\n

      \n
      • \n
    \n

    When resources.type equals AWS::SageMaker::Endpoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::endpoint/\n

      \n
      • \n
    \n

    When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::experiment-trial-component/\n

      \n
      • \n
    \n

    When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::sagemaker:::feature-group/\n

      \n
      • \n
    \n

    When resources.type equals AWS::SCN::Instance, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::scn:::instance/\n

      \n
      • \n
    \n

    When resources.type equals AWS::ServiceDiscovery::Namespace, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::servicediscovery:::namespace/\n

      \n
      • \n
    \n

    When resources.type equals AWS::ServiceDiscovery::Service, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:

    \n
      \n
    • \n

      \n arn::servicediscovery:::service/\n

      \n
      • \n
    \n

    When resources.type equals AWS::SNS::PlatformEndpoint,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sns:::endpoint///\n

      \n
      • \n
    \n

    When resources.type equals AWS::SNS::Topic,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sns:::\n

      \n
      • \n
    \n

    When resources.type equals AWS::SQS::Queue,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::sqs:::\n

      \n
      • \n
    \n

    When resources.type equals AWS::SSM::ManagedNode, and\n the operator is set to Equals or NotEquals, the ARN must be\n in one of the following formats:

    \n
      \n
    • \n

      \n arn::ssm:::managed-instance/\n

      \n
      • \n
    • \n

      \n arn::ec2:::instance/\n

      \n
      • \n
    \n

    When resources.type equals AWS::SSMMessages::ControlChannel, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::ssmmessages:::control-channel/\n

      \n
      • \n
    \n

    When resources.type equals AWS::SWF::Domain,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::swf:::domain/\n

      \n
      • \n
    \n

    When resources.type equals AWS::ThinClient::Device, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::thinclient:::device/\n

      \n
      • \n
    \n

    When resources.type equals AWS::ThinClient::Environment, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:

    \n
      \n
    • \n

      \n arn::thinclient:::environment/\n

      \n
      • \n
    \n

    When resources.type equals AWS::Timestream::Database,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::timestream:::database/\n

      \n
      • \n
    \n

    When resources.type equals AWS::Timestream::Table,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:

    \n
      \n
    • \n

      \n arn::timestream:::database//table/\n

      \n
      • \n
    \n

    When resources.type equals AWS::VerifiedPermissions::PolicyStore, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:

    \n
      \n
    • \n

      \n arn::verifiedpermissions:::policy-store/\n

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

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

\n

For CloudTrail management events, supported fields include eventCategory (required), eventSource, and readOnly.

\n

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

\n

For CloudTrail network activity events, supported fields include eventCategory (required), eventSource (required), eventName,\n errorCode, and vpcEndpointId.

\n

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

\n
    \n
  • \n

    \n \n readOnly\n - This is an optional field that is only used for management events and data events. This field can be set to\n Equals with a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.

    \n
    • \n
  • \n

    \n \n eventSource\n - This field is only used for management events and network activity events.

    \n

    For management events, this is an optional field that can be set to NotEquals\n kms.amazonaws.com to exclude KMS management events, or NotEquals\n rdsdata.amazonaws.com to exclude RDS management events.

    \n

    For network activity events, this is a required field that only uses the\n Equals operator. Set this field to the event source for which you want to\n log network activity events. If you want to log network activity events for multiple\n event sources, you must create a separate field selector for each event\n source.

    \n

    The following are valid values for network activity events:

    \n
      \n
    • \n

      \n cloudtrail.amazonaws.com\n

      \n
      • \n
    • \n

      \n ec2.amazonaws.com\n

      \n
      • \n
    • \n

      \n kms.amazonaws.com\n

      \n
      • \n
    • \n

      \n secretsmanager.amazonaws.com\n

      \n
      • \n
    \n
    • \n
  • \n

    \n \n eventName\n - This is an optional field that is only used for data events and network activity events. You can use any operator with \n eventName. You can use it to filter in or filter out specific events. You can have\n multiple values for this field, separated by commas.

    \n
    • \n
  • \n

    \n \n eventCategory\n - This field is required and\n must be set to Equals. \n

    \n
      \n
    • \n

      \n For CloudTrail management events, the value\n must be Management. \n

      \n
      • \n
    • \n

      \n For CloudTrail data events, the value\n must be Data. \n

      \n
      • \n
    • \n

      \n For CloudTrail network activity events, the value\n must be NetworkActivity. \n

      \n
      • \n
    \n

    The following are used only for event data stores:

    \n
      \n
    • \n

      \n For CloudTrail Insights events, the value\n must be Insight. \n

      \n
      • \n
    • \n

      \n For Config\n configuration items, the value must be ConfigurationItem.\n

      \n
      • \n
    • \n

      \n For Audit Manager evidence, the value must be Evidence.\n

      \n
      • \n
    • \n

      \n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n

      \n
      • \n
    \n
    • \n
  • \n

    \n \n errorCode\n - This field is only used to filter CloudTrail network activity events\n and is optional. This is the error code to filter on. Currently, the only valid errorCode is VpceAccessDenied. \n errorCode can only use the Equals operator.

    \n
    • \n
  • \n

    \n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator.

    \n

    The value can be one of the following:

    \n
      \n
    • \n

      \n AWS::AppConfig::Configuration\n

      \n
      • \n
    • \n

      \n AWS::B2BI::Transformer\n

      \n
      • \n
    • \n

      \n AWS::Bedrock::AgentAlias\n

      \n
      • \n
    • \n

      \n AWS::Bedrock::FlowAlias\n

      \n
      • \n
    • \n

      \n AWS::Bedrock::Guardrail\n

      \n
      • \n
    • \n

      \n AWS::Bedrock::KnowledgeBase\n

      \n
      • \n
    • \n

      \n AWS::Cassandra::Table\n

      \n
      • \n
    • \n

      \n AWS::CloudFront::KeyValueStore\n

      \n
      • \n
    • \n

      \n AWS::CloudTrail::Channel\n

      \n
      • \n
    • \n

      \n AWS::CloudWatch::Metric\n

      \n
      • \n
    • \n

      \n AWS::CodeWhisperer::Customization\n

      \n
      • \n
    • \n

      \n AWS::CodeWhisperer::Profile\n

      \n
      • \n
    • \n

      \n AWS::Cognito::IdentityPool\n

      \n
      • \n
    • \n

      \n AWS::DynamoDB::Stream\n

      \n
      • \n
    • \n

      \n AWS::DynamoDB::Table\n

      \n
      • \n
    • \n

      \n AWS::EC2::Snapshot\n

      \n
      • \n
    • \n

      \n AWS::EMRWAL::Workspace\n

      \n
      • \n
    • \n

      \n AWS::FinSpace::Environment\n

      \n
      • \n
    • \n

      \n AWS::Glue::Table\n

      \n
      • \n
    • \n

      \n AWS::GreengrassV2::ComponentVersion\n

      \n
      • \n
    • \n

      \n AWS::GreengrassV2::Deployment\n

      \n
      • \n
    • \n

      \n AWS::GuardDuty::Detector\n

      \n
      • \n
    • \n

      \n AWS::IoT::Certificate\n

      \n
      • \n
    • \n

      \n AWS::IoT::Thing\n

      \n
      • \n
    • \n

      \n AWS::IoTSiteWise::Asset\n

      \n
      • \n
    • \n

      \n AWS::IoTSiteWise::TimeSeries\n

      \n
      • \n
    • \n

      \n AWS::IoTTwinMaker::Entity\n

      \n
      • \n
    • \n

      \n AWS::IoTTwinMaker::Workspace\n

      \n
      • \n
    • \n

      \n AWS::KendraRanking::ExecutionPlan\n

      \n
      • \n
    • \n

      \n AWS::Kinesis::Stream\n

      \n
      • \n
    • \n

      \n AWS::Kinesis::StreamConsumer\n

      \n
      • \n
    • \n

      \n AWS::KinesisVideo::Stream\n

      \n
      • \n
    • \n

      \n AWS::Lambda::Function\n

      \n
      • \n
    • \n

      \n AWS::MachineLearning::MlModel\n

      \n
      • \n
    • \n

      \n AWS::ManagedBlockchain::Network\n

      \n
      • \n
    • \n

      \n AWS::ManagedBlockchain::Node\n

      \n
      • \n
    • \n

      \n AWS::MedicalImaging::Datastore\n

      \n
      • \n
    • \n

      \n AWS::NeptuneGraph::Graph\n

      \n
      • \n
    • \n

      \n AWS::One::UKey\n

      \n
      • \n
    • \n

      \n AWS::One::User\n

      \n
      • \n
    • \n

      \n AWS::PaymentCryptography::Alias\n

      \n
      • \n
    • \n

      \n AWS::PaymentCryptography::Key\n

      \n
      • \n
    • \n

      \n AWS::PCAConnectorAD::Connector\n

      \n
      • \n
    • \n

      \n AWS::PCAConnectorSCEP::Connector\n

      \n
      • \n
    • \n

      \n AWS::QApps:QApp\n

      \n
      • \n
    • \n

      \n AWS::QBusiness::Application\n

      \n
      • \n
    • \n

      \n AWS::QBusiness::DataSource\n

      \n
      • \n
    • \n

      \n AWS::QBusiness::Index\n

      \n
      • \n
    • \n

      \n AWS::QBusiness::WebExperience\n

      \n
      • \n
    • \n

      \n AWS::RDS::DBCluster\n

      \n
      • \n
    • \n

      \n AWS::RUM::AppMonitor\n

      \n
      • \n
    • \n

      \n AWS::S3::AccessPoint\n

      \n
      • \n
    • \n

      \n AWS::S3::Object\n

      \n
      • \n
    • \n

      \n AWS::S3Express::Object\n

      \n
      • \n
    • \n

      \n AWS::S3ObjectLambda::AccessPoint\n

      \n
      • \n
    • \n

      \n AWS::S3Outposts::Object\n

      \n
      • \n
    • \n

      \n AWS::SageMaker::Endpoint\n

      \n
      • \n
    • \n

      \n AWS::SageMaker::ExperimentTrialComponent\n

      \n
      • \n
    • \n

      \n AWS::SageMaker::FeatureGroup\n

      \n
      • \n
    • \n

      \n AWS::ServiceDiscovery::Namespace \n

      \n
      • \n
    • \n

      \n AWS::ServiceDiscovery::Service\n

      \n
      • \n
    • \n

      \n AWS::SCN::Instance\n

      \n
      • \n
    • \n

      \n AWS::SNS::PlatformEndpoint\n

      \n
      • \n
    • \n

      \n AWS::SNS::Topic\n

      \n
      • \n
    • \n

      \n AWS::SQS::Queue\n

      \n
      • \n
    • \n

      \n AWS::SSM::ManagedNode\n

      \n
      • \n
    • \n

      \n AWS::SSMMessages::ControlChannel\n

      \n
      • \n
    • \n

      \n AWS::StepFunctions::StateMachine\n

      \n
      • \n
    • \n

      \n AWS::SWF::Domain\n

      \n
      • \n
    • \n

      \n AWS::ThinClient::Device\n

      \n
      • \n
    • \n

      \n AWS::ThinClient::Environment\n

      \n
      • \n
    • \n

      \n AWS::Timestream::Database\n

      \n
      • \n
    • \n

      \n AWS::Timestream::Table\n

      \n
      • \n
    • \n

      \n AWS::VerifiedPermissions::PolicyStore\n

      \n
      • \n
    • \n

      \n AWS::XRay::Trace\n

      \n
      • \n
    \n

    You can have only one resources.type field per selector. To log events on more than one resource type, add another selector.

    \n
    • \n
  • \n

    \n \n resources.ARN\n - The resources.ARN is an optional field for \n data events. You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. To log all data events for all objects in a specific S3 bucket, \n use the StartsWith operator, and include only the bucket ARN as the matching value.

    \n

    For information about filtering data events on the resources.ARN field, see \n Filtering data \n events by resources.ARN in the CloudTrail User Guide.

    \n \n

    You can't use the resources.ARN field to filter resource types that do not have ARNs.

    \n     \n
    • \n
  • \n

    \n \n vpcEndpointId\n - This field is only used to filter CloudTrail network activity events\n and is optional. This field identifies the VPC endpoint that the request passed through. You can use any operator with vpcEndpointId.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -2551,12 +2551,12 @@ "Values": { "target": "com.amazonaws.cloudtrail#DataResourceValues", "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\n resource type.

\n
    \n
  • \n

    To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.

    \n \n

    This also enables logging of data event activity performed by any user or role\n in your Amazon Web Services account, even if that activity is performed on a bucket\n that belongs to another Amazon Web Services account.

    \n     \n
    • \n
  • \n

    To log data events for all objects in an S3 bucket, specify the bucket and an\n empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data\n events for all objects in this S3 bucket.

    \n
    • \n
  • \n

    To log data events for specific objects, specify the S3 bucket and object prefix\n such as arn:aws:s3:::bucket-1/example-images. The trail logs data events\n for objects in this S3 bucket that match the prefix.

    \n
    • \n
  • \n

    To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.

    \n \n

    This also enables logging of Invoke activity performed by any user\n or role in your Amazon Web Services account, even if that activity is performed on\n a function that belongs to another Amazon Web Services account.

    \n     \n
    • \n
  • \n

    To log data events for a specific Lambda function, specify the\n function ARN.

    \n \n

    Lambda function ARNs are exact. For example, if you specify a\n function ARN\n arn:aws:lambda:us-west-2:111111111111:function:helloworld,\n data events will only be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld.\n They will not be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld2.

    \n     \n
    • \n
  • \n

    To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.

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

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified\n resource type.

\n
    \n
  • \n

    To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3.

    \n \n

    This also enables logging of data event activity performed by any user or role\n in your Amazon Web Services account, even if that activity is performed on a bucket\n that belongs to another Amazon Web Services account.

    \n     \n
    • \n
  • \n

    To log data events for all objects in an S3 bucket, specify the bucket and an\n empty object prefix such as arn:aws:s3:::amzn-s3-demo-bucket1/. The trail logs data\n events for all objects in this S3 bucket.

    \n
    • \n
  • \n

    To log data events for specific objects, specify the S3 bucket and object prefix\n such as arn:aws:s3:::amzn-s3-demo-bucket1/example-images. The trail logs data events\n for objects in this S3 bucket that match the prefix.

    \n
    • \n
  • \n

    To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda.

    \n \n

    This also enables logging of Invoke activity performed by any user\n or role in your Amazon Web Services account, even if that activity is performed on\n a function that belongs to another Amazon Web Services account.

    \n     \n
    • \n
  • \n

    To log data events for a specific Lambda function, specify the\n function ARN.

    \n \n

    Lambda function ARNs are exact. For example, if you specify a\n function ARN\n arn:aws:lambda:us-west-2:111111111111:function:helloworld,\n data events will only be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld.\n They will not be logged for\n arn:aws:lambda:us-west-2:111111111111:function:helloworld2.

    \n     \n
    • \n
  • \n

    To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.

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

Data events provide information about the resource operations performed on or within a resource\n itself. These are also known as data plane operations. You can specify up to 250 data\n resources for a trail.

\n

Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.

\n

You can specify the following resource types in your event selectors for your trail:

\n
    \n
  • \n

    \n AWS::DynamoDB::Table\n

    \n
    • \n
  • \n

    \n AWS::Lambda::Function\n

    \n
    • \n
  • \n

    \n AWS::S3::Object\n

    \n
    • \n
\n \n

The total number of allowed data resources is 250. This number can be distributed\n between 1 and 5 event selectors, but the total cannot exceed 250 across all\n selectors for the trail.

\n

If you are using advanced event selectors, the maximum total number of values for\n all conditions, across all advanced event selectors for the trail, is 500.

\n \n

The following example demonstrates how logging works when you configure logging of all\n data events for an S3 bucket named bucket-1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read\n and Write data events.

\n
    \n
  1. \n

    A user uploads an image file to bucket-1.

    \n
    2. \n
  2. \n

    The PutObject API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    A user uploads an object to an Amazon S3 bucket named\n arn:aws:s3:::bucket-2.

    \n
    4. \n
  4. \n

    The PutObject API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn’t log\n the event.

    \n
    5. \n
\n

The following example demonstrates how logging works when you configure logging of\n Lambda data events for a Lambda function named\n MyLambdaFunction, but not for all Lambda\n functions.

\n
    \n
  1. \n

    A user runs a script that includes a call to the\n MyLambdaFunction function and the\n MyOtherLambdaFunction function.

    \n
    2. \n
  2. \n

    The Invoke API operation on MyLambdaFunction is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n MyLambdaFunction, any invocations of that function are\n logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    The Invoke API operation on\n MyOtherLambdaFunction is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for\n MyOtherLambdaFunction does not match the function specified\n for the trail. The trail doesn’t log the event.

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

You can configure the DataResource in an EventSelector to log data events for the following three resource types:

\n
    \n
  • \n

    \n AWS::DynamoDB::Table\n

    \n
    • \n
  • \n

    \n AWS::Lambda::Function\n

    \n
    • \n
  • \n

    \n AWS::S3::Object\n

    \n
    • \n
\n

To log data events for all other resource types including objects stored in \n directory buckets, you must use AdvancedEventSelectors. You must also \n use AdvancedEventSelectors if you want to filter on the eventName field.

\n

Configure the DataResource to specify the resource type and resource ARNs for which you want to log data events.

\n \n

The total number of allowed data resources is 250. This number can be distributed\n between 1 and 5 event selectors, but the total cannot exceed 250 across all\n selectors for the trail.

\n \n

The following example demonstrates how logging works when you configure logging of all\n data events for a general purpose bucket named amzn-s3-demo-bucket1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read\n and Write data events.

\n
    \n
  1. \n

    A user uploads an image file to amzn-s3-demo-bucket1.

    \n
    2. \n
  2. \n

    The PutObject API operation is an Amazon S3 object-level API.\n It is recorded as a data event in CloudTrail. Because the CloudTrail\n user specified an S3 bucket with an empty prefix, events that occur on any object in\n that bucket are logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    A user uploads an object to an Amazon S3 bucket named\n arn:aws:s3:::amzn-s3-demo-bucket1.

    \n
    4. \n
  4. \n

    The PutObject API operation occurred for an object in an S3 bucket\n that the CloudTrail user didn't specify for the trail. The trail doesn’t log\n the event.

    \n
    5. \n
\n

The following example demonstrates how logging works when you configure logging of\n Lambda data events for a Lambda function named\n MyLambdaFunction, but not for all Lambda\n functions.

\n
    \n
  1. \n

    A user runs a script that includes a call to the\n MyLambdaFunction function and the\n MyOtherLambdaFunction function.

    \n
    2. \n
  2. \n

    The Invoke API operation on MyLambdaFunction is\n an Lambda API. It is recorded as a data event in CloudTrail.\n Because the CloudTrail user specified logging data events for\n MyLambdaFunction, any invocations of that function are\n logged. The trail processes and logs the event.

    \n
    3. \n
  3. \n

    The Invoke API operation on\n MyOtherLambdaFunction is an Lambda API. Because\n the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for\n MyOtherLambdaFunction does not match the function specified\n for the trail. The trail doesn’t log the event.

    \n
    4. \n
" } }, "com.amazonaws.cloudtrail#DataResourceValues": { @@ -3867,7 +3867,7 @@ "DataResources": { "target": "com.amazonaws.cloudtrail#DataResources", "traits": { - "smithy.api#documentation": "

CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors.\n You can specify up to 250 resources for an individual event selector, but the total number\n of data resources cannot exceed 250 across all event selectors in a trail. This limit does\n not apply if you configure resource logging for all data events.

\n

For more information, see Data\n Events and Limits in CloudTrail in the CloudTrail User\n Guide.

" + "smithy.api#documentation": "

CloudTrail supports data event logging for Amazon S3 objects in standard S3 buckets, Lambda functions, and Amazon DynamoDB tables with basic event selectors.\n You can specify up to 250 resources for an individual event selector, but the total number\n of data resources cannot exceed 250 across all event selectors in a trail. This limit does\n not apply if you configure resource logging for all data events.

\n

For more information, see Data\n Events and Limits in CloudTrail in the CloudTrail User\n Guide.

\n \n

To log data events for all other resource types including objects stored in \n directory buckets, you must use AdvancedEventSelectors. You must also \n use AdvancedEventSelectors if you want to filter on the eventName field.

\n " } }, "ExcludeManagementEventSources": { @@ -4209,7 +4209,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the settings for the event selectors that you configured for your trail. The\n information returned for your event selectors includes the following:

\n
    \n
  • \n

    If your event selector includes read-only events, write-only events, or all\n events. This applies to both management events and data events.

    \n
    • \n
  • \n

    If your event selector includes management events.

    \n
    • \n
  • \n

    If your event selector includes data events, the resources on which you are\n logging data events.

    \n
    • \n
\n

For more information about logging management and data events, see the following topics\n in the CloudTrail User Guide:

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

Describes the settings for the event selectors that you configured for your trail. The\n information returned for your event selectors includes the following:

\n
    \n
  • \n

    If your event selector includes read-only events, write-only events, or all\n events. This applies to management events, data events, and network activity events.

    \n
    • \n
  • \n

    If your event selector includes management events.

    \n
    • \n
  • \n

    If your event selector includes network activity events, the event sources \n for which you are logging network activity events.

    \n
    • \n
  • \n

    If your event selector includes data events, the resources on which you are\n logging data events.

    \n
    • \n
\n

For more information about logging management, data, and network activity events, see the following topics\n in the CloudTrail User Guide:

\n ", "smithy.api#idempotent": {} } }, @@ -7366,7 +7366,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures an event selector or advanced event selectors for your trail. Use event\n selectors or advanced event selectors to specify management and data event settings for\n your trail. If you want your trail to log Insights events, be sure the event selector \n enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide.\n By default, trails created without specific event selectors are configured to\n log all read and write management events, and no data events.

\n

When an event occurs in your account, CloudTrail evaluates the event selectors or\n advanced event selectors in all trails. For each trail, if the event matches any event\n selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.

\n

Example

\n
    \n
  1. \n

    You create an event selector for a trail and specify that you want write-only\n events.

    \n
    2. \n
  2. \n

    The EC2 GetConsoleOutput and RunInstances API operations\n occur in your account.

    \n
    3. \n
  3. \n

    CloudTrail evaluates whether the events match your event selectors.

    \n
    4. \n
  4. \n

    The RunInstances is a write-only event and it matches your event\n selector. The trail logs the event.

    \n
    5. \n
  5. \n

    The GetConsoleOutput is a read-only event that doesn't match your\n event selector. The trail doesn't log the event.

    \n
    6. \n
\n

The PutEventSelectors operation must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.

\n

You can configure up to five event selectors for each trail. For more information, see\n Logging management events, Logging\n data events, and Quotas in CloudTrail in the CloudTrail User\n Guide.

\n

You can add advanced event selectors, and conditions for your advanced event selectors,\n up to a maximum of 500 values for all conditions and selectors on a trail. You can use\n either AdvancedEventSelectors or EventSelectors, but not both. If\n you apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events in the CloudTrail User Guide.

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

Configures event selectors (also referred to as basic event selectors) or advanced event selectors for your trail. You can use\n either AdvancedEventSelectors or EventSelectors, but not both. If\n you apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten.

\n

You can use AdvancedEventSelectors to \n log management events, data events for all resource types, and network activity events.

\n

You can use EventSelectors to log management events and data events for the following resource types:

\n
    \n
  • \n

    \n AWS::DynamoDB::Table\n

    \n
    • \n
  • \n

    \n AWS::Lambda::Function\n

    \n
    • \n
  • \n

    \n AWS::S3::Object\n

    \n
    • \n
\n

You can't use EventSelectors to log network activity events.

\n

If you want your trail to log Insights events, be sure the event selector or advanced event selector enables \n logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see Logging Insights events in the CloudTrail User Guide.\n By default, trails created without specific event selectors are configured to\n log all read and write management events, and no data events or network activity events.

\n

When an event occurs in your account, CloudTrail evaluates the event selectors or\n advanced event selectors in all trails. For each trail, if the event matches any event\n selector, the trail processes and logs the event. If the event doesn't match any event\n selector, the trail doesn't log the event.

\n

Example

\n
    \n
  1. \n

    You create an event selector for a trail and specify that you want to log write-only\n events.

    \n
    2. \n
  2. \n

    The EC2 GetConsoleOutput and RunInstances API operations\n occur in your account.

    \n
    3. \n
  3. \n

    CloudTrail evaluates whether the events match your event selectors.

    \n
    4. \n
  4. \n

    The RunInstances is a write-only event and it matches your event\n selector. The trail logs the event.

    \n
    5. \n
  5. \n

    The GetConsoleOutput is a read-only event that doesn't match your\n event selector. The trail doesn't log the event.

    \n
    6. \n
\n

The PutEventSelectors operation must be called from the Region in which the\n trail was created; otherwise, an InvalidHomeRegionException exception is\n thrown.

\n

You can configure up to five event selectors for each trail.

\n

You can add advanced event selectors, and conditions for your advanced event selectors,\n up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see\n Logging management events, Logging\n data events, Logging\n network activity events, and Quotas in CloudTrail in the CloudTrail User\n Guide.

", "smithy.api#idempotent": {} } }, @@ -7383,13 +7383,13 @@ "EventSelectors": { "target": "com.amazonaws.cloudtrail#EventSelectors", "traits": { - "smithy.api#documentation": "

Specifies the settings for your event selectors. You can configure up to five event\n selectors for a trail. You can use either EventSelectors or\n AdvancedEventSelectors in a PutEventSelectors request, but not\n both. If you apply EventSelectors to a trail, any existing\n AdvancedEventSelectors are overwritten.

" + "smithy.api#documentation": "

Specifies the settings for your event selectors. You can use event selectors to log management events and data events for the following resource types:

\n
    \n
  • \n

    \n AWS::DynamoDB::Table\n

    \n
    • \n
  • \n

    \n AWS::Lambda::Function\n

    \n
    • \n
  • \n

    \n AWS::S3::Object\n

    \n
    • \n
\n

You can't use event selectors to log network activity events.

\n

You can configure up to five event\n selectors for a trail. You can use either EventSelectors or\n AdvancedEventSelectors in a PutEventSelectors request, but not\n both. If you apply EventSelectors to a trail, any existing\n AdvancedEventSelectors are overwritten.

" } }, "AdvancedEventSelectors": { "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", "traits": { - "smithy.api#documentation": "

Specifies the settings for advanced event selectors. You can add advanced event\n selectors, and conditions for your advanced event selectors, up to a maximum of 500 values\n for all conditions and selectors on a trail. You can use either\n AdvancedEventSelectors or EventSelectors, but not both. If you\n apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events in the CloudTrail User Guide.

" + "smithy.api#documentation": "

Specifies the settings for advanced event selectors. You can use advanced event selectors to \n log management events, data events for all resource types, and network activity events.

\n

You can add advanced event\n selectors, and conditions for your advanced event selectors, up to a maximum of 500 values\n for all conditions and selectors on a trail. You can use either\n AdvancedEventSelectors or EventSelectors, but not both. If you\n apply AdvancedEventSelectors to a trail, any existing\n EventSelectors are overwritten. For more information about advanced event\n selectors, see Logging data events and \n Logging network activity events\n in the CloudTrail User Guide.

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

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION \n and the eventCategory must be Management, Data, or ConfigurationItem.

" + "smithy.api#documentation": "

Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.

" } }, "com.amazonaws.cloudtrail#StartEventDataStoreIngestionRequest": { @@ -8903,7 +8903,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED \n and the eventCategory must be Management, Data, or ConfigurationItem.

" + "smithy.api#documentation": "

Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED \n and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.

" } }, "com.amazonaws.cloudtrail#StopEventDataStoreIngestionRequest": { @@ -9621,7 +9621,7 @@ } ], "traits": { - "smithy.api#documentation": "

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

\n

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

\n

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

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

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

\n

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

\n

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

", "smithy.api#idempotent": {} } }, diff --git a/codegen/sdk/aws-models/codeartifact.json b/codegen/sdk/aws-models/codeartifact.json index 7605c3772af..487ad11dc47 100644 --- a/codegen/sdk/aws-models/codeartifact.json +++ b/codegen/sdk/aws-models/codeartifact.json @@ -3182,6 +3182,23 @@ "target": "com.amazonaws.codeartifact#DomainSummary" } }, + "com.amazonaws.codeartifact#EndpointType": { + "type": "enum", + "members": { + "DUALSTACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dualstack" + } + }, + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + } + } + }, "com.amazonaws.codeartifact#ErrorMessage": { "type": "string" }, @@ -3817,6 +3834,13 @@ "smithy.api#httpQuery": "format", "smithy.api#required": {} } + }, + "endpointType": { + "target": "com.amazonaws.codeartifact#EndpointType", + "traits": { + "smithy.api#documentation": "

A string that specifies the type of endpoint.

", + "smithy.api#httpQuery": "endpointType" + } } }, "traits": { @@ -6990,7 +7014,7 @@ "packageFormat": { "target": "com.amazonaws.codeartifact#PackageFormat", "traits": { - "smithy.api#documentation": "

\n The package format associated with a repository's external connection. The valid package formats are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

    \n
    • \n
  • \n

    \n nuget: A NuGet package.\n

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

\n The package format associated with a repository's external connection. The valid package formats are:\n

\n
    \n
  • \n

    \n npm: A Node Package Manager (npm) package.\n

    \n
    • \n
  • \n

    \n pypi: A Python Package Index (PyPI) package.\n

    \n
    • \n
  • \n

    \n maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.\n

    \n
    • \n
  • \n

    \n nuget: A NuGet package.\n

    \n
    • \n
  • \n

    \n generic: A generic package.\n

    \n
    • \n
  • \n

    \n ruby: A Ruby package.\n

    \n
    • \n
  • \n

    \n swift: A Swift package.\n

    \n
    • \n
  • \n

    \n cargo: A Cargo package.\n

    \n
    • \n
" } }, "status": { diff --git a/codegen/sdk/aws-models/codebuild.json b/codegen/sdk/aws-models/codebuild.json index fd1a144d349..9a44cf5d3b3 100644 --- a/codegen/sdk/aws-models/codebuild.json +++ b/codegen/sdk/aws-models/codebuild.json @@ -2902,6 +2902,12 @@ "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig" }, + "proxyConfiguration": { + "target": "com.amazonaws.codebuild#ProxyConfiguration", + "traits": { + "smithy.api#documentation": "

The proxy configuration of the compute fleet.

" + } + }, "imageId": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { @@ -4145,6 +4151,12 @@ "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig" }, + "proxyConfiguration": { + "target": "com.amazonaws.codebuild#ProxyConfiguration", + "traits": { + "smithy.api#documentation": "

The proxy configuration of the compute fleet.

" + } + }, "imageId": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { @@ -4262,6 +4274,110 @@ } } }, + "com.amazonaws.codebuild#FleetProxyRule": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.codebuild#FleetProxyRuleType", + "traits": { + "smithy.api#documentation": "

The type of proxy rule.

", + "smithy.api#required": {} + } + }, + "effect": { + "target": "com.amazonaws.codebuild#FleetProxyRuleEffectType", + "traits": { + "smithy.api#documentation": "

The behavior of the proxy rule.

", + "smithy.api#required": {} + } + }, + "entities": { + "target": "com.amazonaws.codebuild#FleetProxyRuleEntities", + "traits": { + "smithy.api#documentation": "

The destination of the proxy rule.

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

Information about the proxy rule for your reserved capacity instances.

" + } + }, + "com.amazonaws.codebuild#FleetProxyRuleBehavior": { + "type": "enum", + "members": { + "ALLOW_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW_ALL" + } + }, + "DENY_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY_ALL" + } + } + } + }, + "com.amazonaws.codebuild#FleetProxyRuleEffectType": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.codebuild#FleetProxyRuleEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.codebuild#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.codebuild#FleetProxyRuleType": { + "type": "enum", + "members": { + "DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN" + } + }, + "IP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP" + } + } + } + }, + "com.amazonaws.codebuild#FleetProxyRules": { + "type": "list", + "member": { + "target": "com.amazonaws.codebuild#FleetProxyRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.codebuild#FleetScalingMetricType": { "type": "enum", "members": { @@ -6565,6 +6681,26 @@ "target": "com.amazonaws.codebuild#Project" } }, + "com.amazonaws.codebuild#ProxyConfiguration": { + "type": "structure", + "members": { + "defaultBehavior": { + "target": "com.amazonaws.codebuild#FleetProxyRuleBehavior", + "traits": { + "smithy.api#documentation": "

The default behavior of outgoing traffic.

" + } + }, + "orderedProxyRules": { + "target": "com.amazonaws.codebuild#FleetProxyRules", + "traits": { + "smithy.api#documentation": "

An array of FleetProxyRule objects that represent the specified destination domains or IPs to allow or deny network access control to.

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

Information about the proxy configurations that apply network access control to your reserved capacity instances.

" + } + }, "com.amazonaws.codebuild#PutResourcePolicy": { "type": "operation", "input": { @@ -8579,6 +8715,12 @@ "vpcConfig": { "target": "com.amazonaws.codebuild#VpcConfig" }, + "proxyConfiguration": { + "target": "com.amazonaws.codebuild#ProxyConfiguration", + "traits": { + "smithy.api#documentation": "

The proxy configuration of the compute fleet.

" + } + }, "imageId": { "target": "com.amazonaws.codebuild#NonEmptyString", "traits": { @@ -9189,6 +9331,12 @@ "traits": { "smithy.api#enumValue": "RELEASE_NAME" } + }, + "REPOSITORY_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPOSITORY_NAME" + } } } }, diff --git a/codegen/sdk/aws-models/codepipeline.json b/codegen/sdk/aws-models/codepipeline.json index ba65ae53166..b82aaef79fe 100644 --- a/codegen/sdk/aws-models/codepipeline.json +++ b/codegen/sdk/aws-models/codepipeline.json @@ -250,6 +250,12 @@ "traits": { "smithy.api#enumValue": "Approval" } + }, + "Compute": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Compute" + } } } }, @@ -446,6 +452,12 @@ "smithy.api#documentation": "

The action's configuration. These are key-value pairs that specify input values for\n an action. For more information, see Action Structure Requirements in CodePipeline. For the list of\n configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation\n User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the\n CloudFormation User Guide.

\n

The values can be represented in either JSON or YAML format. For example, the JSON\n configuration item format is as follows:

\n

\n JSON:\n

\n

\n \"Configuration\" : { Key : Value },\n

" } }, + "commands": { + "target": "com.amazonaws.codepipeline#CommandList", + "traits": { + "smithy.api#documentation": "

The shell commands to run with your compute action in CodePipeline. All commands\n are supported except multi-line formats. While CodeBuild logs and permissions\n are used, you do not need to create any resources in CodeBuild.

\n \n

Using compute time for this action will incur separate charges in CodeBuild.

\n " + } + }, "outputArtifacts": { "target": "com.amazonaws.codepipeline#OutputArtifactList", "traits": { @@ -458,6 +470,12 @@ "smithy.api#documentation": "

The name or ID of the artifact consumed by the action, such as a test or build\n artifact.

" } }, + "outputVariables": { + "target": "com.amazonaws.codepipeline#OutputVariableList", + "traits": { + "smithy.api#documentation": "

The list of variables that are to be exported from the compute action. This is\n specifically CodeBuild environment variables as used for that action.

" + } + }, "roleArn": { "target": "com.amazonaws.codepipeline#RoleArn", "traits": { @@ -1916,7 +1934,7 @@ "name": "codepipeline" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "CodePipeline\n

\n Overview\n

\n

This is the CodePipeline API Reference. This guide provides descriptions\n of the actions and data types for CodePipeline. Some functionality for your\n pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.

\n

You can use the CodePipeline API to work with pipelines, stages, actions,\n and transitions.

\n

\n Pipelines are models of automated release processes. Each pipeline\n is uniquely named, and consists of stages, actions, and transitions.

\n

You can work with pipelines by calling:

\n
    \n
  • \n

    \n CreatePipeline, which creates a uniquely named\n pipeline.

    \n
    • \n
  • \n

    \n DeletePipeline, which deletes the specified\n pipeline.

    \n
    • \n
  • \n

    \n GetPipeline, which returns information about the pipeline\n structure and pipeline metadata, including the pipeline Amazon Resource Name\n (ARN).

    \n
    • \n
  • \n

    \n GetPipelineExecution, which returns information about a\n specific execution of a pipeline.

    \n
    • \n
  • \n

    \n GetPipelineState, which returns information about the current\n state of the stages and actions of a pipeline.

    \n
    • \n
  • \n

    \n ListActionExecutions, which returns action-level details\n for past executions. The details include full stage and action-level details,\n including individual action duration, status, any errors that occurred during\n the execution, and input and output artifact location details.

    \n
    • \n
  • \n

    \n ListPipelines, which gets a summary of all of the pipelines\n associated with your account.

    \n
    • \n
  • \n

    \n ListPipelineExecutions, which gets a summary of the most\n recent executions for a pipeline.

    \n
    • \n
  • \n

    \n StartPipelineExecution, which runs the most recent revision of\n an artifact through the pipeline.

    \n
    • \n
  • \n

    \n StopPipelineExecution, which stops the specified pipeline\n execution from continuing through the pipeline.

    \n
    • \n
  • \n

    \n UpdatePipeline, which updates a pipeline with edits or changes\n to the structure of the pipeline.

    \n
    • \n
\n

Pipelines include stages. Each stage contains one or more\n actions that must complete before the next stage begins. A stage results in success or\n failure. If a stage fails, the pipeline stops at that stage and remains stopped until\n either a new version of an artifact appears in the source location, or a user takes\n action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the\n status of stages in the pipeline, or GetPipeline, which returns the\n entire structure of the pipeline, including the stages of that pipeline. For more\n information about the structure of stages and actions, see CodePipeline\n Pipeline Structure Reference.

\n

Pipeline stages include actions that are categorized into\n categories such as source or build actions performed in a stage of a pipeline. For\n example, you can use a source action to import artifacts into a pipeline from a source\n such as Amazon S3. Like stages, you do not work with actions directly in most cases, but\n you do define and interact with actions when working with pipeline operations such as\n CreatePipeline and GetPipelineState. Valid\n action categories are:

\n
    \n
  • \n

    Source

    \n
    • \n
  • \n

    Build

    \n
    • \n
  • \n

    Test

    \n
    • \n
  • \n

    Deploy

    \n
    • \n
  • \n

    Approval

    \n
    • \n
  • \n

    Invoke

    \n
    • \n
\n

Pipelines also include transitions, which allow the transition\n of artifacts from one stage to the next in a pipeline after the actions in one stage\n complete.

\n

You can work with transitions by calling:

\n
    \n
  • \n

    \n DisableStageTransition, which prevents artifacts from\n transitioning to the next stage in a pipeline.

    \n
    • \n
  • \n

    \n EnableStageTransition, which enables transition of artifacts\n between stages in a pipeline.

    \n
    • \n
\n

\n Using the API to integrate with CodePipeline\n

\n

For third-party integrators or developers who want to create their own integrations\n with CodePipeline, the expected sequence varies from the standard API user. To\n integrate with CodePipeline, developers need to work with the following\n items:

\n

\n Jobs, which are instances of an action. For\n example, a job for a source action might import a revision of an artifact from a source.

\n

You can work with jobs by calling:

\n
    \n
  • \n

    \n AcknowledgeJob, which confirms whether a job worker has\n received the specified job.

    \n
    • \n
  • \n

    \n GetJobDetails, which returns the details of a job.

    \n
    • \n
  • \n

    \n PollForJobs, which determines whether there are any jobs to\n act on.

    \n
    • \n
  • \n

    \n PutJobFailureResult, which provides details of a job failure.\n

    \n
    • \n
  • \n

    \n PutJobSuccessResult, which provides details of a job\n success.

    \n
    • \n
\n

\n Third party jobs, which are instances of an action\n created by a partner action and integrated into CodePipeline. Partner actions are\n created by members of the Amazon Web Services Partner Network.

\n

You can work with third party jobs by calling:

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

\n Overview\n

\n

This is the CodePipeline API Reference. This guide provides descriptions\n of the actions and data types for CodePipeline. Some functionality for your\n pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.

\n

You can use the CodePipeline API to work with pipelines, stages, actions,\n and transitions.

\n

\n Pipelines are models of automated release processes. Each pipeline\n is uniquely named, and consists of stages, actions, and transitions.

\n

You can work with pipelines by calling:

\n
    \n
  • \n

    \n CreatePipeline, which creates a uniquely named\n pipeline.

    \n
    • \n
  • \n

    \n DeletePipeline, which deletes the specified\n pipeline.

    \n
    • \n
  • \n

    \n GetPipeline, which returns information about the pipeline\n structure and pipeline metadata, including the pipeline Amazon Resource Name\n (ARN).

    \n
    • \n
  • \n

    \n GetPipelineExecution, which returns information about a\n specific execution of a pipeline.

    \n
    • \n
  • \n

    \n GetPipelineState, which returns information about the current\n state of the stages and actions of a pipeline.

    \n
    • \n
  • \n

    \n ListActionExecutions, which returns action-level details\n for past executions. The details include full stage and action-level details,\n including individual action duration, status, any errors that occurred during\n the execution, and input and output artifact location details.

    \n
    • \n
  • \n

    \n ListPipelines, which gets a summary of all of the pipelines\n associated with your account.

    \n
    • \n
  • \n

    \n ListPipelineExecutions, which gets a summary of the most\n recent executions for a pipeline.

    \n
    • \n
  • \n

    \n StartPipelineExecution, which runs the most recent revision of\n an artifact through the pipeline.

    \n
    • \n
  • \n

    \n StopPipelineExecution, which stops the specified pipeline\n execution from continuing through the pipeline.

    \n
    • \n
  • \n

    \n UpdatePipeline, which updates a pipeline with edits or changes\n to the structure of the pipeline.

    \n
    • \n
\n

Pipelines include stages. Each stage contains one or more\n actions that must complete before the next stage begins. A stage results in success or\n failure. If a stage fails, the pipeline stops at that stage and remains stopped until\n either a new version of an artifact appears in the source location, or a user takes\n action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the\n status of stages in the pipeline, or GetPipeline, which returns the\n entire structure of the pipeline, including the stages of that pipeline. For more\n information about the structure of stages and actions, see CodePipeline\n Pipeline Structure Reference.

\n

Pipeline stages include actions that are categorized into\n categories such as source or build actions performed in a stage of a pipeline. For\n example, you can use a source action to import artifacts into a pipeline from a source\n such as Amazon S3. Like stages, you do not work with actions directly in most cases, but\n you do define and interact with actions when working with pipeline operations such as\n CreatePipeline and GetPipelineState. Valid\n action categories are:

\n
    \n
  • \n

    Source

    \n
    • \n
  • \n

    Build

    \n
    • \n
  • \n

    Test

    \n
    • \n
  • \n

    Deploy

    \n
    • \n
  • \n

    Approval

    \n
    • \n
  • \n

    Invoke

    \n
    • \n
  • \n

    Compute

    \n
    • \n
\n

Pipelines also include transitions, which allow the transition\n of artifacts from one stage to the next in a pipeline after the actions in one stage\n complete.

\n

You can work with transitions by calling:

\n
    \n
  • \n

    \n DisableStageTransition, which prevents artifacts from\n transitioning to the next stage in a pipeline.

    \n
    • \n
  • \n

    \n EnableStageTransition, which enables transition of artifacts\n between stages in a pipeline.

    \n
    • \n
\n

\n Using the API to integrate with CodePipeline\n

\n

For third-party integrators or developers who want to create their own integrations\n with CodePipeline, the expected sequence varies from the standard API user. To\n integrate with CodePipeline, developers need to work with the following\n items:

\n

\n Jobs, which are instances of an action. For\n example, a job for a source action might import a revision of an artifact from a source.

\n

You can work with jobs by calling:

\n
    \n
  • \n

    \n AcknowledgeJob, which confirms whether a job worker has\n received the specified job.

    \n
    • \n
  • \n

    \n GetJobDetails, which returns the details of a job.

    \n
    • \n
  • \n

    \n PollForJobs, which determines whether there are any jobs to\n act on.

    \n
    • \n
  • \n

    \n PutJobFailureResult, which provides details of a job failure.\n

    \n
    • \n
  • \n

    \n PutJobSuccessResult, which provides details of a job\n success.

    \n
    • \n
\n

\n Third party jobs, which are instances of an action\n created by a partner action and integrated into CodePipeline. Partner actions are\n created by members of the Amazon Web Services Partner Network.

\n

You can work with third party jobs by calling:

\n ", "smithy.api#title": "AWS CodePipeline", "smithy.api#xmlNamespace": { "uri": "http://codepipeline.amazonaws.com/doc/2015-07-09/" @@ -2863,6 +2881,27 @@ } } }, + "com.amazonaws.codepipeline#Command": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.codepipeline#CommandList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#Command" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.codepipeline#ConcurrentModificationException": { "type": "structure", "members": { @@ -2893,7 +2932,7 @@ "result": { "target": "com.amazonaws.codepipeline#Result", "traits": { - "smithy.api#documentation": "

The action to be done when the condition is met. For example, rolling back an execution for a failure condition.

" + "smithy.api#documentation": "

The action to be done when the condition is met. For example, rolling back an\n execution for a failure condition.

" } }, "rules": { @@ -2904,7 +2943,7 @@ } }, "traits": { - "smithy.api#documentation": "

The condition for the stage. A condition is made up of the rules and the result for the condition.

" + "smithy.api#documentation": "

The condition for the stage. A condition is made up of the rules and the result for\n the condition.

" } }, "com.amazonaws.codepipeline#ConditionExecution": { @@ -3840,6 +3879,12 @@ "smithy.api#documentation": "

The specified result for when the failure conditions are met, such as rolling back the\n stage.

" } }, + "retryConfiguration": { + "target": "com.amazonaws.codepipeline#RetryConfiguration", + "traits": { + "smithy.api#documentation": "

The retry configuration specifies automatic retry for a failed stage, along with the\n configured retry mode.

" + } + }, "conditions": { "target": "com.amazonaws.codepipeline#ConditionList", "traits": { @@ -3920,6 +3965,27 @@ } } }, + "com.amazonaws.codepipeline#FilePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.codepipeline#FilePathList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#FilePath" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.codepipeline#GetActionType": { "type": "operation", "input": { @@ -5454,7 +5520,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the rule executions that have occurred in a pipeline configured for conditions with rules.

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

Lists the rule executions that have occurred in a pipeline configured for conditions\n with rules.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -5488,7 +5554,7 @@ "nextToken": { "target": "com.amazonaws.codepipeline#NextToken", "traits": { - "smithy.api#documentation": "

The token that was returned from the previous ListRuleExecutions\n call, which can be used to return the next set of rule executions in the\n list.

" + "smithy.api#documentation": "

The token that was returned from the previous ListRuleExecutions call,\n which can be used to return the next set of rule executions in the list.

" } } }, @@ -5508,7 +5574,7 @@ "nextToken": { "target": "com.amazonaws.codepipeline#NextToken", "traits": { - "smithy.api#documentation": "

A token that can be used in the next ListRuleExecutions call. To\n view all items in the list, continue to call this operation with each subsequent token\n until no more nextToken values are returned.

" + "smithy.api#documentation": "

A token that can be used in the next ListRuleExecutions call. To view all\n items in the list, continue to call this operation with each subsequent token until no\n more nextToken values are returned.

" } } }, @@ -5894,6 +5960,12 @@ "smithy.api#documentation": "

The name of the output of an artifact, such as \"My App\".

\n

The input artifact of an action must exactly match the output artifact declared in\n a preceding action, but the input artifact does not have to be the next action in strict\n sequence from the action that provided the output artifact. Actions in parallel can\n declare different output artifacts, which are in turn consumed by different following\n actions.

\n

Output artifact names must be unique within a pipeline.

", "smithy.api#required": {} } + }, + "files": { + "target": "com.amazonaws.codepipeline#FilePathList", + "traits": { + "smithy.api#documentation": "

The files that you want to associate with the output artifact that will be exported\n from the compute action.

" + } } }, "traits": { @@ -5906,6 +5978,27 @@ "target": "com.amazonaws.codepipeline#OutputArtifact" } }, + "com.amazonaws.codepipeline#OutputVariable": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.codepipeline#OutputVariableList": { + "type": "list", + "member": { + "target": "com.amazonaws.codepipeline#OutputVariable" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + } + } + }, "com.amazonaws.codepipeline#OutputVariablesKey": { "type": "string", "traits": { @@ -5998,7 +6091,7 @@ "conditionType": { "target": "com.amazonaws.codepipeline#ConditionType", "traits": { - "smithy.api#documentation": "

The type of condition to override for the stage, such as entry conditions, failure conditions, or success conditions.

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

The type of condition to override for the stage, such as entry conditions, failure\n conditions, or success conditions.

", "smithy.api#required": {} } } @@ -7517,9 +7610,43 @@ "traits": { "smithy.api#enumValue": "FAIL" } + }, + "RETRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRY" + } + }, + "SKIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIP" + } } } }, + "com.amazonaws.codepipeline#RetryAttempt": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.codepipeline#RetryConfiguration": { + "type": "structure", + "members": { + "retryMode": { + "target": "com.amazonaws.codepipeline#StageRetryMode", + "traits": { + "smithy.api#documentation": "

The method that you want to configure for automatic stage retry on stage\n failure. You can specify to retry only failed action in the stage or all actions in the\n stage.

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

The retry configuration specifies automatic retry for a failed stage, along with the\n configured retry mode.

" + } + }, "com.amazonaws.codepipeline#RetryStageExecution": { "type": "operation", "input": { @@ -7607,6 +7734,49 @@ "smithy.api#output": {} } }, + "com.amazonaws.codepipeline#RetryStageMetadata": { + "type": "structure", + "members": { + "autoStageRetryAttempt": { + "target": "com.amazonaws.codepipeline#RetryAttempt", + "traits": { + "smithy.api#documentation": "

The number of attempts for a specific stage with automatic retry on stage failure. One attempt is allowed for automatic stage retry on failure.

" + } + }, + "manualStageRetryAttempt": { + "target": "com.amazonaws.codepipeline#RetryAttempt", + "traits": { + "smithy.api#documentation": "

The number of attempts for a specific stage where manual retries have been made upon stage failure.

" + } + }, + "latestRetryTrigger": { + "target": "com.amazonaws.codepipeline#RetryTrigger", + "traits": { + "smithy.api#documentation": "

The latest trigger for a specific stage where manual or automatic retries have been made upon stage failure.

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

The details of a specific automatic retry on stage failure, including the attempt number and trigger.

" + } + }, + "com.amazonaws.codepipeline#RetryTrigger": { + "type": "enum", + "members": { + "AutomatedStageRetry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutomatedStageRetry" + } + }, + "ManualStageRetry": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManualStageRetry" + } + } + } + }, "com.amazonaws.codepipeline#Revision": { "type": "string", "traits": { @@ -7796,7 +7966,7 @@ "target": "com.amazonaws.codepipeline#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the property can be queried.

\n

If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other\n restrictions. The value must be less than or equal to twenty (20) characters. The value\n can contain only alphanumeric characters, underscores, and hyphens.

" + "smithy.api#documentation": "

Indicates whether the property can be queried.

\n

If you create a pipeline with a condition and rule, and that rule contains a\n queryable property, the value for that configuration property is subject to other\n restrictions. The value must be less than or equal to twenty (20) characters. The value\n can contain only alphanumeric characters, underscores, and hyphens.

" } }, "description": { @@ -7866,14 +8036,14 @@ "name": { "target": "com.amazonaws.codepipeline#RuleName", "traits": { - "smithy.api#documentation": "

The name of the rule that is created for the condition, such as CheckAllResults.

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

The name of the rule that is created for the condition, such as\n CheckAllResults.

", "smithy.api#required": {} } }, "ruleTypeId": { "target": "com.amazonaws.codepipeline#RuleTypeId", "traits": { - "smithy.api#documentation": "

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

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

The ID for the rule type, which is made up of the combined values for category, owner,\n provider, and version.

", "smithy.api#required": {} } }, @@ -7886,7 +8056,7 @@ "inputArtifacts": { "target": "com.amazonaws.codepipeline#InputArtifactList", "traits": { - "smithy.api#documentation": "

The input artifacts fields for the rule, such as specifying an input file for the rule.

" + "smithy.api#documentation": "

The input artifacts fields for the rule, such as specifying an input file for the\n rule.

" } }, "roleArn": { @@ -7909,7 +8079,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage.

" + "smithy.api#documentation": "

Represents information about the rule to be created for an associated condition. An\n example would be creating a new rule for an entry condition, such as a rule that checks\n for a test result before allowing the run to enter the deployment stage.

" } }, "com.amazonaws.codepipeline#RuleDeclarationList": { @@ -7980,7 +8150,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents information about each time a rule is run as part of the pipeline execution for a pipeline configured with conditions.

" + "smithy.api#documentation": "

Represents information about each time a rule is run as part of the pipeline execution\n for a pipeline configured with conditions.

" } }, "com.amazonaws.codepipeline#RuleExecutionDetail": { @@ -8037,7 +8207,7 @@ "status": { "target": "com.amazonaws.codepipeline#RuleExecutionStatus", "traits": { - "smithy.api#documentation": "

The status of the rule execution. Status categories are InProgress,\n Succeeded, and Failed.\n

" + "smithy.api#documentation": "

The status of the rule execution. Status categories are InProgress,\n Succeeded, and Failed.

" } }, "input": { @@ -8054,7 +8224,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of the runs for a rule and the results produced on an artifact as it passes\n through stages in the pipeline.

" + "smithy.api#documentation": "

The details of the runs for a rule and the results produced on an artifact as it\n passes through stages in the pipeline.

" } }, "com.amazonaws.codepipeline#RuleExecutionDetailList": { @@ -8095,13 +8265,13 @@ "ruleTypeId": { "target": "com.amazonaws.codepipeline#RuleTypeId", "traits": { - "smithy.api#documentation": "

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

" + "smithy.api#documentation": "

The ID for the rule type, which is made up of the combined values for category, owner,\n provider, and version.

" } }, "configuration": { "target": "com.amazonaws.codepipeline#RuleConfigurationMap", "traits": { - "smithy.api#documentation": "

Configuration data for a rule execution, such as the resolved values for that run.

" + "smithy.api#documentation": "

Configuration data for a rule execution, such as the resolved values for that\n run.

" } }, "resolvedConfiguration": { @@ -8125,7 +8295,7 @@ "inputArtifacts": { "target": "com.amazonaws.codepipeline#ArtifactDetailList", "traits": { - "smithy.api#documentation": "

Details of input artifacts of the rule that correspond to the rule \n execution.

" + "smithy.api#documentation": "

Details of input artifacts of the rule that correspond to the rule execution.

" } } }, @@ -8139,12 +8309,12 @@ "executionResult": { "target": "com.amazonaws.codepipeline#RuleExecutionResult", "traits": { - "smithy.api#documentation": "

Execution result information listed in the output details for a rule\n execution.

" + "smithy.api#documentation": "

Execution result information listed in the output details for a rule execution.

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

Output details listed for a rule execution, such as the rule execution\n result.

" + "smithy.api#documentation": "

Output details listed for a rule execution, such as the rule execution result.

" } }, "com.amazonaws.codepipeline#RuleExecutionResult": { @@ -8252,21 +8422,21 @@ "revisionId": { "target": "com.amazonaws.codepipeline#Revision", "traits": { - "smithy.api#documentation": "

The system-generated unique ID that identifies the revision number of the\n rule.

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

The system-generated unique ID that identifies the revision number of the rule.

", "smithy.api#required": {} } }, "revisionChangeId": { "target": "com.amazonaws.codepipeline#RevisionChangeIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the change that set the state to this revision (for\n example, a deployment ID or timestamp).

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

The unique identifier of the change that set the state to this revision (for example,\n a deployment ID or timestamp).

", "smithy.api#required": {} } }, "created": { "target": "com.amazonaws.codepipeline#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time when the most recent version of the rule was created, in\n timestamp format.

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

The date and time when the most recent version of the rule was created, in timestamp\n format.

", "smithy.api#required": {} } } @@ -8299,7 +8469,7 @@ "entityUrl": { "target": "com.amazonaws.codepipeline#Url", "traits": { - "smithy.api#documentation": "

A URL link for more information about the state of the action, such as a details page.

" + "smithy.api#documentation": "

A URL link for more information about the state of the action, such as a details\n page.

" } }, "revisionUrl": { @@ -8310,7 +8480,7 @@ } }, "traits": { - "smithy.api#documentation": "

Returns information about the state of a rule.

\n \n

Values returned in the revisionId field indicate the rule revision information, such as the commit ID, for the current state.

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

Returns information about the state of a rule.

\n \n

Values returned in the revisionId field indicate the rule revision\n information, such as the commit ID, for the current state.

\n " } }, "com.amazonaws.codepipeline#RuleStateList": { @@ -8358,7 +8528,7 @@ } }, "traits": { - "smithy.api#documentation": "

The rule type, which is made up of the combined values for category, owner, provider, and version.

" + "smithy.api#documentation": "

The rule type, which is made up of the combined values for category, owner, provider,\n and version.

" } }, "com.amazonaws.codepipeline#RuleTypeId": { @@ -8367,14 +8537,14 @@ "category": { "target": "com.amazonaws.codepipeline#RuleCategory", "traits": { - "smithy.api#documentation": "

A category defines what kind of rule can be run in the stage, and constrains the provider\n type for the rule. The valid category is Rule.

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

A category defines what kind of rule can be run in the stage, and constrains the\n provider type for the rule. The valid category is Rule.

", "smithy.api#required": {} } }, "owner": { "target": "com.amazonaws.codepipeline#RuleOwner", "traits": { - "smithy.api#documentation": "

The creator of the rule being called. The valid value for the\n Owner field in the rule category is AWS.

" + "smithy.api#documentation": "

The creator of the rule being called. The valid value for the Owner field\n in the rule category is AWS.

" } }, "provider": { @@ -8392,7 +8562,7 @@ } }, "traits": { - "smithy.api#documentation": "

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

" + "smithy.api#documentation": "

The ID for the rule type, which is made up of the combined values for category, owner,\n provider, and version.

" } }, "com.amazonaws.codepipeline#RuleTypeList": { @@ -8407,7 +8577,7 @@ "thirdPartyConfigurationUrl": { "target": "com.amazonaws.codepipeline#Url", "traits": { - "smithy.api#documentation": "

The URL of a sign-up page where users can sign up for an external service and\n perform initial configuration of the action provided by that service.

" + "smithy.api#documentation": "

The URL of a sign-up page where users can sign up for an external service and perform\n initial configuration of the action provided by that service.

" } }, "entityUrlTemplate": { @@ -8585,7 +8755,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list that allows you to specify, or override, the source revision for a pipeline\n execution that's being started. A source revision is the version with all the changes to\n your application code, or source artifact, for the pipeline execution.

\n \n

For the S3_OBJECT_VERSION_ID and S3_OBJECT_KEY types of source revisions, either\n of the types can be used independently, or they can be used together to override the\n source with a specific ObjectKey and VersionID.

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

A list that allows you to specify, or override, the source revision for a pipeline\n execution that's being started. A source revision is the version with all the changes to\n your application code, or source artifact, for the pipeline execution.

\n \n

For the S3_OBJECT_VERSION_ID and S3_OBJECT_KEY types of\n source revisions, either of the types can be used independently, or they can be used\n together to override the source with a specific ObjectKey and VersionID.

\n " } }, "com.amazonaws.codepipeline#SourceRevisionOverrideList": { @@ -8727,13 +8897,13 @@ "onSuccess": { "target": "com.amazonaws.codepipeline#SuccessConditions", "traits": { - "smithy.api#documentation": "

The method to use when a stage has succeeded. For example,\n configuring this field for conditions will allow the stage to succeed when the conditions are met.

" + "smithy.api#documentation": "

The method to use when a stage has succeeded. For example, configuring this field for\n conditions will allow the stage to succeed when the conditions are met.

" } }, "beforeEntry": { "target": "com.amazonaws.codepipeline#BeforeEntryConditions", "traits": { - "smithy.api#documentation": "

The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

" + "smithy.api#documentation": "

The method to use when a stage allows entry. For example, configuring this field for\n conditions will allow entry to the stage when the conditions are met.

" } } }, @@ -8813,6 +8983,12 @@ "traits": { "smithy.api#enumValue": "Succeeded" } + }, + "Skipped": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Skipped" + } } } }, @@ -8926,6 +9102,12 @@ "traits": { "smithy.api#documentation": "

The state of the failure conditions for a stage.

" } + }, + "retryStageMetadata": { + "target": "com.amazonaws.codepipeline#RetryStageMetadata", + "traits": { + "smithy.api#documentation": "

he details of a specific automatic retry on stage failure, including the attempt number and trigger.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/connect.json b/codegen/sdk/aws-models/connect.json index eecb6ace4ec..2f5c1aea08e 100644 --- a/codegen/sdk/aws-models/connect.json +++ b/codegen/sdk/aws-models/connect.json @@ -1454,6 +1454,9 @@ { "target": "com.amazonaws.connect#StartContactStreaming" }, + { + "target": "com.amazonaws.connect#StartOutboundChatContact" + }, { "target": "com.amazonaws.connect#StartOutboundVoiceContact" }, @@ -2708,7 +2711,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates the specified dataset for a Amazon Connect instance with the target account.\n You can associate only one dataset in a single call.

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

Associates the specified dataset for a Amazon Connect instance with the target account.\n You can associate only one dataset in a single call.

", "smithy.api#http": { "method": "PUT", "uri": "/analytics-data/instance/{InstanceId}/association", @@ -4274,7 +4277,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Associates a list of analytics datasets for a given Amazon Connect instance to a target\n account. You can associate multiple datasets in a single call.

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

Associates a list of analytics datasets for a given Amazon Connect instance to a target\n account. You can associate multiple datasets in a single call.

", "smithy.api#http": { "method": "PUT", "uri": "/analytics-data/instance/{InstanceId}/associations", @@ -4357,7 +4360,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Removes a list of analytics datasets associated with a given Amazon Connect instance.\n You can disassociate multiple datasets in a single call.

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

Removes a list of analytics datasets associated with a given Amazon Connect instance.\n You can disassociate multiple datasets in a single call.

", "smithy.api#http": { "method": "POST", "uri": "/analytics-data/instance/{InstanceId}/associations", @@ -11304,7 +11307,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified contact.

\n \n

Contact information remains available in Amazon Connect for 24 months, and then it is\n deleted.

\n

Only data from November 12, 2021, and later is returned by this\n API.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified contact.

\n \n

Contact information remains available in Amazon Connect for 24 months from the\n InitiationTimestamp, and then it is deleted. Only contact information that is available in\n Amazon Connect is returned by this API

\n ", "smithy.api#http": { "method": "GET", "uri": "/contacts/{InstanceId}/{ContactId}", @@ -13124,7 +13127,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Removes the dataset ID associated with a given Amazon Connect instance.

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

Removes the dataset ID associated with a given Amazon Connect instance.

", "smithy.api#http": { "method": "POST", "uri": "/analytics-data/instance/{InstanceId}/association", @@ -14234,6 +14237,12 @@ "traits": { "smithy.api#enumValue": "CONTACT_FLOW" } + }, + "CONNECT_PHONENUMBER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECT_PHONENUMBER_ARN" + } } } }, @@ -16934,7 +16943,7 @@ "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "

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

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

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

\n

UI name: Abandonment rate\n

\n
\n
AGENT_ADHERENT_TIME
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Adherent time\n

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

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

\n

UI name: Agent answer rate\n

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Non-adherent time\n

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

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

\n

UI name: Agent\n non-response\n

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: Agent non-response without customer abandons\n

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

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

\n

UI name: Occupancy\n

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

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

\n

Unit: Percent

\n

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

\n

UI name: Adherence\n

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Scheduled time\n

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average queue abandon time\n

\n
\n
AVG_ACTIVE_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average active time\n

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

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

\n

UI name: Average after contact work time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

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

\n

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

\n

UI name: Average agent API connecting time\n

\n \n

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

\n \n
\n
AVG_AGENT_PAUSE_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average agent pause time\n

\n
\n
AVG_CASE_RELATED_CONTACTS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average contacts per case\n

\n
\n
AVG_CASE_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average case resolution time\n

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average contact duration\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average conversation duration\n

\n
\n
AVG_DIALS_PER_MINUTE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent, Queue, Routing Profile

\n

UI name: Average dials per minute\n

\n
\n
AVG_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Average flow time\n

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average agent greeting time\n

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average handle time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average customer hold time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average customer hold time all contacts\n

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

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

\n

UI name: Average holds\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average agent interaction and customer hold time\n

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

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

\n

UI name: Average agent interaction time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

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

\n

Unit: Count

\n

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

\n

UI name: Average agent interruptions\n

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average agent interruption time\n

\n
\n
AVG_NON_TALK_TIME
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average non-talk time\n

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average queue answer time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average resolution time\n

\n
\n
AVG_TALK_TIME
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average talk time\n

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average agent talk time\n

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average customer talk time\n

\n
\n
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Campaign

\n

UI name: Average wait time after customer connection\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent

\n

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

\n

UI name: Campaign contacts abandoned after X\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Percent

\n

Valid groupings and filters: Campaign, Agent

\n

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

\n

UI name: Campaign contacts abandoned after X rate\n

\n
\n
CASES_CREATED
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases created\n

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

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

\n

UI name: Contacts created\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: API contacts handled\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

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

\n

UI name: Contacts handled (connected to agent timestamp)\n

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts hold disconnect\n

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts hold agent disconnect\n

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts hold customer disconnect\n

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts put on hold\n

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts transferred out external\n

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

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

\n

UI name: Contacts transferred out internal\n

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts queued\n

\n
\n
CONTACTS_QUEUED_BY_ENQUEUE
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts queued (enqueue timestamp)\n

\n
\n
CONTACTS_REMOVED_FROM_QUEUE_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

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

\n

UI name: Contacts removed from queue in X seconds\n

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: Contacts resolved in X\n

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts transferred out\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts transferred out by agent\n

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts transferred out queue\n

\n
\n
CURRENT_CASES
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Current cases\n

\n
\n
DELIVERY_ATTEMPTS
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

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

\n

Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status,\n Disconnect Reason

\n

UI name: Delivery attempts\n

\n
\n
DELIVERY_ATTEMPT_DISPOSITION_RATE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns analytics, and\n with the answering machine detection enabled.

\n

Unit: Percent

\n

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

\n

Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason

\n \n

Answering Machine Detection Status and Disconnect Reason are valid filters but not valid\n groupings.

\n \n

UI name: Delivery attempt disposition rate\n

\n
\n
FLOWS_OUTCOME
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows outcome\n

\n
\n
FLOWS_STARTED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows started\n

\n
\n
HUMAN_ANSWERED_CALLS
\n
\n

This metric is available only for contacts analyzed by outbound campaigns analytics, and\n with the answering machine detection enabled.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent

\n

UI name: Human answered\n

\n
\n
MAX_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Maximum flow time\n

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Maximum queued time\n

\n
\n
MIN_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Minimum flow time\n

\n
\n
PERCENT_CASES_FIRST_CONTACT_RESOLVED
\n
\n

Unit: Percent

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved on first contact\n

\n
\n
PERCENT_CONTACTS_STEP_EXPIRED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_CONTACTS_STEP_JOINED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_FLOWS_OUTCOME
\n
\n

Unit: Percent

\n

Valid metric filter key: FLOWS_OUTCOME_TYPE\n

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows outcome percentage.

\n \n

The FLOWS_OUTCOME_TYPE is not a valid grouping.

\n \n
\n
PERCENT_NON_TALK_TIME
\n
\n

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

\n

Unit: Percentage

\n

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

\n

UI name: Non-talk\n time percent\n

\n
\n
PERCENT_TALK_TIME
\n
\n

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

\n

Unit: Percentage

\n

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

\n

UI name: Talk time\n percent\n

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

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

\n

Unit: Percentage

\n

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

\n

UI name: Agent\n talk time percent\n

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

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

\n

Unit: Percentage

\n

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

\n

UI name: Customer talk time percent\n

\n
\n
REOPENED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases reopened\n

\n
\n
RESOLVED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved\n

\n
\n
SERVICE_LEVEL
\n
\n

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

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

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

\n

UI name: Service level X\n

\n
\n
STEP_CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: After\n contact work time\n

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

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

\n

UI name: Agent API connecting time\n

\n \n

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

\n \n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Metric filter:

\n
    \n
  • \n

    Valid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n

    \n
    • \n
\n

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

\n

UI name: Contact abandoned\n

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: Contacts abandoned in X seconds\n

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: Contacts answered in X seconds\n

\n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Contact flow time\n

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Agent on contact time\n

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

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

\n

UI name: Contact disconnected\n

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Error status time\n

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Contact handle time\n

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

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

\n

UI name: Customer hold time\n

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Agent idle time\n

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Agent interaction and hold time\n

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Agent interaction time\n

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Non-Productive Time\n

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Online time\n

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

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

\n

UI name: Callback attempts\n

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

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

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

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

\n

UI name: Abandonment rate\n

\n
\n
AGENT_ADHERENT_TIME
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Adherent time\n

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

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

\n

UI name: Agent answer rate\n

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Non-adherent time\n

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

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

\n

UI name: Agent\n non-response\n

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: Agent non-response without customer abandons\n

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

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

\n

UI name: Occupancy\n

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

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

\n

Unit: Percent

\n

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

\n

UI name: Adherence\n

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Scheduled time\n

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average queue abandon time\n

\n
\n
AVG_ACTIVE_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average active time\n

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

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

\n

UI name: Average after contact work time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

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

\n

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

\n

UI name: Average agent API connecting time\n

\n \n

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

\n \n
\n
AVG_AGENT_PAUSE_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average agent pause time\n

\n
\n
AVG_CASE_RELATED_CONTACTS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average contacts per case\n

\n
\n
AVG_CASE_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average case resolution time\n

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average contact duration\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average conversation duration\n

\n
\n
AVG_DIALS_PER_MINUTE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent, Queue, Routing Profile

\n

UI name: Average dials per minute\n

\n
\n
AVG_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Average flow time\n

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average agent greeting time\n

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average handle time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average customer hold time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average customer hold time all contacts\n

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

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

\n

UI name: Average holds\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average agent interaction and customer hold time\n

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

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

\n

UI name: Average agent interaction time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

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

\n

Unit: Count

\n

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

\n

UI name: Average agent interruptions\n

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average agent interruption time\n

\n
\n
AVG_NON_TALK_TIME
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average non-talk time\n

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average queue answer time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Average resolution time\n

\n
\n
AVG_TALK_TIME
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average talk time\n

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average agent talk time\n

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

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

\n

Unit: Seconds

\n

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

\n

UI name: Average customer talk time\n

\n
\n
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Campaign

\n

UI name: Average wait time after customer connection\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent

\n

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

\n

UI name: Campaign contacts abandoned after X\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Percent

\n

Valid groupings and filters: Campaign, Agent

\n

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

\n

UI name: Campaign contacts abandoned after X rate\n

\n
\n
CASES_CREATED
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases created\n

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

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

\n

UI name: Contacts created\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: API contacts handled\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

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

\n

UI name: Contacts handled (connected to agent timestamp)\n

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts hold disconnect\n

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts hold agent disconnect\n

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts hold customer disconnect\n

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts put on hold\n

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts transferred out external\n

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

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

\n

UI name: Contacts transferred out internal\n

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts queued\n

\n
\n
CONTACTS_QUEUED_BY_ENQUEUE
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts queued (enqueue timestamp)\n

\n
\n
CONTACTS_REMOVED_FROM_QUEUE_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

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

\n

UI name: Contacts removed from queue in X seconds\n

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: Contacts resolved in X\n

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts transferred out\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts transferred out by agent\n

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

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

\n

UI name: Contacts transferred out queue\n

\n
\n
CURRENT_CASES
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Current cases\n

\n
\n
DELIVERY_ATTEMPTS
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

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

\n

Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status,\n Disconnect Reason

\n

UI name: Delivery attempts\n

\n
\n
DELIVERY_ATTEMPT_DISPOSITION_RATE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns analytics, and\n with the answering machine detection enabled.

\n

Unit: Percent

\n

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

\n

Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason

\n \n

Answering Machine Detection Status and Disconnect Reason are valid filters but not valid\n groupings.

\n \n

UI name: Delivery attempt disposition rate\n

\n
\n
FLOWS_OUTCOME
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows outcome\n

\n
\n
FLOWS_STARTED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows started\n

\n
\n
HUMAN_ANSWERED_CALLS
\n
\n

This metric is available only for contacts analyzed by outbound campaigns analytics, and\n with the answering machine detection enabled.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent

\n

UI name: Human answered\n

\n
\n
MAX_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Maximum flow time\n

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Maximum queued time\n

\n
\n
MIN_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Minimum flow time\n

\n
\n
PERCENT_CASES_FIRST_CONTACT_RESOLVED
\n
\n

Unit: Percent

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved on first contact\n

\n
\n
PERCENT_CONTACTS_STEP_EXPIRED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_CONTACTS_STEP_JOINED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_FLOWS_OUTCOME
\n
\n

Unit: Percent

\n

Valid metric filter key: FLOWS_OUTCOME_TYPE\n

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows outcome percentage.

\n \n

The FLOWS_OUTCOME_TYPE is not a valid grouping.

\n \n
\n
PERCENT_NON_TALK_TIME
\n
\n

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

\n

Unit: Percentage

\n

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

\n

UI name: Non-talk\n time percent\n

\n
\n
PERCENT_TALK_TIME
\n
\n

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

\n

Unit: Percentage

\n

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

\n

UI name: Talk time\n percent\n

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

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

\n

Unit: Percentage

\n

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

\n

UI name: Agent\n talk time percent\n

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

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

\n

Unit: Percentage

\n

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

\n

UI name: Customer talk time percent\n

\n
\n
REOPENED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases reopened\n

\n
\n
RESOLVED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved\n

\n
\n
SERVICE_LEVEL
\n
\n

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

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

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

\n

UI name: Service level X\n

\n
\n
STEP_CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: After\n contact work time\n

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

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

\n

UI name: Agent API connecting time\n

\n \n

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

\n \n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Metric filter:

\n
    \n
  • \n

    Valid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n

    \n
    • \n
\n

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

\n

UI name: Contact abandoned\n

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: Contacts abandoned in X seconds\n

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

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

\n

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

\n

UI name: Contacts answered in X seconds\n

\n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Contact flow time\n

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Agent on contact time\n

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

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

\n

UI name: Contact disconnected\n

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Error status time\n

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Contact handle time\n

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

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

\n

UI name: Customer hold time\n

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Agent idle time\n

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Agent interaction and hold time\n

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

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

\n

UI name: Agent interaction time\n

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Non-Productive Time\n

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

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

\n

UI name: Online time\n

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

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

\n

UI name: Callback attempts\n

\n
\n
", "smithy.api#required": {} } }, @@ -17362,7 +17371,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 3 + "max": 4 } } }, @@ -19599,7 +19608,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists the association status of requested dataset ID for a given Amazon Connect\n instance.

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

Lists the association status of requested dataset ID for a given Amazon Connect\n instance.

", "smithy.api#http": { "method": "GET", "uri": "/analytics-data/instance/{InstanceId}/association", @@ -24195,7 +24204,7 @@ "MetricFilterValues": { "target": "com.amazonaws.connect#MetricFilterValueList", "traits": { - "smithy.api#documentation": "

The values to use for filtering data.

\n

Valid metric filter values for INITIATION_METHOD: INBOUND |\n OUTBOUND | TRANSFER | QUEUE_TRANSFER |\n CALLBACK | API\n

\n

Valid metric filter values for DISCONNECT_REASON:\n CUSTOMER_DISCONNECT | AGENT_DISCONNECT |\n THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED |\n CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED |\n API\n

" + "smithy.api#documentation": "

The values to use for filtering data.

\n

Valid metric filter values for INITIATION_METHOD: INBOUND |\n OUTBOUND | TRANSFER | QUEUE_TRANSFER |\n CALLBACK | API | WEBRTC_API | MONITOR |\n DISCONNECT | EXTERNAL_OUTBOUND\n

\n

Valid metric filter values for DISCONNECT_REASON:\n CUSTOMER_DISCONNECT | AGENT_DISCONNECT |\n THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED |\n CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED |\n API\n

" } }, "Negate": { @@ -24744,7 +24753,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the property value used in automation of a numeric questions. Label values\n are associated with minimum and maximum values for the numeric question.

\n
    \n
  • \n

    Sentiment scores have a minimum value of -5 and maximum value of 5.

    \n
    • \n
  • \n

    Duration labels, such as NON_TALK_TIME, CONTACT_DURATION,\n AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value\n of 0 and maximum value of 28800.

    \n
    • \n
  • \n

    Percentages have a minimum value of 0 and maximum value of 100.

    \n
    • \n
  • \n

    \n NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of\n 1000.

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

Information about the property value used in automation of a numeric questions. Label values\n are associated with minimum and maximum values for the numeric question.

\n
    \n
  • \n

    Sentiment scores have a minimum value of -5 and maximum value of 5.

    \n
    • \n
  • \n

    Duration labels, such as NON_TALK_TIME, CONTACT_DURATION,\n AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value\n of 0 and maximum value of 63072000.

    \n
    • \n
  • \n

    Percentages have a minimum value of 0 and maximum value of 100.

    \n
    • \n
  • \n

    \n NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of\n 1000.

    \n
    • \n
" } }, "com.amazonaws.connect#OperatingSystem": { @@ -33666,6 +33675,138 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#StartOutboundChatContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartOutboundChatContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartOutboundChatContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#ConflictException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Initiates a new outbound SMS contact to a customer. Response of this API provides the\n ContactId of the outbound SMS contact created.

\n

\n SourceEndpoint only supports Endpoints with\n CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as\n Type. ContactFlowId initiates the flow to manage the new SMS\n contact created.

\n

This API can be used to initiate outbound SMS contacts for an agent or it can also deflect\n an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.

\n

For more information about using SMS in Amazon Connect, see the following topics in the\n Amazon Connect Administrator Guide:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/outbound-chat", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartOutboundChatContactRequest": { + "type": "structure", + "members": { + "SourceEndpoint": { + "target": "com.amazonaws.connect#Endpoint", + "traits": { + "smithy.api#required": {} + } + }, + "DestinationEndpoint": { + "target": "com.amazonaws.connect#Endpoint", + "traits": { + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the\n Amazon Resource Name (ARN) of the instance.

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

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

\n
    \n
  • \n

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

    \n
    • \n
  • \n

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

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

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

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

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect\n console user interface, on the navigation menu go to Routing, Contact\n Flows. Choose the flow. On the flow page, under the name of the flow, choose\n Show additional flow information. The ContactFlowId is the last\n part of the ARN, shown here in bold:

\n
    \n
  • \n

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx\n

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

The total duration of the newly started chat session. If not specified, the chat session\n duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum\n configurable time is 10,080 minutes (7 days).

" + } + }, + "ParticipantDetails": { + "target": "com.amazonaws.connect#ParticipantDetails" + }, + "InitialSystemMessage": { + "target": "com.amazonaws.connect#ChatMessage" + }, + "RelatedContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

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

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

The supported chat message content types. Supported types are:

\n
    \n
  • \n

    \n text/plain\n

    \n
    • \n
  • \n

    \n text/markdown\n

    \n
    • \n
  • \n

    \n application/json,\n application/vnd.amazonaws.connect.message.interactive\n

    \n
    • \n
  • \n

    \n application/vnd.amazonaws.connect.message.interactive.response\n

    \n
    • \n
\n

Content types must always contain text/plain. You can then put any other\n supported type in the list. For example, all the following lists are valid because they contain\n text/plain:

\n
    \n
  • \n

    \n [text/plain, text/markdown, application/json]\n

    \n
    • \n
  • \n

    \n [text/markdown, text/plain]\n

    \n
    • \n
  • \n

    \n [text/plain, application/json,\n application/vnd.amazonaws.connect.message.interactive.response]\n

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

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making\n retries safe with idempotent APIs. The token is valid for 7 days after creation. If a\n contact is already started, the contact ID is returned.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#StartOutboundChatContactResponse": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#StartOutboundVoiceContact": { "type": "operation", "input": { @@ -35445,7 +35586,7 @@ "Comparison": { "target": "com.amazonaws.connect#ResourceArnOrId", "traits": { - "smithy.api#documentation": "

The type of comparison. Only \"less than\" (LT) and \"greater than\" (GT) comparisons are\n supported.

" + "smithy.api#documentation": "

The type of comparison. Currently, \"less than\" (LT), \"less than equal\" (LTE), and \"greater\n than\" (GT) comparisons are supported.

" } }, "ThresholdValue": { diff --git a/codegen/sdk/aws-models/customer-profiles.json b/codegen/sdk/aws-models/customer-profiles.json index 47768919795..3c6672f0a15 100644 --- a/codegen/sdk/aws-models/customer-profiles.json +++ b/codegen/sdk/aws-models/customer-profiles.json @@ -1624,7 +1624,7 @@ "name": "profile" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Connect Customer Profiles\n

Amazon Connect Customer Profiles is a unified customer profile for your contact\n center that has pre-built connectors powered by AppFlow that make it easy to combine\n customer information from third party applications, such as Salesforce (CRM), ServiceNow\n (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.

\n

For more information about the Amazon Connect Customer Profiles feature, see Use Customer\n Profiles in the Amazon Connect Administrator's Guide.

", + "smithy.api#documentation": "Amazon Connect Customer Profiles\n \n

Amazon Connect Customer Profiles is a unified customer profile for your contact\n center that has pre-built connectors powered by AppFlow that make it easy to combine\n customer information from third party applications, such as Salesforce (CRM), ServiceNow\n (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.

\n

For more information about the Amazon Connect Customer Profiles feature, see Use Customer\n Profiles in the Amazon Connect Administrator's Guide.

", "smithy.api#title": "Amazon Connect Customer Profiles", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4524,6 +4524,12 @@ "traits": { "smithy.api#documentation": "

Boolean that shows if the Flow that's associated with the Integration is created in\n Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in\n flowDefinition.

" } + }, + "RoleArn": { + "target": "com.amazonaws.customerprofiles#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make\n Customer Profiles requests on your behalf.

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

Boolean that shows if the Flow that's associated with the Integration is created in\n Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in\n flowDefinition.

" } + }, + "RoleArn": { + "target": "com.amazonaws.customerprofiles#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make\n Customer Profiles requests on your behalf.

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

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

" } + }, + "RoleArn": { + "target": "com.amazonaws.customerprofiles#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make\n Customer Profiles requests on your behalf.

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

Boolean that shows if the Flow that's associated with the Integration is created in\n Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in\n flowDefinition.

" } + }, + "RoleArn": { + "target": "com.amazonaws.customerprofiles#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make\n Customer Profiles requests on your behalf.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/database-migration-service.json b/codegen/sdk/aws-models/database-migration-service.json index 99fe7b4985c..05e72af77b5 100644 --- a/codegen/sdk/aws-models/database-migration-service.json +++ b/codegen/sdk/aws-models/database-migration-service.json @@ -90,6 +90,9 @@ "target": "com.amazonaws.databasemigrationservice#AddTagsToResourceResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } @@ -161,6 +164,9 @@ { "target": "com.amazonaws.databasemigrationservice#CancelReplicationTaskAssessmentRun" }, + { + "target": "com.amazonaws.databasemigrationservice#CreateDataMigration" + }, { "target": "com.amazonaws.databasemigrationservice#CreateDataProvider" }, @@ -197,6 +203,9 @@ { "target": "com.amazonaws.databasemigrationservice#DeleteConnection" }, + { + "target": "com.amazonaws.databasemigrationservice#DeleteDataMigration" + }, { "target": "com.amazonaws.databasemigrationservice#DeleteDataProvider" }, @@ -248,6 +257,9 @@ { "target": "com.amazonaws.databasemigrationservice#DescribeConversionConfiguration" }, + { + "target": "com.amazonaws.databasemigrationservice#DescribeDataMigrations" + }, { "target": "com.amazonaws.databasemigrationservice#DescribeDataProviders" }, @@ -374,6 +386,9 @@ { "target": "com.amazonaws.databasemigrationservice#ModifyConversionConfiguration" }, + { + "target": "com.amazonaws.databasemigrationservice#ModifyDataMigration" + }, { "target": "com.amazonaws.databasemigrationservice#ModifyDataProvider" }, @@ -422,6 +437,9 @@ { "target": "com.amazonaws.databasemigrationservice#RunFleetAdvisorLsaAnalysis" }, + { + "target": "com.amazonaws.databasemigrationservice#StartDataMigration" + }, { "target": "com.amazonaws.databasemigrationservice#StartExtensionPackAssociation" }, @@ -455,6 +473,9 @@ { "target": "com.amazonaws.databasemigrationservice#StartReplicationTaskAssessmentRun" }, + { + "target": "com.amazonaws.databasemigrationservice#StopDataMigration" + }, { "target": "com.amazonaws.databasemigrationservice#StopReplication" }, @@ -2253,7 +2274,7 @@ "MinCapacityUnits": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS\n Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value\n allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU\n value that you can specify for DMS Serverless is 1. You don't have to specify a value for the\n MinCapacityUnits parameter. If you don't set this value, DMS scans the current activity\n of available source tables to identify an optimum setting for this parameter. If there is no current\n source activity or DMS can't otherwise identify a more appropriate value, it sets this parameter to\n the minimum DCU value allowed, 1.

" + "smithy.api#documentation": "

Specifies the minimum value of the DMS capacity units (DCUs) for which a given DMS\n Serverless replication can be provisioned. A single DCU is 2GB of RAM, with 1 DCU as the minimum value\n allowed. The list of valid DCU values includes 1, 2, 4, 8, 16, 32, 64, 128, 192, 256, and 384. So, the minimum DCU\n value that you can specify for DMS Serverless is 1. If you don't set this value, DMS sets this parameter to the \n minimum DCU value allowed, 1. If there is no current source activity, DMS scales down your replication until it \n reaches the value specified in MinCapacityUnits.

" } }, "MultiAZ": { @@ -2338,6 +2359,114 @@ } } }, + "com.amazonaws.databasemigrationservice#CreateDataMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#CreateDataMigrationMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#CreateDataMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidOperationFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a data migration using the provided settings.

" + } + }, + "com.amazonaws.databasemigrationservice#CreateDataMigrationMessage": { + "type": "structure", + "members": { + "DataMigrationName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

A user-friendly name for the data migration. Data migration names\n have the following constraints:

\n
    \n
  • \n

    Must begin with a letter, and can only contain ASCII letters,\n digits, and hyphens.

    \n
    • \n
  • \n

    Can't end with a hyphen or contain two consecutive hyphens.

    \n
    • \n
  • \n

    Length must be from 1 to 255 characters.

    \n
    • \n
" + } + }, + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

An identifier for the migration project.

", + "smithy.api#required": {} + } + }, + "DataMigrationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "traits": { + "smithy.api#documentation": "

Specifies if the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

", + "smithy.api#required": {} + } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the service access role that you want to use to\n create the data migration.

", + "smithy.api#required": {} + } + }, + "EnableCloudwatchLogs": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable CloudWatch logs for the data migration.

" + } + }, + "SourceDataSettings": { + "target": "com.amazonaws.databasemigrationservice#SourceDataSettings", + "traits": { + "smithy.api#documentation": "

Specifies information about the source data provider.

" + } + }, + "NumberOfJobs": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

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

One or more tags to be assigned to the data migration.

" + } + }, + "SelectionRules": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

An optional JSON string specifying what tables, views, and schemas\n to include or exclude from the migration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#CreateDataMigrationResponse": { + "type": "structure", + "members": { + "DataMigration": { + "target": "com.amazonaws.databasemigrationservice#DataMigration", + "traits": { + "smithy.api#documentation": "

Information about the created data migration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#CreateDataProvider": { "type": "operation", "input": { @@ -2350,6 +2479,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, @@ -2550,7 +2682,7 @@ "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\", \n \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\",\n \"db2\", \"db2-zos\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", \"neptune\", and \"babelfish\".

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

The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\", \n \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\",\n \"db2\", \"db2-zos\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", \"neptune\", \"babelfish\",\n redshift-serverless, aurora-serverless, aurora-postgresql-serverless,\n gcp-mysql, azure-sql-managed-instance, redis, dms-transfer.

", "smithy.api#required": {} } }, @@ -2987,6 +3119,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -3135,6 +3270,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceAlreadyExistsFault" }, @@ -3725,7 +3863,7 @@ "ReplicationSubnetGroupIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name for the replication subnet group. This value is stored as a lowercase\n string.

\n

Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces,\n underscores, or hyphens. Must not be \"default\".

\n

Example: mySubnetgroup\n

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

The name for the replication subnet group. This value is stored as a lowercase\n string.

\n

Constraints: Must contain no more than 255 alphanumeric characters, periods,\n underscores, or hyphens. Must not be \"default\".

\n

Example: mySubnetgroup\n

", "smithy.api#required": {} } }, @@ -3963,6 +4101,217 @@ } } }, + "com.amazonaws.databasemigrationservice#DataMigration": { + "type": "structure", + "members": { + "DataMigrationName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The user-friendly name for the data migration.

" + } + }, + "DataMigrationArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies this replication.

" + } + }, + "DataMigrationCreateTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The UTC time when DMS created the data migration.

" + } + }, + "DataMigrationStartTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The UTC time when DMS started the data migration.

" + } + }, + "DataMigrationEndTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The UTC time when data migration ended.

" + } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The IAM role that the data migration uses to access Amazon Web Services resources.

" + } + }, + "MigrationProjectArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data migration's associated migration project.

" + } + }, + "DataMigrationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "traits": { + "smithy.api#documentation": "

Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

" + } + }, + "DataMigrationSettings": { + "target": "com.amazonaws.databasemigrationservice#DataMigrationSettings", + "traits": { + "smithy.api#documentation": "

Specifies CloudWatch settings and selection rules for the data migration.

" + } + }, + "SourceDataSettings": { + "target": "com.amazonaws.databasemigrationservice#SourceDataSettings", + "traits": { + "smithy.api#documentation": "

Specifies information about the data migration's source data provider.

" + } + }, + "DataMigrationStatistics": { + "target": "com.amazonaws.databasemigrationservice#DataMigrationStatistics", + "traits": { + "smithy.api#documentation": "

Provides information about the data migration's run, including start and stop time, latency, and data migration progress.

" + } + }, + "DataMigrationStatus": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The current status of the data migration.

" + } + }, + "PublicIpAddresses": { + "target": "com.amazonaws.databasemigrationservice#PublicIpAddressList", + "traits": { + "smithy.api#documentation": "

The IP addresses of the endpoints for the data migration.

" + } + }, + "DataMigrationCidrBlocks": { + "target": "com.amazonaws.databasemigrationservice#DataMigrationCidrBlock", + "traits": { + "smithy.api#documentation": "

The CIDR blocks of the endpoints for the data migration.

" + } + }, + "LastFailureMessage": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Information about the data migration's most recent error or failure.

" + } + }, + "StopReason": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The reason the data migration last stopped.

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

This object provides information about a DMS data migration.

" + } + }, + "com.amazonaws.databasemigrationservice#DataMigrationCidrBlock": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String" + } + }, + "com.amazonaws.databasemigrationservice#DataMigrationSettings": { + "type": "structure", + "members": { + "NumberOfJobs": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

" + } + }, + "CloudwatchLogsEnabled": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether to enable CloudWatch logging for the data migration.

" + } + }, + "SelectionRules": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

A JSON-formatted string that defines what objects to include and exclude from the migration.

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

Options for configuring a data migration, including whether to enable CloudWatch logs,\n and the selection rules to use to include or exclude database objects from the migration.

" + } + }, + "com.amazonaws.databasemigrationservice#DataMigrationStatistics": { + "type": "structure", + "members": { + "TablesLoaded": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of tables loaded in the current data migration run.

" + } + }, + "ElapsedTimeMillis": { + "target": "com.amazonaws.databasemigrationservice#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The elapsed duration of the data migration run.

" + } + }, + "TablesLoading": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The data migration's table loading progress.

" + } + }, + "FullLoadPercentage": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The data migration's progress in the full-load migration phase.

" + } + }, + "CDCLatency": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The current latency of the change data capture (CDC) operation.

" + } + }, + "TablesQueued": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of tables that are waiting for processing.

" + } + }, + "TablesErrored": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of tables that DMS failed to process.

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

The time when the migration started.

" + } + }, + "StopTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The time when the migration stopped or failed.

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

Information about the data migration run, including start and stop time, latency, and migration progress.

" + } + }, + "com.amazonaws.databasemigrationservice#DataMigrations": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#DataMigration" + } + }, "com.amazonaws.databasemigrationservice#DataProvider": { "type": "structure", "members": { @@ -4508,6 +4857,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#DeleteDataMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DeleteDataMigrationMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DeleteDataMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified data migration.

" + } + }, + "com.amazonaws.databasemigrationservice#DeleteDataMigrationMessage": { + "type": "structure", + "members": { + "DataMigrationIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The identifier (name or ARN) of the data migration to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DeleteDataMigrationResponse": { + "type": "structure", + "members": { + "DataMigration": { + "target": "com.amazonaws.databasemigrationservice#DataMigration", + "traits": { + "smithy.api#documentation": "

The deleted data migration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#DeleteDataProvider": { "type": "operation", "input": { @@ -4520,6 +4921,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -4718,6 +5122,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, { "target": "com.amazonaws.databasemigrationservice#CollectorNotFoundFault" }, @@ -4738,6 +5145,9 @@ "target": "com.amazonaws.databasemigrationservice#DeleteFleetAdvisorDatabasesResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidOperationFault" }, @@ -4790,6 +5200,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -4865,6 +5278,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -5741,6 +6157,93 @@ "smithy.api#output": {} } }, + "com.amazonaws.databasemigrationservice#DescribeDataMigrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#DescribeDataMigrationsMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#DescribeDataMigrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about data migrations.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DataMigrations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.databasemigrationservice#DescribeDataMigrationsMessage": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.databasemigrationservice#FilterList", + "traits": { + "smithy.api#documentation": "

Filters applied to the data migrations.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified \n MaxRecords value, a pagination token called a marker is included in the response so that \n the remaining results can be retrieved.

" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#Marker", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "WithoutSettings": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

An option to set to avoid returning information about settings. Use this to reduce\n overhead when setting information is too large. To use this option, choose\n true; otherwise, choose false (the default).

" + } + }, + "WithoutStatistics": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

An option to set to avoid returning information about statistics. Use this to reduce\n overhead when statistics information is too large. To use this option, choose\n true; otherwise, choose false (the default).

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#DescribeDataMigrationsResponse": { + "type": "structure", + "members": { + "DataMigrations": { + "target": "com.amazonaws.databasemigrationservice#DataMigrations", + "traits": { + "smithy.api#documentation": "

Returns information about the data migrations used in the project.

" + } + }, + "Marker": { + "target": "com.amazonaws.databasemigrationservice#Marker", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, \n the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#DescribeDataProviders": { "type": "operation", "input": { @@ -5753,6 +6256,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } @@ -6868,6 +7374,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } @@ -7491,6 +8000,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } @@ -10356,6 +10868,18 @@ "smithy.api#documentation": "

Provides information about a metadata model assessment exported to SQL.

" } }, + "com.amazonaws.databasemigrationservice#FailedDependencyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.databasemigrationservice#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "

A dependency threw an exception.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.databasemigrationservice#Filter": { "type": "structure", "members": { @@ -11349,6 +11873,9 @@ "target": "com.amazonaws.databasemigrationservice#ListTagsForResourceResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } @@ -11469,6 +11996,15 @@ "smithy.api#documentation": "

Provides information that defines a MariaDB data provider.

" } }, + "com.amazonaws.databasemigrationservice#Marker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.databasemigrationservice#MessageFormatValue": { "type": "enum", "members": { @@ -11734,15 +12270,87 @@ } } }, - "com.amazonaws.databasemigrationservice#ModifyConversionConfiguration": { + "com.amazonaws.databasemigrationservice#ModifyConversionConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the specified schema conversion configuration using the provided parameters.

", + "smithy.api#examples": [ + { + "title": "Modify Conversion Configuration", + "documentation": "Modifies the specified schema conversion configuration using the provided parameters.", + "input": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", + "ConversionConfiguration": "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\"},\"ORACLE_TO_POSTGRESQL\" : {\"ToTimeZone\":false,\"LastDayBuiltinFunctionOracle\":false, \"NextDayBuiltinFunctionOracle\":false,\"ConvertProceduresToFunction\":false,\"NvlBuiltinFunctionOracle\":false,\"DbmsAssertBuiltinFunctionOracle\":false}}" + }, + "output": { + "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" + } + } + ] + } + }, + "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationMessage": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The migration project name or Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + }, + "ConversionConfiguration": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The new conversion configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationResponse": { + "type": "structure", + "members": { + "MigrationProjectIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the modified configuration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.databasemigrationservice#ModifyDataMigration": { "type": "operation", "input": { - "target": "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationMessage" + "target": "com.amazonaws.databasemigrationservice#ModifyDataMigrationMessage" }, "output": { - "target": "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationResponse" + "target": "com.amazonaws.databasemigrationservice#ModifyDataMigrationResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -11751,37 +12359,59 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the specified schema conversion configuration using the provided parameters.

", - "smithy.api#examples": [ - { - "title": "Modify Conversion Configuration", - "documentation": "Modifies the specified schema conversion configuration using the provided parameters.", - "input": { - "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012", - "ConversionConfiguration": "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\"},\"ORACLE_TO_POSTGRESQL\" : {\"ToTimeZone\":false,\"LastDayBuiltinFunctionOracle\":false, \"NextDayBuiltinFunctionOracle\":false,\"ConvertProceduresToFunction\":false,\"NvlBuiltinFunctionOracle\":false,\"DbmsAssertBuiltinFunctionOracle\":false}}" - }, - "output": { - "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ012" - } - } - ] + "smithy.api#documentation": "

Modifies an existing DMS data migration.

" } }, - "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationMessage": { + "com.amazonaws.databasemigrationservice#ModifyDataMigrationMessage": { "type": "structure", "members": { - "MigrationProjectIdentifier": { + "DataMigrationIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The migration project name or Amazon Resource Name (ARN).

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

The identifier (name or ARN) of the data migration to modify.

", "smithy.api#required": {} } }, - "ConversionConfiguration": { + "DataMigrationName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The new conversion configuration.

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

The new name for the data migration.

" + } + }, + "EnableCloudwatchLogs": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Whether to enable Cloudwatch logs for the data migration.

" + } + }, + "ServiceAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The new service access role ARN for the data migration.

" + } + }, + "DataMigrationType": { + "target": "com.amazonaws.databasemigrationservice#MigrationTypeValue", + "traits": { + "smithy.api#documentation": "

The new migration type for the data migration.

" + } + }, + "SourceDataSettings": { + "target": "com.amazonaws.databasemigrationservice#SourceDataSettings", + "traits": { + "smithy.api#documentation": "

The new information about the source data provider for the data migration.

" + } + }, + "NumberOfJobs": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

" + } + }, + "SelectionRules": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

A JSON-formatted string that defines what objects to include and exclude from the migration.

" } } }, @@ -11789,13 +12419,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.databasemigrationservice#ModifyConversionConfigurationResponse": { + "com.amazonaws.databasemigrationservice#ModifyDataMigrationResponse": { "type": "structure", "members": { - "MigrationProjectIdentifier": { - "target": "com.amazonaws.databasemigrationservice#String", + "DataMigration": { + "target": "com.amazonaws.databasemigrationservice#DataMigration", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of the modified configuration.

" + "smithy.api#documentation": "

Information about the modified data migration.

" } } }, @@ -11815,6 +12445,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -12307,6 +12940,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -12447,6 +13083,9 @@ { "target": "com.amazonaws.databasemigrationservice#AccessDeniedFault" }, + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, { "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" }, @@ -14293,6 +14932,15 @@ "smithy.api#documentation": "

Information about provisioning resources for an DMS serverless replication.

" } }, + "com.amazonaws.databasemigrationservice#PublicIpAddressList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.databasemigrationservice#RdsConfiguration": { "type": "structure", "members": { @@ -15181,6 +15829,9 @@ "target": "com.amazonaws.databasemigrationservice#RemoveTagsFromResourceResponse" }, "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" } @@ -16133,6 +16784,19 @@ "traits": { "smithy.api#documentation": "

Unique name of the assessment run.

" } + }, + "IsLatestTaskAssessmentRun": { + "target": "com.amazonaws.databasemigrationservice#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.

" + } + }, + "ResultStatistic": { + "target": "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunResultStatistic", + "traits": { + "smithy.api#documentation": "

\n Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.\n

" + } } }, "traits": { @@ -16167,6 +16831,49 @@ "smithy.api#documentation": "

The progress values reported by the AssessmentProgress response\n element.

" } }, + "com.amazonaws.databasemigrationservice#ReplicationTaskAssessmentRunResultStatistic": { + "type": "structure", + "members": { + "Passed": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of individual assessments that successfully passed all checks in the assessment run.

" + } + }, + "Failed": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of individual assessments that failed to meet the criteria defined in the assessment run.

" + } + }, + "Error": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of individual assessments that encountered a critical error and could not complete properly.

" + } + }, + "Warning": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Indicates that the recent completed AssessmentRun triggered a warning.

" + } + }, + "Cancelled": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

\n The number of individual assessments that were cancelled during the assessment run.\n

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

The object containing the result statistics for a completed assessment run.

" + } + }, "com.amazonaws.databasemigrationservice#ReplicationTaskIndividualAssessment": { "type": "structure", "members": { @@ -16938,6 +17645,44 @@ "smithy.api#documentation": "

Describes a server in a Fleet Advisor collector inventory.

" } }, + "com.amazonaws.databasemigrationservice#SourceDataSetting": { + "type": "structure", + "members": { + "CDCStartPosition": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The change data capture (CDC) start position for the source data provider.

" + } + }, + "CDCStartTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The change data capture (CDC) start time for the source data provider.

" + } + }, + "CDCStopTime": { + "target": "com.amazonaws.databasemigrationservice#Iso8601DateTime", + "traits": { + "smithy.api#documentation": "

The change data capture (CDC) stop time for the source data provider.

" + } + }, + "SlotName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The name of the replication slot on the source data provider. This attribute is only \n valid for a PostgreSQL or Aurora PostgreSQL source.

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

Defines settings for a source data provider for a data migration.

" + } + }, + "com.amazonaws.databasemigrationservice#SourceDataSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#SourceDataSetting" + } + }, "com.amazonaws.databasemigrationservice#SourceIdsList": { "type": "list", "member": { @@ -16975,6 +17720,71 @@ } } }, + "com.amazonaws.databasemigrationservice#StartDataMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StartDataMigrationMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StartDataMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidOperationFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Starts the specified data migration.

" + } + }, + "com.amazonaws.databasemigrationservice#StartDataMigrationMessage": { + "type": "structure", + "members": { + "DataMigrationIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The identifier (name or ARN) of the data migration to start.

", + "smithy.api#required": {} + } + }, + "StartType": { + "target": "com.amazonaws.databasemigrationservice#StartReplicationMigrationTypeValue", + "traits": { + "smithy.api#documentation": "

Specifies the start type for the data migration. Valid values include \n start-replication, reload-target, and resume-processing.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#StartDataMigrationResponse": { + "type": "structure", + "members": { + "DataMigration": { + "target": "com.amazonaws.databasemigrationservice#DataMigration", + "traits": { + "smithy.api#documentation": "

The data migration that DMS started.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#StartExtensionPackAssociation": { "type": "operation", "input": { @@ -17664,6 +18474,29 @@ "smithy.api#input": {} } }, + "com.amazonaws.databasemigrationservice#StartReplicationMigrationTypeValue": { + "type": "enum", + "members": { + "RELOAD_TARGET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "reload-target" + } + }, + "RESUME_PROCESSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resume-processing" + } + }, + "START_REPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "start-replication" + } + } + } + }, "com.amazonaws.databasemigrationservice#StartReplicationResponse": { "type": "structure", "members": { @@ -17888,6 +18721,12 @@ "traits": { "smithy.api#documentation": "

Space-separated list of names for specific individual assessments that you want to\n exclude. These names come from the default list of individual assessments that DMS\n supports for the associated migration task. This task is specified by\n ReplicationTaskArn.

\n \n

You can't set a value for Exclude if you also set a value for\n IncludeOnly in the API operation.

\n

To identify the names of the default individual assessments that DMS\n supports for the associated migration task, run the\n DescribeApplicableIndividualAssessments operation using its own\n ReplicationTaskArn request parameter.

\n " } + }, + "Tags": { + "target": "com.amazonaws.databasemigrationservice#TagList", + "traits": { + "smithy.api#documentation": "

One or more tags to be assigned to the premigration assessment run that you want to start.

" + } } }, "traits": { @@ -17989,6 +18828,58 @@ } } }, + "com.amazonaws.databasemigrationservice#StopDataMigration": { + "type": "operation", + "input": { + "target": "com.amazonaws.databasemigrationservice#StopDataMigrationMessage" + }, + "output": { + "target": "com.amazonaws.databasemigrationservice#StopDataMigrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databasemigrationservice#FailedDependencyFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#InvalidResourceStateFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Stops the specified data migration.

" + } + }, + "com.amazonaws.databasemigrationservice#StopDataMigrationMessage": { + "type": "structure", + "members": { + "DataMigrationIdentifier": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The identifier (name or ARN) of the data migration to stop.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.databasemigrationservice#StopDataMigrationResponse": { + "type": "structure", + "members": { + "DataMigration": { + "target": "com.amazonaws.databasemigrationservice#DataMigration", + "traits": { + "smithy.api#documentation": "

The data migration that DMS stopped.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.databasemigrationservice#StopReplication": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/dataexchange.json b/codegen/sdk/aws-models/dataexchange.json index e3b845edc1b..1d532eb7594 100644 --- a/codegen/sdk/aws-models/dataexchange.json +++ b/codegen/sdk/aws-models/dataexchange.json @@ -1,6 +1,175 @@ { "smithy": "2.0", "shapes": { + "com.amazonaws.dataexchange#AcceptDataGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#AcceptDataGrantRequest" + }, + "output": { + "target": "com.amazonaws.dataexchange#AcceptDataGrantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" + }, + { + "target": "com.amazonaws.dataexchange#ConflictException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation accepts a data grant.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/data-grants/{DataGrantArn}/accept", + "code": 200 + } + } + }, + "com.amazonaws.dataexchange#AcceptDataGrantRequest": { + "type": "structure", + "members": { + "DataGrantArn": { + "target": "com.amazonaws.dataexchange#DataGrantArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data grant to accept.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dataexchange#AcceptDataGrantResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.dataexchange#DataGrantName", + "traits": { + "smithy.api#documentation": "

The name of the accepted data grant.

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

The Amazon Web Services account ID of the data grant sender.

" + } + }, + "ReceiverPrincipal": { + "target": "com.amazonaws.dataexchange#ReceiverPrincipal", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the data grant receiver.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.dataexchange#DataGrantDescription", + "traits": { + "smithy.api#documentation": "

The description of the accepted data grant.

" + } + }, + "AcceptanceState": { + "target": "com.amazonaws.dataexchange#DataGrantAcceptanceState", + "traits": { + "smithy.api#documentation": "

The acceptance state of the data grant.

", + "smithy.api#required": {} + } + }, + "AcceptedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was accepted.

" + } + }, + "EndsAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when access to the associated data set ends.

" + } + }, + "GrantDistributionScope": { + "target": "com.amazonaws.dataexchange#GrantDistributionScope", + "traits": { + "smithy.api#documentation": "

The distribution scope for the data grant.

", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set associated to the data grant.

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

The ID of the data grant.

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

The Amazon Resource Name (ARN) of the accepted data grant.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was created.

", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was last updated.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.dataexchange#AcceptanceStateFilterValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING_RECEIVER_ACCEPTANCE", + "name": "PENDING_RECEIVER_ACCEPTANCE" + }, + { + "value": "ACCEPTED", + "name": "ACCEPTED" + } + ] + } + }, + "com.amazonaws.dataexchange#AcceptanceStateFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.dataexchange#AcceptanceStateFilterValue" + } + }, "com.amazonaws.dataexchange#AccessDeniedException": { "type": "structure", "members": { @@ -228,7 +397,7 @@ "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" + "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This\n parameter is returned when an asset owner is viewing the entitled copy of its owned\n asset.

" } }, "UpdatedAt": { @@ -308,12 +477,12 @@ "KeyPattern": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions.

" + "smithy.api#documentation": "

A string representing the pattern for generated names of the individual assets in the\n revision. For more information about key patterns, see Key patterns when exporting revisions.

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

A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.

" + "smithy.api#documentation": "

A revision destination is the Amazon S3 bucket folder destination to where the export\n will be sent.

" } }, "com.amazonaws.dataexchange#AutoExportRevisionToS3RequestDetails": { @@ -328,7 +497,7 @@ "RevisionDestination": { "target": "com.amazonaws.dataexchange#AutoExportRevisionDestinationEntry", "traits": { - "smithy.api#documentation": "

A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.

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

A revision destination is the Amazon S3 bucket folder destination to where the export\n will be sent.

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

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

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

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING\n state.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/jobs/{JobId}", @@ -445,7 +614,7 @@ "Message": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The request couldn't be completed because it conflicted with the current state of the resource.

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

The request couldn't be completed because it conflicted with the current state of the\n resource.

", "smithy.api#required": {} } }, @@ -463,11 +632,211 @@ } }, "traits": { - "smithy.api#documentation": "

The request couldn't be completed because it conflicted with the current state of the resource.

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

The request couldn't be completed because it conflicted with the current state of the\n resource.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, + "com.amazonaws.dataexchange#CreateDataGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#CreateDataGrantRequest" + }, + "output": { + "target": "com.amazonaws.dataexchange#CreateDataGrantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ServiceLimitExceededException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation creates a data grant.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/data-grants", + "code": 201 + } + } + }, + "com.amazonaws.dataexchange#CreateDataGrantRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.dataexchange#DataGrantName", + "traits": { + "smithy.api#documentation": "

The name of the data grant.

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

The distribution scope of the data grant.

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

The Amazon Web Services account ID of the data grant receiver.

", + "smithy.api#required": {} + } + }, + "SourceDataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set used to create the data grant.

", + "smithy.api#required": {} + } + }, + "EndsAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when access to the associated data set ends.

" + } + }, + "Description": { + "target": "com.amazonaws.dataexchange#Description", + "traits": { + "smithy.api#documentation": "

The description of the data grant.

" + } + }, + "Tags": { + "target": "com.amazonaws.dataexchange#MapOf__string", + "traits": { + "smithy.api#documentation": "

The tags to add to the data grant. A tag is a key-value pair.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dataexchange#CreateDataGrantResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.dataexchange#DataGrantName", + "traits": { + "smithy.api#documentation": "

The name of the data grant.

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

The Amazon Web Services account ID of the data grant sender.

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

The Amazon Web Services account ID of the data grant receiver.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.dataexchange#DataGrantDescription", + "traits": { + "smithy.api#documentation": "

The description of the data grant.

" + } + }, + "AcceptanceState": { + "target": "com.amazonaws.dataexchange#DataGrantAcceptanceState", + "traits": { + "smithy.api#documentation": "

The acceptance state of the data grant.

", + "smithy.api#required": {} + } + }, + "AcceptedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was accepted.

" + } + }, + "EndsAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when access to the associated data set ends.

" + } + }, + "GrantDistributionScope": { + "target": "com.amazonaws.dataexchange#GrantDistributionScope", + "traits": { + "smithy.api#documentation": "

The distribution scope for the data grant.

", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set associated to the data grant.

", + "smithy.api#required": {} + } + }, + "SourceDataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set used to create the data grant.

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

The ID of the data grant.

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

The Amazon Resource Name (ARN) of the data grant.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was created.

", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was last updated.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.dataexchange#MapOf__string", + "traits": { + "smithy.api#documentation": "

The tags associated to the data grant. A tag is a key-value pair.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.dataexchange#CreateDataSet": { "type": "operation", "input": { @@ -529,7 +898,7 @@ "Tags": { "target": "com.amazonaws.dataexchange#MapOf__string", "traits": { - "smithy.api#documentation": "

A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

" + "smithy.api#documentation": "

A data set tag is an optional label that you can assign to a data set when you create\n it. Each tag consists of a key and an optional value, both of which you define. When you\n use tagging, you can also use tag-based access control in IAM policies to control access to\n these data sets and revisions.

" } } } @@ -576,19 +945,19 @@ "Origin": { "target": "com.amazonaws.dataexchange#Origin", "traits": { - "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

" + "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED\n to the account (for subscribers).

" } }, "OriginDetails": { "target": "com.amazonaws.dataexchange#OriginDetails", "traits": { - "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" + "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS\n Marketplace.

" } }, "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" + "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being\n viewed. This parameter is returned when a data set owner is viewing the entitled copy of\n its owned data set.

" } }, "Tags": { @@ -862,7 +1231,7 @@ "Tags": { "target": "com.amazonaws.dataexchange#MapOf__string", "traits": { - "smithy.api#documentation": "

A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

" + "smithy.api#documentation": "

A revision tag is an optional label that you can assign to a revision when you create\n it. Each tag consists of a key and an optional value, both of which you define. When you\n use tagging, you can also use tag-based access control in IAM policies to control access to\n these data sets and revisions.

" } } } @@ -898,7 +1267,7 @@ "target": "com.amazonaws.dataexchange#__boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized.\n Finalizing a revision tells AWS Data Exchange that your changes to the assets in the\n revision are complete. After it's in this read-only state, you can publish the revision to\n your products. Finalized revisions can be published through the AWS Data Exchange console\n or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API\n action. When using the API, revisions are uniquely identified by their ARN.

" } }, "Id": { @@ -910,7 +1279,7 @@ "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being\n viewed. This parameter is returned when a revision owner is viewing the entitled copy of\n its owned revision.

" } }, "Tags": { @@ -928,7 +1297,7 @@ "RevocationComment": { "target": "com.amazonaws.dataexchange#__stringMin10Max512", "traits": { - "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was\n revoked.

" } }, "Revoked": { @@ -959,7 +1328,7 @@ "DataSetId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the data set associated with the creation of this Amazon S3 data access.

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

The unique identifier for the data set associated with the creation of this Amazon S3\n data access.

", "smithy.api#required": {} } }, @@ -1001,16 +1370,22 @@ } }, "traits": { - "smithy.api#documentation": "

Details about the response of the operation to create an S3 data access from an S3 bucket.

" + "smithy.api#documentation": "

Details about the response of the operation to create an S3 data access from an S3\n bucket.

" } }, "com.amazonaws.dataexchange#DataExchange": { "type": "service", "version": "2017-07-25", "operations": [ + { + "target": "com.amazonaws.dataexchange#AcceptDataGrant" + }, { "target": "com.amazonaws.dataexchange#CancelJob" }, + { + "target": "com.amazonaws.dataexchange#CreateDataGrant" + }, { "target": "com.amazonaws.dataexchange#CreateDataSet" }, @@ -1026,6 +1401,9 @@ { "target": "com.amazonaws.dataexchange#DeleteAsset" }, + { + "target": "com.amazonaws.dataexchange#DeleteDataGrant" + }, { "target": "com.amazonaws.dataexchange#DeleteDataSet" }, @@ -1038,6 +1416,9 @@ { "target": "com.amazonaws.dataexchange#GetAsset" }, + { + "target": "com.amazonaws.dataexchange#GetDataGrant" + }, { "target": "com.amazonaws.dataexchange#GetDataSet" }, @@ -1047,9 +1428,15 @@ { "target": "com.amazonaws.dataexchange#GetJob" }, + { + "target": "com.amazonaws.dataexchange#GetReceivedDataGrant" + }, { "target": "com.amazonaws.dataexchange#GetRevision" }, + { + "target": "com.amazonaws.dataexchange#ListDataGrants" + }, { "target": "com.amazonaws.dataexchange#ListDataSetRevisions" }, @@ -1062,6 +1449,9 @@ { "target": "com.amazonaws.dataexchange#ListJobs" }, + { + "target": "com.amazonaws.dataexchange#ListReceivedDataGrants" + }, { "target": "com.amazonaws.dataexchange#ListRevisionAssets" }, @@ -1110,7 +1500,7 @@ "name": "dataexchange" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.

\n

As a subscriber, you can view and access the data sets that you have an entitlement to through\n a subscription. You can use the APIs to download or copy your entitled data sets to Amazon\n Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and machine\n learning services.

\n

As a provider, you can create and manage your data sets that you would like to publish to a\n product. Being able to package and provide your data sets into products requires a few\n steps to determine eligibility. For more information, visit the AWS Data Exchange\n User Guide.

\n

A data set is a collection of data that can be changed or updated over time. Data sets can be\n updated using revisions, which represent a new version or incremental change to a data set.\n A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data\n that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS Lake\n Formation data permission, or Amazon S3 data access. The asset can be a structured data\n file, an image file, or some other data file. Jobs are asynchronous import or export\n operations used to create or copy assets.

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

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in\n the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access\n file-based data set in the AWS Cloud.

\n

As a subscriber, you can view and access the data sets that you have an entitlement to\n through a subscription. You can use the APIs to download or copy your entitled data sets to\n Amazon Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and\n machine learning services.

\n

As a provider, you can create and manage your data sets that you would like to publish\n to a product. Being able to package and provide your data sets into products requires a few\n steps to determine eligibility. For more information, visit the AWS Data Exchange\n User Guide.

\n

A data set is a collection of data that can be changed or updated over time. Data sets\n can be updated using revisions, which represent a new version or incremental change to a\n data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece\n of data that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS\n Lake Formation data permission, or Amazon S3 data access. The asset can be a structured\n data file, an image file, or some other data file. Jobs are asynchronous import or export\n operations used to create or copy assets.

", "smithy.api#title": "AWS Data Exchange", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1872,6 +2262,141 @@ } } }, + "com.amazonaws.dataexchange#DataGrantAcceptanceState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING_RECEIVER_ACCEPTANCE", + "name": "PENDING_RECEIVER_ACCEPTANCE" + }, + { + "value": "ACCEPTED", + "name": "ACCEPTED" + } + ] + } + }, + "com.amazonaws.dataexchange#DataGrantArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:dataexchange:[\\-a-z0-9]*:(\\d{12}):data-grants\\/[a-zA-Z0-9]{30,40}$" + } + }, + "com.amazonaws.dataexchange#DataGrantDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.dataexchange#DataGrantId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9]{30,40}$|^arn:aws:dataexchange:[\\-a-z0-9]*:(\\d{12}):data-grants\\/[a-zA-Z0-9]{30,40}$" + } + }, + "com.amazonaws.dataexchange#DataGrantName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.dataexchange#DataGrantSummaryEntry": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.dataexchange#DataGrantName", + "traits": { + "smithy.api#documentation": "

The name of the data grant.

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

The Amazon Web Services account ID of the data grant sender.

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

The Amazon Web Services account ID of the data grant receiver.

", + "smithy.api#required": {} + } + }, + "AcceptanceState": { + "target": "com.amazonaws.dataexchange#DataGrantAcceptanceState", + "traits": { + "smithy.api#documentation": "

The acceptance state of the data grant.

", + "smithy.api#required": {} + } + }, + "AcceptedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was accepted.

" + } + }, + "EndsAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when access to the associated data set ends.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set associated to the data grant.

", + "smithy.api#required": {} + } + }, + "SourceDataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set used to create the data grant.

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

The ID of the data grant.

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

The Amazon Resource Name (ARN) of the data grant.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was created.

", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was last updated.

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

Information about a data grant.

" + } + }, "com.amazonaws.dataexchange#DataSetEntry": { "type": "structure", "members": { @@ -1920,20 +2445,20 @@ "Origin": { "target": "com.amazonaws.dataexchange#Origin", "traits": { - "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

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

A property that defines the data set as OWNED by the account (for providers) or ENTITLED\n to the account (for subscribers).

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

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" + "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS\n Marketplace.

" } }, "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" + "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being\n viewed. This parameter is returned when a data set owner is viewing the entitled copy of\n its owned data set.

" } }, "UpdatedAt": { @@ -2023,7 +2548,70 @@ "target": "com.amazonaws.dataexchange#AccessDeniedException" }, { - "target": "com.amazonaws.dataexchange#ConflictException" + "target": "com.amazonaws.dataexchange#ConflictException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation deletes an asset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/data-sets/{DataSetId}/revisions/{RevisionId}/assets/{AssetId}", + "code": 204 + } + } + }, + "com.amazonaws.dataexchange#DeleteAssetRequest": { + "type": "structure", + "members": { + "AssetId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for an asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for a data set.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RevisionId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The unique identifier for a revision.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.dataexchange#DeleteDataGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#DeleteDataGrantRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" }, { "target": "com.amazonaws.dataexchange#InternalServerException" @@ -2039,41 +2627,28 @@ } ], "traits": { - "smithy.api#documentation": "

This operation deletes an asset.

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

This operation deletes a data grant.

", "smithy.api#http": { "method": "DELETE", - "uri": "/v1/data-sets/{DataSetId}/revisions/{RevisionId}/assets/{AssetId}", + "uri": "/v1/data-grants/{DataGrantId}", "code": 204 } } }, - "com.amazonaws.dataexchange#DeleteAssetRequest": { + "com.amazonaws.dataexchange#DeleteDataGrantRequest": { "type": "structure", "members": { - "AssetId": { - "target": "com.amazonaws.dataexchange#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for an asset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.dataexchange#__string", - "traits": { - "smithy.api#documentation": "

The unique identifier for a data set.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RevisionId": { - "target": "com.amazonaws.dataexchange#__string", + "DataGrantId": { + "target": "com.amazonaws.dataexchange#DataGrantId", "traits": { - "smithy.api#documentation": "

The unique identifier for a revision.

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

The ID of the data grant to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.dataexchange#DeleteDataSet": { @@ -2327,7 +2902,7 @@ } }, "traits": { - "smithy.api#documentation": "

An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.

" + "smithy.api#documentation": "

An event action is an object that defines the relationship between a specific event and\n an automated action that will be taken on behalf of the customer.

" } }, "com.amazonaws.dataexchange#ExceptionCause": { @@ -2553,7 +3128,7 @@ "KmsKeyArn": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon\n S3 objects. This parameter is required if you choose aws:kms as an encryption type.

" } }, "Type": { @@ -2565,7 +3140,7 @@ } }, "traits": { - "smithy.api#documentation": "

Encryption configuration of the export job. Includes the encryption type in addition to the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption type.

" + "smithy.api#documentation": "

Encryption configuration of the export job. Includes the encryption type in addition to\n the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption type.

" } }, "com.amazonaws.dataexchange#GetAsset": { @@ -2671,7 +3246,7 @@ "Name": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "

The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used\n as the asset name. When exporting to Amazon S3, the asset name is used as default target\n Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as\n the asset name. When importing from Amazon Redshift, the datashare name is used as the\n asset name. When importing from AWS Lake Formation, the static values of \"Database(s) included\n in the LF-tag policy\" or \"Table(s) included in the LF-tag policy\" are used as the asset\n name.

" + "smithy.api#documentation": "

The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used\n as the asset name. When exporting to Amazon S3, the asset name is used as default target\n Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as\n the asset name. When importing from Amazon Redshift, the datashare name is used as the\n asset name. When importing from AWS Lake Formation, the static values of \"Database(s)\n included in the LF-tag policy\" or \"Table(s) included in the LF-tag policy\" are used as the\n asset name.

" } }, "RevisionId": { @@ -2683,7 +3258,7 @@ "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" + "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This\n parameter is returned when an asset owner is viewing the entitled copy of its owned\n asset.

" } }, "UpdatedAt": { @@ -2694,6 +3269,166 @@ } } }, + "com.amazonaws.dataexchange#GetDataGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#GetDataGrantRequest" + }, + "output": { + "target": "com.amazonaws.dataexchange#GetDataGrantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation returns information about a data grant.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/data-grants/{DataGrantId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.dataexchange#GetDataGrantRequest": { + "type": "structure", + "members": { + "DataGrantId": { + "target": "com.amazonaws.dataexchange#DataGrantId", + "traits": { + "smithy.api#documentation": "

The ID of the data grant.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dataexchange#GetDataGrantResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.dataexchange#DataGrantName", + "traits": { + "smithy.api#documentation": "

The name of the data grant.

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

The Amazon Web Services account ID of the data grant sender.

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

The Amazon Web Services account ID of the data grant receiver.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.dataexchange#DataGrantDescription", + "traits": { + "smithy.api#documentation": "

The description of the data grant.

" + } + }, + "AcceptanceState": { + "target": "com.amazonaws.dataexchange#DataGrantAcceptanceState", + "traits": { + "smithy.api#documentation": "

The acceptance state of the data grant.

", + "smithy.api#required": {} + } + }, + "AcceptedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was accepted.

" + } + }, + "EndsAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when access to the associated data set ends.

" + } + }, + "GrantDistributionScope": { + "target": "com.amazonaws.dataexchange#GrantDistributionScope", + "traits": { + "smithy.api#documentation": "

The distribution scope for the data grant.

", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set associated to the data grant.

", + "smithy.api#required": {} + } + }, + "SourceDataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set used to create the data grant.

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

The ID of the data grant.

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

The Amazon Resource Name (ARN) of the data grant.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was created.

", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was last updated.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.dataexchange#MapOf__string", + "traits": { + "smithy.api#documentation": "

The tags associated to the data grant. A tag is a key-value pair.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.dataexchange#GetDataSet": { "type": "operation", "input": { @@ -2781,19 +3516,19 @@ "Origin": { "target": "com.amazonaws.dataexchange#Origin", "traits": { - "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

" + "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED\n to the account (for subscribers).

" } }, "OriginDetails": { "target": "com.amazonaws.dataexchange#OriginDetails", "traits": { - "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" + "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS\n Marketplace.

" } }, "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" + "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being\n viewed. This parameter is returned when a data set owner is viewing the entitled copy of\n its owned data set.

" } }, "Tags": { @@ -2974,24 +3709,170 @@ "smithy.api#documentation": "

The unique identifier for the job.

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

The state of the job.

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

The job type.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the job was last updated, in ISO 8601 format.

" + } + } + } + }, + "com.amazonaws.dataexchange#GetReceivedDataGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#GetReceivedDataGrantRequest" + }, + "output": { + "target": "com.amazonaws.dataexchange#GetReceivedDataGrantResponse" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation returns information about a received data grant.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/received-data-grants/{DataGrantArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.dataexchange#GetReceivedDataGrantRequest": { + "type": "structure", + "members": { + "DataGrantArn": { + "target": "com.amazonaws.dataexchange#DataGrantArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data grant.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dataexchange#GetReceivedDataGrantResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.dataexchange#DataGrantName", + "traits": { + "smithy.api#documentation": "

The name of the data grant.

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

The Amazon Web Services account ID of the data grant sender.

" + } + }, + "ReceiverPrincipal": { + "target": "com.amazonaws.dataexchange#ReceiverPrincipal", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the data grant receiver.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.dataexchange#DataGrantDescription", + "traits": { + "smithy.api#documentation": "

The description of the data grant.

" + } + }, + "AcceptanceState": { + "target": "com.amazonaws.dataexchange#DataGrantAcceptanceState", + "traits": { + "smithy.api#documentation": "

The acceptance state of the data grant.

", + "smithy.api#required": {} + } + }, + "AcceptedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was accepted.

" + } + }, + "EndsAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when access to the associated data set ends.

" + } + }, + "GrantDistributionScope": { + "target": "com.amazonaws.dataexchange#GrantDistributionScope", + "traits": { + "smithy.api#documentation": "

The distribution scope for the data grant.

", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set associated to the data grant.

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

The ID of the data grant.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "

The state of the job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data grant.

", + "smithy.api#required": {} } }, - "Type": { - "target": "com.amazonaws.dataexchange#Type", + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The job type.

" + "smithy.api#documentation": "

The timestamp of when the data grant was created.

", + "smithy.api#required": {} } }, "UpdatedAt": { "target": "com.amazonaws.dataexchange#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the job was last updated, in ISO 8601 format.

" + "smithy.api#documentation": "

The timestamp of when the data grant was last updated.

", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.dataexchange#GetRevision": { @@ -3078,7 +3959,7 @@ "target": "com.amazonaws.dataexchange#__boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized.\n Finalizing a revision tells AWS Data Exchange that your changes to the assets in the\n revision are complete. After it's in this read-only state, you can publish the revision to\n your products. Finalized revisions can be published through the AWS Data Exchange console\n or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API\n action. When using the API, revisions are uniquely identified by their ARN.

" } }, "Id": { @@ -3090,7 +3971,7 @@ "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being\n viewed. This parameter is returned when a revision owner is viewing the entitled copy of\n its owned revision.

" } }, "Tags": { @@ -3108,7 +3989,7 @@ "RevocationComment": { "target": "com.amazonaws.dataexchange#__stringMin10Max512", "traits": { - "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was\n revoked.

" } }, "Revoked": { @@ -3126,6 +4007,21 @@ } } }, + "com.amazonaws.dataexchange#GrantDistributionScope": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_ORGANIZATION", + "name": "AWS_ORGANIZATION" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.dataexchange#Id": { "type": "string" }, @@ -3161,7 +4057,7 @@ "ApiSpecificationMd5Hash": { "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", "traits": { - "smithy.api#documentation": "

The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used to ensure the integrity of the file.

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

The Base64-encoded MD5 hash of the OpenAPI 3.0 JSON API specification file. It is used\n to ensure the integrity of the file.

", "smithy.api#required": {} } }, @@ -3230,7 +4126,7 @@ "ApiSpecificationMd5Hash": { "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", "traits": { - "smithy.api#documentation": "

The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API at that location.

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

The Base64-encoded Md5 hash for the API asset, used to ensure the integrity of the API\n at that location.

", "smithy.api#required": {} } }, @@ -3302,7 +4198,7 @@ "AssetName": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "

The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name.

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

The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used\n as the asset name.

", "smithy.api#required": {} } }, @@ -3316,7 +4212,7 @@ "Md5Hash": { "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", "traits": { - "smithy.api#documentation": "

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

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

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at\n that location.

", "smithy.api#required": {} } }, @@ -3352,7 +4248,7 @@ "Md5Hash": { "target": "com.amazonaws.dataexchange#__stringMin24Max24PatternAZaZ094AZaZ092AZaZ093", "traits": { - "smithy.api#documentation": "

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

" + "smithy.api#documentation": "

The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at\n that location.

" } }, "RevisionId": { @@ -3376,7 +4272,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details in the response for an import request, including the signed URL and other information.

" + "smithy.api#documentation": "

The details in the response for an import request, including the signed URL and other\n information.

" } }, "com.amazonaws.dataexchange#ImportAssetsFromLakeFormationTagPolicyRequestDetails": { @@ -3404,7 +4300,7 @@ "RoleArn": { "target": "com.amazonaws.dataexchange#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions of subscribers to AWS Lake Formation data permissions.

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

The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke\n permissions of subscribers to AWS Lake Formation data permissions.

", "smithy.api#required": {} } }, @@ -3452,7 +4348,7 @@ "RoleArn": { "target": "com.amazonaws.dataexchange#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions to AWS Lake Formation data permissions.

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

The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke\n permissions to AWS Lake Formation data permissions.

", "smithy.api#required": {} } }, @@ -3628,7 +4524,7 @@ "Details": { "target": "com.amazonaws.dataexchange#ResponseDetails", "traits": { - "smithy.api#documentation": "

Details of the operation to be performed by the job, such as export destination details or import source details.

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

Details of the operation to be performed by the job, such as export destination details\n or import source details.

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

AWS Data Exchange Jobs are asynchronous import or export operations used to create or copy assets. A data set owner can both import and export as they see fit. Someone with an entitlement to a data set can only export. Jobs are deleted 90 days after they are created.

" + "smithy.api#documentation": "

AWS Data Exchange Jobs are asynchronous import or export operations used to create or\n copy assets. A data set owner can both import and export as they see fit. Someone with an\n entitlement to a data set can only export. Jobs are deleted 90 days after they are\n created.

" } }, "com.amazonaws.dataexchange#JobError": { @@ -3815,18 +4711,18 @@ "Database": { "target": "com.amazonaws.dataexchange#DatabaseLFTagPolicy", "traits": { - "smithy.api#documentation": "

Details about the database resource included in the AWS Lake Formation data permission.

" + "smithy.api#documentation": "

Details about the database resource included in the AWS Lake Formation data\n permission.

" } }, "Table": { "target": "com.amazonaws.dataexchange#TableLFTagPolicy", "traits": { - "smithy.api#documentation": "

Details about the table resource included in the AWS Lake Formation data permission.

" + "smithy.api#documentation": "

Details about the table resource included in the AWS Lake Formation data\n permission.

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

Details about the AWS Lake Formation resource (Table or Database) included in the AWS Lake Formation data permission.

" + "smithy.api#documentation": "

Details about the AWS Lake Formation resource (Table or Database) included in the AWS\n Lake Formation data permission.

" } }, "com.amazonaws.dataexchange#LFResourceType": { @@ -3922,7 +4818,7 @@ "RoleArn": { "target": "com.amazonaws.dataexchange#RoleArn", "traits": { - "smithy.api#documentation": "

The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions to AWS Lake Formation data permissions.

" + "smithy.api#documentation": "

The IAM role's ARN that allows AWS Data Exchange to assume the role and grant and revoke\n permissions to AWS Lake Formation data permissions.

" } } }, @@ -3972,7 +4868,7 @@ } }, "traits": { - "smithy.api#documentation": "

Extra details specific to the affected scope in\n this LF data set.

" + "smithy.api#documentation": "

Extra details specific to the affected scope in this LF data set.

" } }, "com.amazonaws.dataexchange#LimitName": { @@ -4090,10 +4986,102 @@ { "value": "Concurrent in progress jobs to create Amazon S3 data access assets from S3 buckets", "name": "Concurrent_in_progress_jobs_to_create_Amazon_S3_data_access_assets_from_S3_buckets" + }, + { + "value": "Active and pending data grants", + "name": "Active_and_pending_data_grants" + }, + { + "value": "Pending data grants per consumer", + "name": "Pending_data_grants_per_consumer" } ] } }, + "com.amazonaws.dataexchange#ListDataGrants": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#ListDataGrantsRequest" + }, + "output": { + "target": "com.amazonaws.dataexchange#ListDataGrantsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation returns information about all data grants.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/data-grants", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataGrantSummaries", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.dataexchange#ListDataGrantsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.dataexchange#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to be included in the next page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this\n operation.

", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dataexchange#ListDataGrantsResponse": { + "type": "structure", + "members": { + "DataGrantSummaries": { + "target": "com.amazonaws.dataexchange#ListOfDataGrantSummaryEntry", + "traits": { + "smithy.api#documentation": "

An object that contains a list of data grant information.

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

The pagination token used to retrieve the next page of results for this\n operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.dataexchange#ListDataSetRevisions": { "type": "operation", "input": { @@ -4117,7 +5105,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation lists a data set's revisions sorted by CreatedAt in descending order.

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

This operation lists a data set's revisions sorted by CreatedAt in descending\n order.

", "smithy.api#http": { "method": "GET", "uri": "/v1/data-sets/{DataSetId}/revisions", @@ -4154,7 +5142,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

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

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } } @@ -4166,7 +5154,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "Revisions": { @@ -4200,7 +5188,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.

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

This operation lists your data sets. When listing by origin OWNED, results are sorted by\n CreatedAt in descending order. When listing by origin ENTITLED, there is no order.

", "smithy.api#http": { "method": "GET", "uri": "/v1/data-sets", @@ -4229,14 +5217,14 @@ "NextToken": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

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

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, "Origin": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

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

A property that defines the data set as OWNED by the account (for providers) or ENTITLED\n to the account (for subscribers).

", "smithy.api#httpQuery": "origin" } } @@ -4254,7 +5242,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -4318,7 +5306,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

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

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } } @@ -4336,7 +5324,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -4400,7 +5388,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

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

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4425,7 +5413,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -4448,6 +5436,12 @@ "target": "com.amazonaws.dataexchange#AssetSourceEntry" } }, + "com.amazonaws.dataexchange#ListOfDataGrantSummaryEntry": { + "type": "list", + "member": { + "target": "com.amazonaws.dataexchange#DataGrantSummaryEntry" + } + }, "com.amazonaws.dataexchange#ListOfDataSetEntry": { "type": "list", "member": { @@ -4515,6 +5509,12 @@ "target": "com.amazonaws.dataexchange#LakeFormationTagPolicyDetails" } }, + "com.amazonaws.dataexchange#ListOfReceivedDataGrantSummariesEntry": { + "type": "list", + "member": { + "target": "com.amazonaws.dataexchange#ReceivedDataGrantSummariesEntry" + } + }, "com.amazonaws.dataexchange#ListOfRedshiftDataShareAssetSourceEntry": { "type": "list", "member": { @@ -4563,6 +5563,97 @@ "target": "com.amazonaws.dataexchange#__string" } }, + "com.amazonaws.dataexchange#ListReceivedDataGrants": { + "type": "operation", + "input": { + "target": "com.amazonaws.dataexchange#ListReceivedDataGrantsRequest" + }, + "output": { + "target": "com.amazonaws.dataexchange#ListReceivedDataGrantsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.dataexchange#AccessDeniedException" + }, + { + "target": "com.amazonaws.dataexchange#InternalServerException" + }, + { + "target": "com.amazonaws.dataexchange#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.dataexchange#ThrottlingException" + }, + { + "target": "com.amazonaws.dataexchange#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

This operation returns information about all received data grants.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/received-data-grants", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataGrantSummaries", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.dataexchange#ListReceivedDataGrantsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.dataexchange#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to be included in the next page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this\n operation.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "AcceptanceState": { + "target": "com.amazonaws.dataexchange#AcceptanceStateFilterValues", + "traits": { + "smithy.api#documentation": "

The acceptance state of the data grants to list.

", + "smithy.api#httpQuery": "acceptanceState" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.dataexchange#ListReceivedDataGrantsResponse": { + "type": "structure", + "members": { + "DataGrantSummaries": { + "target": "com.amazonaws.dataexchange#ListOfReceivedDataGrantSummariesEntry", + "traits": { + "smithy.api#documentation": "

An object that contains a list of received data grant information.

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

The pagination token used to retrieve the next page of results for this\n operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.dataexchange#ListRevisionAssets": { "type": "operation", "input": { @@ -4586,7 +5677,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation lists a revision's assets sorted alphabetically in descending order.

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

This operation lists a revision's assets sorted alphabetically in descending\n order.

", "smithy.api#http": { "method": "GET", "uri": "/v1/data-sets/{DataSetId}/revisions/{RevisionId}/assets", @@ -4623,7 +5714,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

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

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4649,7 +5740,7 @@ "NextToken": { "target": "com.amazonaws.dataexchange#NextToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

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

The product ID of the origin of the data set.

" } + }, + "DataGrantId": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "

The ID of the data grant.

" + } } }, "traits": { @@ -4811,6 +5908,95 @@ ] } }, + "com.amazonaws.dataexchange#ReceivedDataGrantSummariesEntry": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.dataexchange#DataGrantName", + "traits": { + "smithy.api#documentation": "

The name of the data grant.

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

The Amazon Web Services account ID of the data grant sender.

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

The Amazon Web Services account ID of the data grant receiver.

", + "smithy.api#required": {} + } + }, + "AcceptanceState": { + "target": "com.amazonaws.dataexchange#DataGrantAcceptanceState", + "traits": { + "smithy.api#documentation": "

The acceptance state of the data grant.

", + "smithy.api#required": {} + } + }, + "AcceptedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was accepted.

" + } + }, + "EndsAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when access to the associated data set ends.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "

The ID of the data set associated to the data grant.

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

The ID of the data grant.

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

The Amazon Resource Name (ARN) of the data grant.

", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was created.

", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.dataexchange#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the data grant was last updated.

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

Information about a received data grant.

" + } + }, + "com.amazonaws.dataexchange#ReceiverPrincipal": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, "com.amazonaws.dataexchange#RedshiftDataShareAsset": { "type": "structure", "members": { @@ -4884,7 +6070,7 @@ } }, "traits": { - "smithy.api#documentation": "

Extra details specific to the affected scope\n in this Redshift data set.

" + "smithy.api#documentation": "

Extra details specific to the affected scope in this Redshift data set.

" } }, "com.amazonaws.dataexchange#RequestDetails": { @@ -5001,6 +6187,10 @@ { "value": "EVENT_ACTION", "name": "EVENT_ACTION" + }, + { + "value": "DATA_GRANT", + "name": "DATA_GRANT" } ] } @@ -5080,7 +6270,7 @@ "KeyPattern": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions.

" + "smithy.api#documentation": "

A string representing the pattern for generated names of the individual assets in the\n revision. For more information about key patterns, see Key patterns when exporting revisions.

" } }, "RevisionId": { @@ -5129,7 +6319,7 @@ "target": "com.amazonaws.dataexchange#__boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized.\n Finalizing a revision tells AWS Data Exchange that your changes to the assets in the\n revision are complete. After it's in this read-only state, you can publish the revision to\n your products. Finalized revisions can be published through the AWS Data Exchange console\n or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API\n action. When using the API, revisions are uniquely identified by their ARN.

" } }, "Id": { @@ -5142,7 +6332,7 @@ "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being\n viewed. This parameter is returned when a revision owner is viewing the entitled copy of\n its owned revision.

" } }, "UpdatedAt": { @@ -5155,7 +6345,7 @@ "RevocationComment": { "target": "com.amazonaws.dataexchange#__stringMin10Max512", "traits": { - "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was\n revoked.

" } }, "Revoked": { @@ -5250,7 +6440,7 @@ "RevocationComment": { "target": "com.amazonaws.dataexchange#__stringMin10Max512", "traits": { - "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

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

A required comment to inform subscribers of the reason their access to the revision was\n revoked.

", "smithy.api#required": {} } } @@ -5287,7 +6477,7 @@ "target": "com.amazonaws.dataexchange#__boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized.\n Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision\n are complete. After it's in this read-only state, you can publish the revision to your\n products. Finalized revisions can be published through the AWS Data Exchange console or the\n AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action.\n When using the API, revisions are uniquely identified by their ARN.

" } }, "Id": { @@ -5299,7 +6489,7 @@ "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being\n viewed. This parameter is returned when a revision owner is viewing the entitled copy of\n its owned revision.

" } }, "UpdatedAt": { @@ -5311,7 +6501,7 @@ "RevocationComment": { "target": "com.amazonaws.dataexchange#__stringMin10Max512", "traits": { - "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was\n revoked.

" } }, "Revoked": { @@ -5360,13 +6550,13 @@ "S3AccessPointAlias": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.

" + "smithy.api#documentation": "

The automatically-generated bucket-style alias for your Amazon S3 Access Point.\n Customers can access their entitled data using the S3 Access Point alias.

" } }, "S3AccessPointArn": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.

" + "smithy.api#documentation": "

The ARN for your Amazon S3 Access Point. Customers can also access their entitled data\n using the S3 Access Point ARN.

" } }, "KmsKeysToGrant": { @@ -5430,7 +6620,7 @@ } }, "traits": { - "smithy.api#documentation": "

Extra details specific to the affected scope in this S3 Data \n Access data set.

" + "smithy.api#documentation": "

Extra details specific to the affected scope in this S3 Data Access data set.

" } }, "com.amazonaws.dataexchange#S3SnapshotAsset": { @@ -5474,7 +6664,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object encompassing information about a schema change to a single, particular field, \n a notification can have up to 100 of these.

" + "smithy.api#documentation": "

Object encompassing information about a schema change to a single, particular field, a\n notification can have up to 100 of these.

" } }, "com.amazonaws.dataexchange#SchemaChangeRequestDetails": { @@ -5569,7 +6759,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.

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

This operation invokes an API Gateway API asset. The request is proxied to the\n provider’s API Gateway API.

", "smithy.api#endpoint": { "hostPrefix": "api-fulfill." }, @@ -5593,7 +6783,7 @@ "QueryStringParameters": { "target": "com.amazonaws.dataexchange#MapOf__string", "traits": { - "smithy.api#documentation": "

Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).

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

Attach query string parameters to the end of the URI (for example,\n /v1/examplePath?exampleParam=exampleValue).

", "smithy.api#httpQueryParams": {} } }, @@ -5616,21 +6806,21 @@ "RequestHeaders": { "target": "com.amazonaws.dataexchange#MapOf__string", "traits": { - "smithy.api#documentation": "

Any header value prefixed with x-amzn-dataexchange-header- will have that stripped before sending the Asset API request. Use this when you want to override a header that AWS Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP request.

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

Any header value prefixed with x-amzn-dataexchange-header- will have that stripped\n before sending the Asset API request. Use this when you want to override a header that AWS\n Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP\n request.

", "smithy.api#httpPrefixHeaders": "x-amzn-dataexchange-header-" } }, "Method": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.

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

HTTP method value for the API request. Alternatively, you can use the appropriate verb\n in your request.

", "smithy.api#httpHeader": "x-amzn-dataexchange-http-method" } }, "Path": { "target": "com.amazonaws.dataexchange#__string", "traits": { - "smithy.api#documentation": "

URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue}.

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

URI path value for the API request. Alternatively, you can set the URI path directly by\n invoking /v1/{pathValue}.

", "smithy.api#httpHeader": "x-amzn-dataexchange-path" } }, @@ -5755,6 +6945,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.dataexchange#SenderPrincipal": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, "com.amazonaws.dataexchange#ServerSideEncryptionTypes": { "type": "string", "traits": { @@ -6207,7 +7403,7 @@ "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

" + "smithy.api#documentation": "

The asset ID of the owned asset corresponding to the entitled asset being viewed. This\n parameter is returned when an asset owner is viewing the entitled copy of its owned\n asset.

" } }, "UpdatedAt": { @@ -6319,19 +7515,19 @@ "Origin": { "target": "com.amazonaws.dataexchange#Origin", "traits": { - "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

" + "smithy.api#documentation": "

A property that defines the data set as OWNED by the account (for providers) or ENTITLED\n to the account (for subscribers).

" } }, "OriginDetails": { "target": "com.amazonaws.dataexchange#OriginDetails", "traits": { - "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

" + "smithy.api#documentation": "

If the origin of this data set is ENTITLED, includes the details for the product on AWS\n Marketplace.

" } }, "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

" + "smithy.api#documentation": "

The data set ID of the owned data set corresponding to the entitled data set being\n viewed. This parameter is returned when a data set owner is viewing the entitled copy of\n its owned data set.

" } }, "UpdatedAt": { @@ -6494,7 +7690,7 @@ "target": "com.amazonaws.dataexchange#__boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

" + "smithy.api#documentation": "

Finalizing a revision tells AWS Data Exchange that your changes to the assets in the\n revision are complete. After it's in this read-only state, you can publish the revision to\n your products.

" } }, "RevisionId": { @@ -6538,7 +7734,7 @@ "target": "com.amazonaws.dataexchange#__boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products. Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

" + "smithy.api#documentation": "

To publish a revision to a data set in a product, the revision must first be finalized.\n Finalizing a revision tells AWS Data Exchange that changes to the assets in the revision\n are complete. After it's in this read-only state, you can publish the revision to your\n products. Finalized revisions can be published through the AWS Data Exchange console or the\n AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action.\n When using the API, revisions are uniquely identified by their ARN.

" } }, "Id": { @@ -6550,7 +7746,7 @@ "SourceId": { "target": "com.amazonaws.dataexchange#Id", "traits": { - "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

" + "smithy.api#documentation": "

The revision ID of the owned revision corresponding to the entitled revision being\n viewed. This parameter is returned when a revision owner is viewing the entitled copy of\n its owned revision.

" } }, "UpdatedAt": { @@ -6562,7 +7758,7 @@ "RevocationComment": { "target": "com.amazonaws.dataexchange#__stringMin10Max512", "traits": { - "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was revoked.

" + "smithy.api#documentation": "

A required comment to inform subscribers of the reason their access to the revision was\n revoked.

" } }, "Revoked": { diff --git a/codegen/sdk/aws-models/datazone.json b/codegen/sdk/aws-models/datazone.json index ad354b7cf07..19708345746 100644 --- a/codegen/sdk/aws-models/datazone.json +++ b/codegen/sdk/aws-models/datazone.json @@ -21325,6 +21325,12 @@ "traits": { "smithy.api#enumValue": "CONTRIBUTOR" } + }, + "PROJECT_CATALOG_STEWARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_CATALOG_STEWARD" + } } } }, @@ -28653,6 +28659,24 @@ "traits": { "smithy.api#enumValue": "PROJECT_CONTRIBUTOR" } + }, + "PROJECT_CATALOG_VIEWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_CATALOG_VIEWER" + } + }, + "PROJECT_CATALOG_CONSUMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_CATALOG_CONSUMER" + } + }, + "PROJECT_CATALOG_STEWARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_CATALOG_STEWARD" + } } } }, diff --git a/codegen/sdk/aws-models/deadline.json b/codegen/sdk/aws-models/deadline.json index 542e8302837..903bfb185f1 100644 --- a/codegen/sdk/aws-models/deadline.json +++ b/codegen/sdk/aws-models/deadline.json @@ -2519,15 +2519,13 @@ "template": { "target": "com.amazonaws.deadline#JobTemplate", "traits": { - "smithy.api#documentation": "

The job template to use for this job.

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

The job template to use for this job.

" } }, "templateType": { "target": "com.amazonaws.deadline#JobTemplateType", "traits": { - "smithy.api#documentation": "

The file type for the job template.

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

The file type for the job template.

" } }, "priority": { @@ -2575,6 +2573,12 @@ "smithy.api#default": 5, "smithy.api#documentation": "

The maximum number of retries for each task.

" } + }, + "sourceJobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "

The job ID for the source job.

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

The description of the job.

\n \n

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

\n " } + }, + "sourceJobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "

The job ID for the source job.

" + } } }, "traits": { @@ -10328,6 +10338,15 @@ "smithy.api#documentation": "

The details of job parameters.

" } }, + "com.amazonaws.deadline#JobParameterDefinition": { + "type": "document" + }, + "com.amazonaws.deadline#JobParameterDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.deadline#JobParameterDefinition" + } + }, "com.amazonaws.deadline#JobParameters": { "type": "map", "key": { @@ -10399,6 +10418,9 @@ { "target": "com.amazonaws.deadline#ListJobMembers" }, + { + "target": "com.amazonaws.deadline#ListJobParameterDefinitions" + }, { "target": "com.amazonaws.deadline#ListSessionActions" }, @@ -10573,6 +10595,12 @@ "traits": { "smithy.api#documentation": "

The job parameters.

" } + }, + "sourceJobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "

The job ID for the source job.

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

The maximum number of retries for a job.

" } + }, + "sourceJobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "

The job ID for the source job.

" + } } }, "traits": { @@ -11651,6 +11685,125 @@ "smithy.api#output": {} } }, + "com.amazonaws.deadline#ListJobParameterDefinitions": { + "type": "operation", + "input": { + "target": "com.amazonaws.deadline#ListJobParameterDefinitionsRequest" + }, + "output": { + "target": "com.amazonaws.deadline#ListJobParameterDefinitionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.deadline#AccessDeniedException" + }, + { + "target": "com.amazonaws.deadline#InternalServerErrorException" + }, + { + "target": "com.amazonaws.deadline#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.deadline#ThrottlingException" + }, + { + "target": "com.amazonaws.deadline#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "name": "ListJobParameterDefinitions", + "documentation": "Grants permission to get a job's parameter definitions in the job template", + "requiredActions": [ + "identitystore:ListGroupMembershipsForMember" + ] + }, + "smithy.api#documentation": "

Lists parameter definitions of a job.

", + "smithy.api#endpoint": { + "hostPrefix": "management." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/parameter-definitions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobParameterDefinitions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.deadline#ListJobParameterDefinitionsRequest": { + "type": "structure", + "members": { + "farmId": { + "target": "com.amazonaws.deadline#FarmId", + "traits": { + "smithy.api#documentation": "

The farm ID of the job to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.deadline#JobId", + "traits": { + "smithy.api#documentation": "

The job ID to include on the list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "queueId": { + "target": "com.amazonaws.deadline#QueueId", + "traits": { + "smithy.api#documentation": "

The queue ID to include on the list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.deadline#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null to start from the beginning.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.deadline#MaxResults", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.deadline#ListJobParameterDefinitionsResponse": { + "type": "structure", + "members": { + "jobParameterDefinitions": { + "target": "com.amazonaws.deadline#JobParameterDefinitions", + "traits": { + "smithy.api#documentation": "

Lists parameter definitions of a job.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.deadline#String", + "traits": { + "smithy.api#documentation": "

If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.deadline#ListJobs": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index bb9e216b376..b1b8c395d1d 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -336,6 +336,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnership": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnershipRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnershipResult" + }, + "traits": { + "smithy.api#documentation": "

Accepts a request to assign billing of the available capacity of a shared Capacity Reservation to your \n\t\t\taccount. For more information, see \n\t\t\t\tBilling assignment for shared Amazon EC2 Capacity Reservations.

" + } + }, + "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnershipRequest": { + "type": "structure", + "members": { + "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, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation for which to accept the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnershipResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuote": { "type": "operation", "input": { @@ -879,6 +929,16 @@ } } }, + "com.amazonaws.ec2#AccountID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.ec2#ActiveInstance": { "type": "structure", "members": { @@ -1150,22 +1210,6 @@ "com.amazonaws.ec2#Address": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance that the address is associated with (if any).

", - "smithy.api#xmlName": "instanceId" - } - }, - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" - } - }, "AllocationId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -1261,6 +1305,22 @@ "smithy.api#documentation": "

The carrier IP address associated. This option is only available for network interfaces\n which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

", "smithy.api#xmlName": "carrierIp" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance that the address is associated with (if any).

", + "smithy.api#xmlName": "instanceId" + } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } } }, "traits": { @@ -1587,14 +1647,6 @@ "smithy.api#documentation": "

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 \n select an address from the address pool. Alternatively, specify a specific \n address from the address pool.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -1605,7 +1657,15 @@ "IpamPoolId": { "target": "com.amazonaws.ec2#IpamPoolId", "traits": { - "smithy.api#documentation": "

The ID of an IPAM pool.

" + "smithy.api#documentation": "

The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see Allocate sequential Elastic IP addresses from an IPAM pool in the Amazon VPC IPAM User Guide.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" } } }, @@ -1616,14 +1676,6 @@ "com.amazonaws.ec2#AllocateAddressResult": { "type": "structure", "members": { - "PublicIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#xmlName": "publicIp" - } - }, "AllocationId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -1679,6 +1731,14 @@ "smithy.api#documentation": "

The carrier IP address. This option is only available for network interfaces that reside\n in a subnet in a Wavelength Zone.

", "smithy.api#xmlName": "carrierIp" } + }, + "PublicIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

The Elastic IP address.

", + "smithy.api#xmlName": "publicIp" + } } }, "traits": { @@ -1700,54 +1760,12 @@ "com.amazonaws.ec2#AllocateHostsRequest": { "type": "structure", "members": { - "AutoPlacement": { - "target": "com.amazonaws.ec2#AutoPlacement", - "traits": { - "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.

\n

Default: off\n

", - "smithy.api#xmlName": "autoPlacement" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Availability Zone in which to allocate the Dedicated Host.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "availabilityZone" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", - "smithy.api#xmlName": "clientToken" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.

\n

If you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

", - "smithy.api#xmlName": "instanceType" - } - }, "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

Specifies the instance family to be supported by the Dedicated Hosts. If you specify\n an instance family, the Dedicated Hosts support multiple instance types within that\n instance family.

\n

If you want the Dedicated Hosts to support a specific instance type only, omit this\n parameter and specify InstanceType instead. You cannot\n specify InstanceFamily and InstanceType in the same request.

" } }, - "Quantity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Quantity", - "smithy.api#documentation": "

The number of Dedicated Hosts to allocate to your account with these parameters. If you are \n allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, \n you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each \n specified hardware asset. If you specify both AssetIds and \n Quantity, then the value that you specify for \n Quantity must be equal to the number of asset IDs specified.

", - "smithy.api#xmlName": "quantity" - } - }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -1779,6 +1797,48 @@ "smithy.api#documentation": "

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting \n specific hardware assets on an Outpost can help to minimize latency between your workloads. \n This parameter is supported only if you specify OutpostArn. \n If you are allocating the Dedicated Hosts in a Region, omit this parameter.

\n
    \n
  • \n

    If you specify this parameter, you can omit Quantity. \n In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware \n asset.

    \n
    • \n
  • \n

    If you specify both AssetIds and \n Quantity, then the value for \n Quantity must be equal to the number of asset IDs \n specified.

    \n
    • \n
", "smithy.api#xmlName": "AssetId" } + }, + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Indicates whether the host accepts any untargeted instance launches that match its\n instance type configuration, or if it only accepts Host tenancy instance launches that\n specify its unique host ID. For more information, see Understanding auto-placement and affinity in the\n Amazon EC2 User Guide.

\n

Default: off\n

", + "smithy.api#xmlName": "autoPlacement" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", + "smithy.api#xmlName": "clientToken" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an\n instance type, the Dedicated Hosts support instances of the specified instance type\n only.

\n

If you want the Dedicated Hosts to support multiple instance types in a specific\n instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the\n same request.

", + "smithy.api#xmlName": "instanceType" + } + }, + "Quantity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Quantity", + "smithy.api#documentation": "

The number of Dedicated Hosts to allocate to your account with these parameters. If you are \n allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, \n you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each \n specified hardware asset. If you specify both AssetIds and \n Quantity, then the value that you specify for \n Quantity must be equal to the number of asset IDs specified.

", + "smithy.api#xmlName": "quantity" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Availability Zone in which to allocate the Dedicated Host.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "availabilityZone" + } } }, "traits": { @@ -2144,6 +2204,9 @@ { "target": "com.amazonaws.ec2#AcceptAddressTransfer" }, + { + "target": "com.amazonaws.ec2#AcceptCapacityReservationBillingOwnership" + }, { "target": "com.amazonaws.ec2#AcceptReservedInstancesExchangeQuote" }, @@ -2189,6 +2252,9 @@ { "target": "com.amazonaws.ec2#AssociateAddress" }, + { + "target": "com.amazonaws.ec2#AssociateCapacityReservationBillingOwner" + }, { "target": "com.amazonaws.ec2#AssociateClientVpnTargetNetwork" }, @@ -2837,6 +2903,9 @@ { "target": "com.amazonaws.ec2#DescribeCapacityBlockOfferings" }, + { + "target": "com.amazonaws.ec2#DescribeCapacityReservationBillingRequests" + }, { "target": "com.amazonaws.ec2#DescribeCapacityReservationFleets" }, @@ -3332,6 +3401,9 @@ { "target": "com.amazonaws.ec2#DisassociateAddress" }, + { + "target": "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwner" + }, { "target": "com.amazonaws.ec2#DisassociateClientVpnTargetNetwork" }, @@ -3659,6 +3731,9 @@ { "target": "com.amazonaws.ec2#ModifyInstanceCapacityReservationAttributes" }, + { + "target": "com.amazonaws.ec2#ModifyInstanceCpuOptions" + }, { "target": "com.amazonaws.ec2#ModifyInstanceCreditSpecification" }, @@ -3860,6 +3935,9 @@ { "target": "com.amazonaws.ec2#RegisterTransitGatewayMulticastGroupSources" }, + { + "target": "com.amazonaws.ec2#RejectCapacityReservationBillingOwnership" + }, { "target": "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociations" }, @@ -5915,22 +5993,6 @@ "com.amazonaws.ec2#AssignIpv6AddressesRequest": { "type": "structure", "members": { - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#documentation": "

The number of additional IPv6 addresses to assign to the network interface. \n \t\tThe specified number of IPv6 addresses are assigned in addition to the \n \t\texisting IPv6 addresses that are already assigned to the network interface. \n \t\tAmazon EC2 automatically selects the IPv6 addresses from the subnet range. You \n \t\tcan't use this option if specifying specific IPv6 addresses.

", - "smithy.api#xmlName": "ipv6AddressCount" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#Ipv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", - "smithy.api#xmlName": "ipv6Addresses" - } - }, "Ipv6PrefixCount": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -5953,6 +6015,22 @@ "smithy.api#required": {}, "smithy.api#xmlName": "networkInterfaceId" } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", + "smithy.api#xmlName": "ipv6Addresses" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

The number of additional IPv6 addresses to assign to the network interface. \n \t\tThe specified number of IPv6 addresses are assigned in addition to the \n \t\texisting IPv6 addresses that are already assigned to the network interface. \n \t\tAmazon EC2 automatically selects the IPv6 addresses from the subnet range. You \n \t\tcan't use this option if specifying specific IPv6 addresses.

", + "smithy.api#xmlName": "ipv6AddressCount" + } } }, "traits": { @@ -6026,12 +6104,17 @@ "com.amazonaws.ec2#AssignPrivateIpAddressesRequest": { "type": "structure", "members": { - "AllowReassignment": { - "target": "com.amazonaws.ec2#Boolean", + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", "traits": { - "aws.protocols#ec2QueryName": "AllowReassignment", - "smithy.api#documentation": "

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", - "smithy.api#xmlName": "allowReassignment" + "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, + "Ipv4PrefixCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" } }, "NetworkInterfaceId": { @@ -6060,17 +6143,12 @@ "smithy.api#xmlName": "secondaryPrivateIpAddressCount" } }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#IpPrefixList", - "traits": { - "smithy.api#documentation": "

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", - "smithy.api#xmlName": "Ipv4Prefix" - } - }, - "Ipv4PrefixCount": { - "target": "com.amazonaws.ec2#Integer", + "AllowReassignment": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" + "aws.protocols#ec2QueryName": "AllowReassignment", + "smithy.api#documentation": "

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "smithy.api#xmlName": "allowReassignment" } } }, @@ -6120,7 +6198,7 @@ "target": "com.amazonaws.ec2#AssignPrivateNatGatewayAddressResult" }, "traits": { - "smithy.api#documentation": "

Assigns private IPv4 addresses to a private NAT gateway. For more information, see \n Work with NAT gateways in the Amazon VPC User Guide.

" + "smithy.api#documentation": "

Assigns private IPv4 addresses to a private NAT gateway. For more information, see \n Work with NAT gateways in the Amazon VPC User Guide.

" } }, "com.amazonaws.ec2#AssignPrivateNatGatewayAddressRequest": { @@ -6264,14 +6342,6 @@ "smithy.api#documentation": "

Deprecated.

" } }, - "AllowReassociation": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AllowReassociation", - "smithy.api#documentation": "

Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", - "smithy.api#xmlName": "allowReassociation" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -6295,6 +6365,14 @@ "smithy.api#documentation": "

The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "smithy.api#xmlName": "privateIpAddress" } + }, + "AllowReassociation": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AllowReassociation", + "smithy.api#documentation": "

Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "smithy.api#xmlName": "allowReassociation" + } } }, "traits": { @@ -6317,6 +6395,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#AssociateCapacityReservationBillingOwner": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#AssociateCapacityReservationBillingOwnerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#AssociateCapacityReservationBillingOwnerResult" + }, + "traits": { + "smithy.api#documentation": "

Initiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer \n\t\t\taccount that is consolidated under the same Amazon Web Services organizations payer account. For more information, see \n\t\t\tBilling assignment for shared \n\t\t\t\tAmazon EC2 Capacity Reservations.

" + } + }, + "com.amazonaws.ec2#AssociateCapacityReservationBillingOwnerRequest": { + "type": "structure", + "members": { + "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, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "UnusedReservationBillingOwnerId": { + "target": "com.amazonaws.ec2#AccountID", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the consumer account to which to assign billing.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#AssociateCapacityReservationBillingOwnerResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#AssociateClientVpnTargetNetwork": { "type": "operation", "input": { @@ -6798,7 +6934,7 @@ "target": "com.amazonaws.ec2#AssociateNatGatewayAddressResult" }, "traits": { - "smithy.api#documentation": "

Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, \n see Work with NAT gateways in the Amazon VPC User Guide.

\n

By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. \n For more information, see Elastic IP address quotas in the Amazon VPC User Guide.

\n \n

When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. \n

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

Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, \n see Work with NAT gateways in the Amazon VPC User Guide.

\n

By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. \n For more information, see Elastic IP address quotas in the Amazon VPC User Guide.

\n \n

When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs \n must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, \n the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet.\n Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information \n about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. \n

\n " } }, "com.amazonaws.ec2#AssociateNatGatewayAddressRequest": { @@ -6891,6 +7027,12 @@ "com.amazonaws.ec2#AssociateRouteTableRequest": { "type": "structure", "members": { + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -6899,16 +7041,6 @@ "smithy.api#xmlName": "dryRun" } }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" - } - }, "SubnetId": { "target": "com.amazonaws.ec2#SubnetId", "traits": { @@ -6917,10 +7049,14 @@ "smithy.api#xmlName": "subnetId" } }, - "GatewayId": { - "target": "com.amazonaws.ec2#RouteGatewayId", + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", "traits": { - "smithy.api#documentation": "

The ID of the internet gateway or virtual private gateway.

" + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" } } }, @@ -6967,12 +7103,16 @@ "com.amazonaws.ec2#AssociateSubnetCidrBlockRequest": { "type": "structure", "members": { - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", + "Ipv6IpamPoolId": { + "target": "com.amazonaws.ec2#IpamPoolId", "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block for your subnet.

", - "smithy.api#xmlName": "ipv6CidrBlock" + "smithy.api#documentation": "

An IPv6 IPAM pool ID.

" + } + }, + "Ipv6NetmaskLength": { + "target": "com.amazonaws.ec2#NetmaskLength", + "traits": { + "smithy.api#documentation": "

An IPv6 netmask length.

" } }, "SubnetId": { @@ -6985,16 +7125,12 @@ "smithy.api#xmlName": "subnetId" } }, - "Ipv6IpamPoolId": { - "target": "com.amazonaws.ec2#IpamPoolId", - "traits": { - "smithy.api#documentation": "

An IPv6 IPAM pool ID.

" - } - }, - "Ipv6NetmaskLength": { - "target": "com.amazonaws.ec2#NetmaskLength", + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

An IPv6 netmask length.

" + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block for your subnet.

", + "smithy.api#xmlName": "ipv6CidrBlock" } } }, @@ -7308,30 +7444,12 @@ "com.amazonaws.ec2#AssociateVpcCidrBlockRequest": { "type": "structure", "members": { - "AmazonProvidedIpv6CidrBlock": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", - "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You\n cannot specify the range of IPv6 addresses or the size of the CIDR block.

", - "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" - } - }, "CidrBlock": { "target": "com.amazonaws.ec2#String", "traits": { "smithy.api#documentation": "

An IPv4 CIDR block to associate with the VPC.

" } }, - "VpcId": { - "target": "com.amazonaws.ec2#VpcId", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "vpcId" - } - }, "Ipv6CidrBlockNetworkBorderGroup": { "target": "com.amazonaws.ec2#String", "traits": { @@ -7373,6 +7491,24 @@ "traits": { "smithy.api#documentation": "

The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "vpcId" + } + }, + "AmazonProvidedIpv6CidrBlock": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", + "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You\n cannot specify the range of IPv6 addresses or the size of the CIDR block.

", + "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" + } } }, "traits": { @@ -7646,15 +7782,6 @@ "smithy.api#xmlName": "dryRun" } }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdStringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the security groups. You cannot specify security groups from a different VPC.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "SecurityGroupId" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#InstanceId", "traits": { @@ -7674,6 +7801,15 @@ "smithy.api#required": {}, "smithy.api#xmlName": "vpcId" } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the security groups. You cannot specify security groups from a different VPC.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "SecurityGroupId" + } } }, "traits": { @@ -7783,14 +7919,16 @@ "com.amazonaws.ec2#AttachNetworkInterfaceRequest": { "type": "structure", "members": { - "DeviceIndex": { + "NetworkCardIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "DeviceIndex", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The index of the device for the network interface attachment.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "deviceIndex" + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

" + } + }, + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#EnaSrdSpecification", + "traits": { + "smithy.api#documentation": "

Configures ENA Express for the network interface that this action attaches to the instance.

" } }, "DryRun": { @@ -7801,16 +7939,6 @@ "smithy.api#xmlName": "dryRun" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" - } - }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { @@ -7821,16 +7949,24 @@ "smithy.api#xmlName": "networkInterfaceId" } }, - "NetworkCardIndex": { - "target": "com.amazonaws.ec2#Integer", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" } }, - "EnaSrdSpecification": { - "target": "com.amazonaws.ec2#EnaSrdSpecification", + "DeviceIndex": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

Configures ENA Express for the network interface that this action attaches to the instance.

" + "aws.protocols#ec2QueryName": "DeviceIndex", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The index of the device for the network interface attachment.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "deviceIndex" } } }, @@ -8016,7 +8152,7 @@ "target": "com.amazonaws.ec2#AttachVpnGatewayResult" }, "traits": { - "smithy.api#documentation": "

Attaches a virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" + "smithy.api#documentation": "

Attaches an available virtual private gateway to a VPC. You can attach one virtual private\n gateway to one VPC at a time.

\n

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN\n User Guide.

" } }, "com.amazonaws.ec2#AttachVpnGatewayRequest": { @@ -8375,6 +8511,13 @@ "com.amazonaws.ec2#AuthorizeSecurityGroupEgressRequest": { "type": "structure", "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags applied to the security group rule.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -8393,27 +8536,28 @@ "smithy.api#xmlName": "groupId" } }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IpPermissions", - "smithy.api#documentation": "

The permissions for the security group rules.

", - "smithy.api#xmlName": "ipPermissions" + "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", + "smithy.api#xmlName": "sourceSecurityGroupName" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The tags applied to the security group rule.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", + "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", + "smithy.api#xmlName": "sourceSecurityGroupOwnerId" } }, - "CidrIp": { + "IpProtocol": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CidrIp", + "aws.protocols#ec2QueryName": "IpProtocol", "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", - "smithy.api#xmlName": "cidrIp" + "smithy.api#xmlName": "ipProtocol" } }, "FromPort": { @@ -8424,14 +8568,6 @@ "smithy.api#xmlName": "fromPort" } }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", - "smithy.api#xmlName": "ipProtocol" - } - }, "ToPort": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -8440,20 +8576,20 @@ "smithy.api#xmlName": "toPort" } }, - "SourceSecurityGroupName": { + "CidrIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "aws.protocols#ec2QueryName": "CidrIp", "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", - "smithy.api#xmlName": "sourceSecurityGroupName" + "smithy.api#xmlName": "cidrIp" } }, - "SourceSecurityGroupOwnerId": { - "target": "com.amazonaws.ec2#String", + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", - "smithy.api#documentation": "

Not supported. Use IP permissions instead.

", - "smithy.api#xmlName": "sourceSecurityGroupOwnerId" + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The permissions for the security group rules.

", + "smithy.api#xmlName": "ipPermissions" } } }, @@ -8619,6 +8755,13 @@ "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). \n If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

\n

To specify multiple rules and descriptions for the rules, use IP permissions instead.

" } }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags applied to the security group rule.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -8626,13 +8769,6 @@ "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.

", "smithy.api#xmlName": "dryRun" } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags applied to the security group rule.

", - "smithy.api#xmlName": "TagSpecification" - } } }, "traits": { @@ -8720,14 +8856,6 @@ "com.amazonaws.ec2#AvailabilityZone": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#AvailabilityZoneState", - "traits": { - "aws.protocols#ec2QueryName": "ZoneState", - "smithy.api#documentation": "

The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always\n available.

", - "smithy.api#xmlName": "zoneState" - } - }, "OptInStatus": { "target": "com.amazonaws.ec2#AvailabilityZoneOptInStatus", "traits": { @@ -8807,6 +8935,14 @@ "smithy.api#documentation": "

The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane\n operations, such as API calls.

", "smithy.api#xmlName": "parentZoneId" } + }, + "State": { + "target": "com.amazonaws.ec2#AvailabilityZoneState", + "traits": { + "aws.protocols#ec2QueryName": "ZoneState", + "smithy.api#documentation": "

The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always\n available.

", + "smithy.api#xmlName": "zoneState" + } } }, "traits": { @@ -9126,22 +9262,6 @@ "com.amazonaws.ec2#BlockDeviceMapping": { "type": "structure", "members": { - "DeviceName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", - "smithy.api#xmlName": "deviceName" - } - }, - "VirtualName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VirtualName", - "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", - "smithy.api#xmlName": "virtualName" - } - }, "Ebs": { "target": "com.amazonaws.ec2#EbsBlockDevice", "traits": { @@ -9157,6 +9277,22 @@ "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string. When this\n property is specified, the device is removed from the block device mapping regardless of\n the assigned value.

", "smithy.api#xmlName": "noDevice" } + }, + "DeviceName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The device name (for example, /dev/sdh or xvdh).

", + "smithy.api#xmlName": "deviceName" + } + }, + "VirtualName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VirtualName", + "smithy.api#documentation": "

The virtual device name (ephemeralN). Instance store volumes are numbered\n starting from 0. An instance type with 2 available instance store volumes can specify\n mappings for ephemeral0 and ephemeral1. The number of\n available instance store volumes depends on the instance type. After you connect to the\n instance, you must mount the volume.

\n

NVMe instance store volumes are automatically enumerated and assigned a device name.\n Including them in your block device mapping has no effect.

\n

Constraints: For M3 instances, you must specify instance store volumes in the block\n device mapping for the instance. When you launch an M3 instance, we ignore any instance\n store volumes specified in the block device mapping for the AMI.

", + "smithy.api#xmlName": "virtualName" + } } }, "traits": { @@ -9316,22 +9452,6 @@ "com.amazonaws.ec2#BundleTask": { "type": "structure", "members": { - "BundleId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "BundleId", - "smithy.api#documentation": "

The ID of the bundle task.

", - "smithy.api#xmlName": "bundleId" - } - }, - "BundleTaskError": { - "target": "com.amazonaws.ec2#BundleTaskError", - "traits": { - "aws.protocols#ec2QueryName": "Error", - "smithy.api#documentation": "

If the task fails, a description of the error.

", - "smithy.api#xmlName": "error" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -9340,12 +9460,20 @@ "smithy.api#xmlName": "instanceId" } }, - "Progress": { + "BundleId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The level of task completion, as a percent (for example, 20%).

", - "smithy.api#xmlName": "progress" + "aws.protocols#ec2QueryName": "BundleId", + "smithy.api#documentation": "

The ID of the bundle task.

", + "smithy.api#xmlName": "bundleId" + } + }, + "State": { + "target": "com.amazonaws.ec2#BundleTaskState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the task.

", + "smithy.api#xmlName": "state" } }, "StartTime": { @@ -9356,12 +9484,12 @@ "smithy.api#xmlName": "startTime" } }, - "State": { - "target": "com.amazonaws.ec2#BundleTaskState", + "UpdateTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the task.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "UpdateTime", + "smithy.api#documentation": "

The time of the most recent update for the task.

", + "smithy.api#xmlName": "updateTime" } }, "Storage": { @@ -9372,12 +9500,20 @@ "smithy.api#xmlName": "storage" } }, - "UpdateTime": { - "target": "com.amazonaws.ec2#DateTime", + "Progress": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UpdateTime", - "smithy.api#documentation": "

The time of the most recent update for the task.

", - "smithy.api#xmlName": "updateTime" + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The level of task completion, as a percent (for example, 20%).

", + "smithy.api#xmlName": "progress" + } + }, + "BundleTaskError": { + "target": "com.amazonaws.ec2#BundleTaskError", + "traits": { + "aws.protocols#ec2QueryName": "Error", + "smithy.api#documentation": "

If the task fails, a description of the error.

", + "smithy.api#xmlName": "error" } } }, @@ -9658,6 +9794,23 @@ } } }, + "com.amazonaws.ec2#CallerRole": { + "type": "enum", + "members": { + "odcr_owner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "odcr-owner" + } + }, + "unused_reservation_billing_owner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unused-reservation-billing-owner" + } + } + } + }, "com.amazonaws.ec2#CancelBatchErrorCode": { "type": "enum", "members": { @@ -9883,6 +10036,14 @@ "com.amazonaws.ec2#CancelConversionRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } + }, "ConversionTaskId": { "target": "com.amazonaws.ec2#ConversionTaskId", "traits": { @@ -9893,14 +10054,6 @@ "smithy.api#xmlName": "conversionTaskId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "ReasonMessage": { "target": "com.amazonaws.ec2#String", "traits": { @@ -10802,12 +10955,134 @@ "smithy.api#documentation": "

The type of Capacity Reservation.

", "smithy.api#xmlName": "reservationType" } + }, + "UnusedReservationBillingOwnerId": { + "target": "com.amazonaws.ec2#AccountID", + "traits": { + "aws.protocols#ec2QueryName": "UnusedReservationBillingOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account to which billing of the unused capacity \n\t\t\tof the Capacity Reservation is assigned.

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

Describes a Capacity Reservation.

" } }, + "com.amazonaws.ec2#CapacityReservationBillingRequest": { + "type": "structure", + "members": { + "CapacityReservationId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationId", + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "capacityReservationId" + } + }, + "RequestedBy": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RequestedBy", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that initiated the request.

", + "smithy.api#xmlName": "requestedBy" + } + }, + "UnusedReservationBillingOwnerId": { + "target": "com.amazonaws.ec2#AccountID", + "traits": { + "aws.protocols#ec2QueryName": "UnusedReservationBillingOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account to which the request was sent.

", + "smithy.api#xmlName": "unusedReservationBillingOwnerId" + } + }, + "LastUpdateTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "LastUpdateTime", + "smithy.api#documentation": "

The date and time, in UTC time format, at which the request was initiated.

", + "smithy.api#xmlName": "lastUpdateTime" + } + }, + "Status": { + "target": "com.amazonaws.ec2#CapacityReservationBillingRequestStatus", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The status of the request. For more information, see \n\t\t\tView billing assignment requests for a shared Amazon EC2 Capacity Reservation.

", + "smithy.api#xmlName": "status" + } + }, + "StatusMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StatusMessage", + "smithy.api#documentation": "

Information about the status.

", + "smithy.api#xmlName": "statusMessage" + } + }, + "CapacityReservationInfo": { + "target": "com.amazonaws.ec2#CapacityReservationInfo", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationInfo", + "smithy.api#documentation": "

Information about the Capacity Reservation.

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

Information about a request to assign billing of the unused capacity of a Capacity Reservation.

" + } + }, + "com.amazonaws.ec2#CapacityReservationBillingRequestSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#CapacityReservationBillingRequest", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#CapacityReservationBillingRequestStatus": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "accepted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "accepted" + } + }, + "rejected": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rejected" + } + }, + "cancelled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cancelled" + } + }, + "revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoked" + } + }, + "expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + } + } + }, "com.amazonaws.ec2#CapacityReservationFleet": { "type": "structure", "members": { @@ -11078,6 +11353,38 @@ } } }, + "com.amazonaws.ec2#CapacityReservationInfo": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type for the Capacity Reservation.

", + "smithy.api#xmlName": "instanceType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#AvailabilityZoneName", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the Capacity Reservation.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Tenancy": { + "target": "com.amazonaws.ec2#CapacityReservationTenancy", + "traits": { + "aws.protocols#ec2QueryName": "Tenancy", + "smithy.api#documentation": "

The tenancy of the Capacity Reservation.

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

Information about a Capacity Reservation.

" + } + }, "com.amazonaws.ec2#CapacityReservationInstancePlatform": { "type": "enum", "members": { @@ -12976,7 +13283,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

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

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } } @@ -12988,14 +13295,6 @@ "com.amazonaws.ec2#ConfirmProductInstanceResult": { "type": "structure", "members": { - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the instance owner. This is only present if the\n product code is attached to the instance.

", - "smithy.api#xmlName": "ownerId" - } - }, "Return": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -13003,6 +13302,14 @@ "smithy.api#documentation": "

The return value of the request. Returns true if the specified product\n code is owned by the requester and associated with the specified instance.

", "smithy.api#xmlName": "return" } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the instance owner. This is only present if the\n product code is attached to the instance.

", + "smithy.api#xmlName": "ownerId" + } } }, "traits": { @@ -13605,14 +13912,6 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only \n \t\tspecify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. \n \t\tThe AMI must be in the Region of the destination Outpost. You cannot copy an \n \t\tAMI from an Outpost to a Region, from one Outpost to another, or within the same \n \t\tOutpost.

\n

For more information, see Copy AMIs from an Amazon Web Services\n Region to an Outpost in the Amazon EBS User Guide.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, "CopyImageTags": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -13625,6 +13924,14 @@ "smithy.api#documentation": "

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or\n both.

\n
    \n
  • \n

    To tag the new AMI, the value for ResourceType must be\n image.

    \n
    • \n
  • \n

    To tag the new snapshots, the value for ResourceType must be\n snapshot. The same tag is applied to all the new snapshots.

    \n
    • \n
\n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", "smithy.api#xmlName": "TagSpecification" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } } }, "traits": { @@ -13768,14 +14075,6 @@ "com.amazonaws.ec2#CopySnapshotResult": { "type": "structure", "members": { - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The ID of the new snapshot.

", - "smithy.api#xmlName": "snapshotId" - } - }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -13783,6 +14082,14 @@ "smithy.api#documentation": "

Any tags applied to the new snapshot.

", "smithy.api#xmlName": "tagSet" } + }, + "SnapshotId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The ID of the new snapshot.

", + "smithy.api#xmlName": "snapshotId" + } } }, "traits": { @@ -14821,6 +15128,12 @@ "smithy.api#documentation": "

IPv4 address for the customer gateway device's outside interface. The address must be\n static. If OutsideIpAddressType in your VPN connection options is set to\n PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If\n OutsideIpAddressType is set to PublicIpv4, you can use a\n public IPv4 address.

" } }, + "BgpAsnExtended": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

\n

Valid values: 2,147,483,648 to 4,294,967,295\n

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -14828,12 +15141,6 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } - }, - "BgpAsnExtended": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "smithy.api#documentation": "

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

\n

Valid values: 2,147,483,648 to 4,294,967,295\n

" - } } }, "traits": { @@ -14867,7 +15174,7 @@ "target": "com.amazonaws.ec2#CreateDefaultSubnetResult" }, "traits": { - "smithy.api#documentation": "

Creates a default subnet with a size /20 IPv4 CIDR block in the\n specified Availability Zone in your default VPC. You can have only one default subnet\n per Availability Zone. For more information, see Create a default\n subnet in the Amazon VPC User Guide.

" + "smithy.api#documentation": "

Creates a default subnet with a size /20 IPv4 CIDR block in the\n specified Availability Zone in your default VPC. You can have only one default subnet\n per Availability Zone. For more information, see Create a default\n subnet in the Amazon VPC User Guide.

" } }, "com.amazonaws.ec2#CreateDefaultSubnetRequest": { @@ -15223,7 +15530,7 @@ "target": "com.amazonaws.ec2#PlatformValues", "traits": { "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

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

The value is windows for Windows instances in an EC2 Fleet. Otherwise, the value is\n blank.

", "smithy.api#xmlName": "platform" } } @@ -15379,7 +15686,7 @@ "target": "com.amazonaws.ec2#CreateFlowLogsResult" }, "traits": { - "smithy.api#documentation": "

Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.

\n

Flow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon VPC User Guide.

\n

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.

\n

For more information, see VPC Flow Logs \n in the Amazon VPC User Guide.

" + "smithy.api#documentation": "

Creates one or more flow logs to capture information about IP traffic for a specific network interface,\n subnet, or VPC.

\n

Flow log data for a monitored network interface is recorded as flow log records, which are log events \n consisting of fields that describe the traffic flow. For more information, see \n Flow log records \n in the Amazon VPC User Guide.

\n

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network \n interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all \n of the monitored network interfaces are published to a single log file object that is stored in the specified \n bucket.

\n

For more information, see VPC Flow Logs \n in the Amazon VPC User Guide.

" } }, "com.amazonaws.ec2#CreateFlowLogsRequest": { @@ -15453,7 +15760,7 @@ "LogFormat": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log\n records in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

\n

Specify the fields using the ${field-id} format, separated by spaces.

" + "smithy.api#documentation": "

The fields to include in the flow log record. List the fields in the order in which\n they should appear. If you omit this parameter, the flow log is created using the\n default format. If you specify this parameter, you must include at least one\n field. For more information about the available fields, see Flow log records \n in the Amazon VPC User Guide or Transit Gateway Flow Log\n records in the Amazon Web Services Transit Gateway Guide.

\n

Specify the fields using the ${field-id} format, separated by spaces.

" } }, "TagSpecifications": { @@ -15616,20 +15923,11 @@ "com.amazonaws.ec2#CreateImageRequest": { "type": "structure", "members": { - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mappings.

\n

When using the CreateImage action:

\n
    \n
  • \n

    You can't change the volume size using the VolumeSize parameter. If you want a\n different volume size, you must first change the volume size of the source\n instance.

    \n
    • \n
  • \n

    You can't modify the encryption status of existing volumes or snapshots. To create an\n AMI with volumes or snapshots that have a different encryption status (for example, where\n the source volume and snapshots are unencrypted, and you want to create an AMI with\n encrypted volumes or snapshots), use the CopyImage action.

    \n
    • \n
  • \n

    The only option that can be changed for existing mappings or snapshots is\n DeleteOnTermination.

    \n
    • \n
", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "Description": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the new image.

", - "smithy.api#xmlName": "description" + "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.

\n
    \n
  • \n

    To tag the AMI, the value for ResourceType must be\n image.

    \n
    • \n
  • \n

    To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that\n are attached to the instance, the value for ResourceType must be\n snapshot. The same tag is applied to all of the snapshots that are\n created.

    \n
    • \n
\n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" } }, "DryRun": { @@ -15660,6 +15958,14 @@ "smithy.api#xmlName": "name" } }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the new image.

", + "smithy.api#xmlName": "description" + } + }, "NoReboot": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -15668,11 +15974,12 @@ "smithy.api#xmlName": "noReboot" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", "traits": { - "smithy.api#documentation": "

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the\n snapshots, or both.

\n
    \n
  • \n

    To tag the AMI, the value for ResourceType must be\n image.

    \n
    • \n
  • \n

    To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that\n are attached to the instance, the value for ResourceType must be\n snapshot. The same tag is applied to all of the snapshots that are\n created.

    \n
    • \n
\n

If you specify other values for ResourceType, the request fails.

\n

To tag an AMI or snapshot after it has been created, see CreateTags.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mappings.

\n

When using the CreateImage action:

\n
    \n
  • \n

    You can't change the volume size using the VolumeSize parameter. If you want a\n different volume size, you must first change the volume size of the source\n instance.

    \n
    • \n
  • \n

    You can't modify the encryption status of existing volumes or snapshots. To create an\n AMI with volumes or snapshots that have a different encryption status (for example, where\n the source volume and snapshots are unencrypted, and you want to create an AMI with\n encrypted volumes or snapshots), use the CopyImage action.

    \n
    • \n
  • \n

    The only option that can be changed for existing mappings or snapshots is\n DeleteOnTermination.

    \n
    • \n
", + "smithy.api#xmlName": "blockDeviceMapping" } } }, @@ -15864,6 +16171,13 @@ "com.amazonaws.ec2#CreateInstanceExportTaskRequest": { "type": "structure", "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the export instance task during creation.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -15872,16 +16186,6 @@ "smithy.api#xmlName": "description" } }, - "ExportToS3Task": { - "target": "com.amazonaws.ec2#ExportToS3TaskSpecification", - "traits": { - "aws.protocols#ec2QueryName": "ExportToS3", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The format and location for an export instance task.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "exportToS3" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#InstanceId", "traits": { @@ -15902,11 +16206,14 @@ "smithy.api#xmlName": "targetEnvironment" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "ExportToS3Task": { + "target": "com.amazonaws.ec2#ExportToS3TaskSpecification", "traits": { - "smithy.api#documentation": "

The tags to apply to the export instance task during creation.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "ExportToS3", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The format and location for an export instance task.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "exportToS3" } } }, @@ -16102,7 +16409,7 @@ "Locale": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The locale for the pool should be one of the following:

\n
    \n
  • \n

    An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

    \n
    • \n
  • \n

    The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.

    \n
    • \n
\n

If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

\n

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

" + "smithy.api#documentation": "

The locale for the pool should be one of the following:

\n
    \n
  • \n

    An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

    \n
    • \n
  • \n

    The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.

    \n
    • \n
\n

If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

\n

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone. Default is none and means any locale.

" } }, "SourceIpamPoolId": { @@ -16455,14 +16762,6 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "KeyType": { "target": "com.amazonaws.ec2#KeyType", "traits": { @@ -16481,6 +16780,14 @@ "traits": { "smithy.api#documentation": "

The format of the key pair.

\n

Default: pem\n

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } } }, "traits": { @@ -17113,7 +17420,7 @@ "target": "com.amazonaws.ec2#CreateNatGatewayResult" }, "traits": { - "smithy.api#documentation": "

Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.

\n

With a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.

\n

With a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.

\n

For more information, see NAT gateways in the Amazon VPC User Guide.

\n \n

When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide. \n

\n ", + "smithy.api#documentation": "

Creates a NAT gateway in the specified subnet. This action creates a network interface\n in the specified subnet with a private IP address from the IP address range of the\n subnet. You can create either a public NAT gateway or a private NAT gateway.

\n

With a public NAT gateway, internet-bound traffic from a private subnet can be routed\n to the NAT gateway, so that instances in a private subnet can connect to the internet.

\n

With a private NAT gateway, private communication is routed across VPCs and on-premises\n networks through a transit gateway or virtual private gateway. Common use cases include\n running large workloads behind a small pool of allowlisted IPv4 addresses, preserving\n private IPv4 addresses, and communicating between overlapping networks.

\n

For more information, see NAT gateways in the Amazon VPC User Guide.

\n \n

When you create a public NAT gateway and assign it an EIP or secondary EIPs, \n the network border group of the EIPs must match the network border group of the Availability Zone (AZ) \n that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. \n You can see the network border group for the subnet's AZ by viewing the details of the subnet. \n Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. \n For more information about network border groups and EIPs, see Allocate an Elastic IP address \n in the Amazon VPC User Guide. \n

\n ", "smithy.api#examples": [ { "title": "To create a NAT gateway", @@ -17192,21 +17499,21 @@ "SecondaryAllocationIds": { "target": "com.amazonaws.ec2#AllocationIdList", "traits": { - "smithy.api#documentation": "

Secondary EIP allocation IDs. For more information, see Create a NAT gateway \n in the Amazon VPC User Guide.

", + "smithy.api#documentation": "

Secondary EIP allocation IDs. For more information, see Create a NAT gateway \n in the Amazon VPC User Guide.

", "smithy.api#xmlName": "SecondaryAllocationId" } }, "SecondaryPrivateIpAddresses": { "target": "com.amazonaws.ec2#IpList", "traits": { - "smithy.api#documentation": "

Secondary private IPv4 addresses. For more information about secondary addresses, see \n Create a NAT gateway in the Amazon VPC User Guide.

", + "smithy.api#documentation": "

Secondary private IPv4 addresses. For more information about secondary addresses, see \n Create a NAT gateway in the Amazon VPC User Guide.

", "smithy.api#xmlName": "SecondaryPrivateIpAddress" } }, "SecondaryPrivateIpAddressCount": { "target": "com.amazonaws.ec2#PrivateIpAddressCount", "traits": { - "smithy.api#documentation": "

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. \n For more information about secondary addresses, see Create a NAT gateway \n in the Amazon VPC User Guide.

" + "smithy.api#documentation": "

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. \n For more information about secondary addresses, see Create a NAT gateway \n in the Amazon VPC User Guide.

" } } }, @@ -17317,14 +17624,6 @@ "com.amazonaws.ec2#CreateNetworkAclEntryRequest": { "type": "structure", "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n\t\t 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", - "smithy.api#xmlName": "cidrBlock" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -17333,31 +17632,6 @@ "smithy.api#xmlName": "dryRun" } }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", - "smithy.api#required": {}, - "smithy.api#xmlName": "egress" - } - }, - "IcmpTypeCode": { - "target": "com.amazonaws.ec2#IcmpTypeCode", - "traits": { - "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol \n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", - "smithy.api#xmlName": "Icmp" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:db8:1234:1a00::/64).

", - "smithy.api#xmlName": "ipv6CidrBlock" - } - }, "NetworkAclId": { "target": "com.amazonaws.ec2#NetworkAclId", "traits": { @@ -17368,12 +17642,14 @@ "smithy.api#xmlName": "networkAclId" } }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.\n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", - "smithy.api#xmlName": "portRange" + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

\n

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" } }, "Protocol": { @@ -17396,14 +17672,45 @@ "smithy.api#xmlName": "ruleAction" } }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", + "Egress": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", + "aws.protocols#ec2QueryName": "Egress", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

\n

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "smithy.api#documentation": "

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "smithy.api#required": {}, - "smithy.api#xmlName": "ruleNumber" + "smithy.api#xmlName": "egress" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n\t\t 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:db8:1234:1a00::/64).

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", + "traits": { + "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol \n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "smithy.api#xmlName": "Icmp" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to.\n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "smithy.api#xmlName": "portRange" } } }, @@ -17414,6 +17721,20 @@ "com.amazonaws.ec2#CreateNetworkAclRequest": { "type": "structure", "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the network ACL.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -17431,20 +17752,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "vpcId" } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the network ACL.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.

", - "smithy.api#idempotencyToken": {} - } } }, "traits": { @@ -17752,69 +18059,6 @@ "com.amazonaws.ec2#CreateNetworkInterfaceRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the network interface.

", - "smithy.api#xmlName": "description" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, - "Groups": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

The IDs of one or more security groups.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, - "Ipv6AddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6AddressCount", - "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.

\n

You can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

\n

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.

", - "smithy.api#xmlName": "ipv6AddressCount" - } - }, - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#InstanceIpv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

\n

You can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

", - "smithy.api#xmlName": "ipv6Addresses" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddresses", - "smithy.api#documentation": "

The private IPv4 addresses.

\n

You can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", - "smithy.api#xmlName": "privateIpAddresses" - } - }, - "SecondaryPrivateIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", - "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", - "smithy.api#xmlName": "secondaryPrivateIpAddressCount" - } - }, "Ipv4Prefixes": { "target": "com.amazonaws.ec2#Ipv4PrefixList", "traits": { @@ -17847,16 +18091,6 @@ "smithy.api#documentation": "

The type of network interface. The default is interface.

\n

The only supported values are interface, efa, and trunk.

" } }, - "SubnetId": { - "target": "com.amazonaws.ec2#SubnetId", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the subnet to associate with the network interface.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "subnetId" - } - }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -17882,6 +18116,79 @@ "traits": { "smithy.api#documentation": "

A connection tracking specification for the network interface.

" } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the subnet to associate with the network interface.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "subnetId" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary private IPv4 address of the network interface. If you don't specify an\n IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you\n specify an IP address, you cannot indicate any IP addresses specified in\n privateIpAddresses as primary (only one IP address can be designated as\n primary).

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", + "traits": { + "smithy.api#documentation": "

The IDs of one or more security groups.

", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.ec2#PrivateIpAddressSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddresses", + "smithy.api#documentation": "

The private IPv4 addresses.

\n

You can't specify private IPv4 addresses if you've specified one of the following:\n a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", + "smithy.api#xmlName": "privateIpAddresses" + } + }, + "SecondaryPrivateIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "SecondaryPrivateIpAddressCount", + "smithy.api#documentation": "

The number of secondary private IPv4 addresses to assign to a network interface. When\n you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses\n within the subnet's IPv4 CIDR range. You can't specify this option and specify more than\n one private IP address using privateIpAddresses.

\n

You can't specify a count of private IPv4 addresses if you've specified one of the following:\n specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", + "smithy.api#xmlName": "secondaryPrivateIpAddressCount" + } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#InstanceIpv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

\n

You can't specify IPv6 addresses using this parameter if you've specified one of the \n following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

", + "smithy.api#xmlName": "ipv6Addresses" + } + }, + "Ipv6AddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6AddressCount", + "smithy.api#documentation": "

The number of IPv6 addresses to assign to a network interface. Amazon EC2\n automatically selects the IPv6 addresses from the subnet range.

\n

You can't specify a count of IPv6 addresses using this parameter if you've specified \n one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

\n

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can\n override that setting by specifying 0 as the IPv6 address count.

", + "smithy.api#xmlName": "ipv6AddressCount" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } } }, "traits": { @@ -17938,11 +18245,30 @@ "com.amazonaws.ec2#CreatePlacementGroupRequest": { "type": "structure", "members": { + "PartitionCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of partitions. Valid only when Strategy is\n set to partition.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the new placement group.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "SpreadLevel": { + "target": "com.amazonaws.ec2#SpreadLevel", + "traits": { + "smithy.api#documentation": "

Determines how placement groups spread instances.

\n
    \n
  • \n

    Host – You can use host only with Outpost placement\n groups.

    \n
    • \n
  • \n

    Rack – No usage restrictions.

    \n
    • \n
" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, @@ -17961,25 +18287,6 @@ "smithy.api#documentation": "

The placement strategy.

", "smithy.api#xmlName": "strategy" } - }, - "PartitionCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The number of partitions. Valid only when Strategy is\n set to partition.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the new placement group.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "SpreadLevel": { - "target": "com.amazonaws.ec2#SpreadLevel", - "traits": { - "smithy.api#documentation": "

Determines how placement groups spread instances.

\n
    \n
  • \n

    Host – You can use host only with Outpost placement\n groups.

    \n
    • \n
  • \n

    Rack – No usage restrictions.

    \n
    • \n
" - } } }, "traits": { @@ -18154,14 +18461,14 @@ "com.amazonaws.ec2#CreateReservedInstancesListingRequest": { "type": "structure", "members": { - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "ReservedInstancesId": { + "target": "com.amazonaws.ec2#ReservationId", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", + "aws.protocols#ec2QueryName": "ReservedInstancesId", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\tEnsuring Idempotency.

", + "smithy.api#documentation": "

The ID of the active Standard Reserved Instance.

", "smithy.api#required": {}, - "smithy.api#xmlName": "clientToken" + "smithy.api#xmlName": "reservedInstancesId" } }, "InstanceCount": { @@ -18184,14 +18491,14 @@ "smithy.api#xmlName": "priceSchedules" } }, - "ReservedInstancesId": { - "target": "com.amazonaws.ec2#ReservationId", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesId", + "aws.protocols#ec2QueryName": "ClientToken", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the active Standard Reserved Instance.

", + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\tEnsuring Idempotency.

", "smithy.api#required": {}, - "smithy.api#xmlName": "reservedInstancesId" + "smithy.api#xmlName": "clientToken" } } }, @@ -18314,26 +18621,40 @@ "com.amazonaws.ec2#CreateRouteRequest": { "type": "structure", "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", + "DestinationPrefixListId": { + "target": "com.amazonaws.ec2#PrefixListResourceId", "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", - "smithy.api#xmlName": "destinationCidrBlock" + "smithy.api#documentation": "

The ID of a prefix list used for the destination match.

" } }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.ec2#String", + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" + "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" } }, - "DestinationPrefixListId": { - "target": "com.amazonaws.ec2#PrefixListResourceId", + "TransitGatewayId": { + "target": "com.amazonaws.ec2#TransitGatewayId", "traits": { - "smithy.api#documentation": "

The ID of a prefix list used for the destination match.

" + "smithy.api#documentation": "

The ID of a transit gateway.

" + } + }, + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the local gateway.

" + } + }, + "CarrierGatewayId": { + "target": "com.amazonaws.ec2#CarrierGatewayId", + "traits": { + "smithy.api#documentation": "

The ID of the carrier gateway.

\n

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

" + } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" } }, "DryRun": { @@ -18344,18 +18665,22 @@ "smithy.api#xmlName": "dryRun" } }, - "VpcEndpointId": { - "target": "com.amazonaws.ec2#VpcEndpointId", + "RouteTableId": { + "target": "com.amazonaws.ec2#RouteTableId", "traits": { - "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" + "aws.protocols#ec2QueryName": "RouteTableId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the route table for the route.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "routeTableId" } }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", + "smithy.api#xmlName": "destinationCidrBlock" } }, "GatewayId": { @@ -18366,38 +18691,28 @@ "smithy.api#xmlName": "gatewayId" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", - "smithy.api#xmlName": "instanceId" - } - }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - }, - "TransitGatewayId": { - "target": "com.amazonaws.ec2#TransitGatewayId", + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The ID of a transit gateway.

" + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" } }, - "LocalGatewayId": { - "target": "com.amazonaws.ec2#LocalGatewayId", + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", "traits": { - "smithy.api#documentation": "

The ID of the local gateway.

" + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" } }, - "CarrierGatewayId": { - "target": "com.amazonaws.ec2#CarrierGatewayId", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "smithy.api#documentation": "

The ID of the carrier gateway.

\n

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "smithy.api#xmlName": "instanceId" } }, "NetworkInterfaceId": { @@ -18408,16 +18723,6 @@ "smithy.api#xmlName": "networkInterfaceId" } }, - "RouteTableId": { - "target": "com.amazonaws.ec2#RouteTableId", - "traits": { - "aws.protocols#ec2QueryName": "RouteTableId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the route table for the route.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "routeTableId" - } - }, "VpcPeeringConnectionId": { "target": "com.amazonaws.ec2#VpcPeeringConnectionId", "traits": { @@ -18426,10 +18731,12 @@ "smithy.api#xmlName": "vpcPeeringConnectionId" } }, - "CoreNetworkArn": { - "target": "com.amazonaws.ec2#CoreNetworkArn", + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" } } }, @@ -18493,6 +18800,20 @@ "com.amazonaws.ec2#CreateRouteTableRequest": { "type": "structure", "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the route table.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.

", + "smithy.api#idempotencyToken": {} + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -18510,20 +18831,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "vpcId" } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to assign to the route table.

", - "smithy.api#xmlName": "TagSpecification" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency.

", - "smithy.api#idempotencyToken": {} - } } }, "traits": { @@ -18833,24 +19140,24 @@ "com.amazonaws.ec2#CreateSpotDatafeedSubscriptionRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, "Bucket": { "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Bucket", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For\n more information about bucket names, see Rules for bucket\n naming in the Amazon S3 Developer Guide.

", + "smithy.api#documentation": "

The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For\n more information about bucket names, see Bucket naming rules \n in the Amazon S3 User Guide.

", "smithy.api#required": {}, "smithy.api#xmlName": "bucket" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually\n making the request, and provides an error response. If you have the required\n permissions, the error response is DryRunOperation. Otherwise, it is\n UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, "Prefix": { "target": "com.amazonaws.ec2#String", "traits": { @@ -18988,7 +19295,7 @@ "target": "com.amazonaws.ec2#CreateSubnetCidrReservationResult" }, "traits": { - "smithy.api#documentation": "

Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations \n in the Amazon VPC User Guide and Assign prefixes \n to network interfaces in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Creates a subnet CIDR reservation. For more information, see Subnet CIDR reservations \n in the Amazon VPC User Guide and Manage prefixes \n for your network interfaces in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#CreateSubnetCidrReservationRequest": { @@ -19106,14 +19413,6 @@ "smithy.api#required": {} } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "Ipv6Native": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -19143,6 +19442,14 @@ "traits": { "smithy.api#documentation": "

An IPv6 netmask length for the subnet.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } } }, "traits": { @@ -20444,7 +20751,7 @@ "SecurityGroupReferencingSupport": { "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", "traits": { - "smithy.api#documentation": "\n

This parameter is in preview and may not be available for your account.

\n \n

Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

\n

If you don't enable or disable SecurityGroupReferencingSupport in the request, the\n attachment will inherit the security group referencing support setting on the transit\n gateway.

" + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.

\n

This option is set to enable by default. However, at the transit gateway level the default is set to disable.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

" } }, "Ipv6Support": { @@ -21076,14 +21383,6 @@ "com.amazonaws.ec2#CreateVolumePermission": { "type": "structure", "members": { - "Group": { - "target": "com.amazonaws.ec2#PermissionGroup", - "traits": { - "aws.protocols#ec2QueryName": "Group", - "smithy.api#documentation": "

The group to be added or removed. The possible value is all.

", - "smithy.api#xmlName": "group" - } - }, "UserId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -21091,6 +21390,14 @@ "smithy.api#documentation": "

The ID of the Amazon Web Services account to be added or removed.

", "smithy.api#xmlName": "userId" } + }, + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "aws.protocols#ec2QueryName": "Group", + "smithy.api#documentation": "

The group to be added or removed. The possible value is all.

", + "smithy.api#xmlName": "group" + } } }, "traits": { @@ -21181,14 +21488,6 @@ "smithy.api#documentation": "

The volume type. This parameter can be one of the following values:

\n
    \n
  • \n

    General Purpose SSD: gp2 | gp3\n

    \n
    • \n
  • \n

    Provisioned IOPS SSD: io1 | io2\n

    \n
    • \n
  • \n

    Throughput Optimized HDD: st1\n

    \n
    • \n
  • \n

    Cold HDD: sc1\n

    \n
    • \n
  • \n

    Magnetic: standard\n

    \n
    • \n
\n \n

Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.

\n \n

For more information, see Amazon EBS volume types in the\n Amazon EBS User Guide.

\n

Default: gp2\n

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "TagSpecifications": { "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { @@ -21214,6 +21513,14 @@ "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency \n of the request. For more information, see Ensure \n Idempotency.

", "smithy.api#idempotencyToken": {} } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } } }, "traits": { @@ -21229,7 +21536,7 @@ "target": "com.amazonaws.ec2#CreateVpcResult" }, "traits": { - "smithy.api#documentation": "

Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the \n Amazon VPC User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an\n Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR\n block from an IPv6 address pool that you provisioned through bring your own IP addresses\n (BYOIP).

\n

By default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon VPC User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Creates a VPC with the specified CIDR blocks. For more information, see IP addressing for your VPCs and subnets in the \n Amazon VPC User Guide.

\n

You can optionally request an IPv6 CIDR block for the VPC. You can request an\n Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses or an IPv6 CIDR\n block from an IPv6 address pool that you provisioned through bring your own IP addresses\n (BYOIP).

\n

By default, each instance that you launch in the VPC has the default DHCP options, which\n\t\t\tinclude only a default DNS server that we provide (AmazonProvidedDNS). For more\n\t\t\tinformation, see DHCP option sets in the Amazon VPC User Guide.

\n

You can specify the instance tenancy value for the VPC when you create it. You can't change\n this value for the VPC after you create it. For more information, see Dedicated Instances in the\n Amazon EC2 User Guide.

", "smithy.api#examples": [ { "title": "To create a VPC", @@ -21582,28 +21889,25 @@ "com.amazonaws.ec2#CreateVpcPeeringConnectionRequest": { "type": "structure", "members": { - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "PeerRegion": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" + "smithy.api#documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.

\n

Default: The Region in which you make the request.

" } }, - "PeerOwnerId": { - "target": "com.amazonaws.ec2#String", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "PeerOwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the accepter VPC.

\n

Default: Your Amazon Web Services account ID

", - "smithy.api#xmlName": "peerOwnerId" + "smithy.api#documentation": "

The tags to assign to the peering connection.

", + "smithy.api#xmlName": "TagSpecification" } }, - "PeerVpcId": { - "target": "com.amazonaws.ec2#String", + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "PeerVpcId", - "smithy.api#documentation": "

The ID of the VPC with which you are creating the VPC peering connection. You must\n\t\t\tspecify this parameter in the request.

", - "smithy.api#xmlName": "peerVpcId" + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" } }, "VpcId": { @@ -21616,17 +21920,20 @@ "smithy.api#xmlName": "vpcId" } }, - "PeerRegion": { + "PeerVpcId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The Region code for the accepter VPC, if the accepter VPC is located in a Region\n other than the Region in which you make the request.

\n

Default: The Region in which you make the request.

" + "aws.protocols#ec2QueryName": "PeerVpcId", + "smithy.api#documentation": "

The ID of the VPC with which you are creating the VPC peering connection. You must\n\t\t\tspecify this parameter in the request.

", + "smithy.api#xmlName": "peerVpcId" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "PeerOwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The tags to assign to the peering connection.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "PeerOwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the accepter VPC.

\n

Default: Your Amazon Web Services account ID

", + "smithy.api#xmlName": "peerOwnerId" } } }, @@ -21659,14 +21966,6 @@ "smithy.api#documentation": "

The IPv4 network range for the VPC, in CIDR notation. For example,\n\t\t 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

" } }, - "AmazonProvidedIpv6CidrBlock": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", - "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.\n You cannot specify the range of IP addresses, or the size of the CIDR block.

", - "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" - } - }, "Ipv6Pool": { "target": "com.amazonaws.ec2#Ipv6PoolEc2Id", "traits": { @@ -21703,6 +22002,19 @@ "smithy.api#documentation": "

The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.

" } }, + "Ipv6CidrBlockNetworkBorderGroup": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to assign to the VPC.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -21719,17 +22031,12 @@ "smithy.api#xmlName": "instanceTenancy" } }, - "Ipv6CidrBlockNetworkBorderGroup": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

\n

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

" - } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "AmazonProvidedIpv6CidrBlock": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The tags to assign to the VPC.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "AmazonProvidedIpv6CidrBlock", + "smithy.api#documentation": "

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.\n You cannot specify the range of IP addresses, or the size of the CIDR block.

", + "smithy.api#xmlName": "amazonProvidedIpv6CidrBlock" } } }, @@ -21796,6 +22103,13 @@ "smithy.api#documentation": "

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private\n gateway.

" } }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the VPN connection.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -21811,13 +22125,6 @@ "smithy.api#documentation": "

The options for the VPN connection.

", "smithy.api#xmlName": "options" } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the VPN connection.

", - "smithy.api#xmlName": "TagSpecification" - } } }, "traits": { @@ -22001,36 +22308,44 @@ "com.amazonaws.ec2#CustomerGateway": { "type": "structure", "members": { - "BgpAsn": { + "CertificateArn": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "BgpAsn", - "smithy.api#documentation": "

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

\n

Valid values: 1 to 2,147,483,647\n

", - "smithy.api#xmlName": "bgpAsn" + "aws.protocols#ec2QueryName": "CertificateArn", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

", + "smithy.api#xmlName": "certificateArn" } }, - "CustomerGatewayId": { + "DeviceName": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewayId", - "smithy.api#documentation": "

The ID of the customer gateway.

", - "smithy.api#xmlName": "customerGatewayId" + "aws.protocols#ec2QueryName": "DeviceName", + "smithy.api#documentation": "

The name of customer gateway device.

", + "smithy.api#xmlName": "deviceName" } }, - "IpAddress": { + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the customer gateway.

", + "smithy.api#xmlName": "tagSet" + } + }, + "BgpAsnExtended": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

\n IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.\n

", - "smithy.api#xmlName": "ipAddress" + "aws.protocols#ec2QueryName": "BgpAsnExtended", + "smithy.api#documentation": "

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

\n

Valid values: 2,147,483,648 to 4,294,967,295\n

", + "smithy.api#xmlName": "bgpAsnExtended" } }, - "CertificateArn": { + "CustomerGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CertificateArn", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customer gateway certificate.

", - "smithy.api#xmlName": "certificateArn" + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway.

", + "smithy.api#xmlName": "customerGatewayId" } }, "State": { @@ -22049,28 +22364,20 @@ "smithy.api#xmlName": "type" } }, - "DeviceName": { + "IpAddress": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DeviceName", - "smithy.api#documentation": "

The name of customer gateway device.

", - "smithy.api#xmlName": "deviceName" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the customer gateway.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

\n IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.\n

", + "smithy.api#xmlName": "ipAddress" } }, - "BgpAsnExtended": { + "BgpAsn": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "BgpAsnExtended", - "smithy.api#documentation": "

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

\n

Valid values: 2,147,483,648 to 4,294,967,295\n

", - "smithy.api#xmlName": "bgpAsnExtended" + "aws.protocols#ec2QueryName": "BgpAsn", + "smithy.api#documentation": "

The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN).

\n

Valid values: 1 to 2,147,483,647\n

", + "smithy.api#xmlName": "bgpAsn" } } }, @@ -24217,16 +24524,6 @@ "smithy.api#xmlName": "dryRun" } }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether the rule is an egress rule.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "egress" - } - }, "NetworkAclId": { "target": "com.amazonaws.ec2#NetworkAclId", "traits": { @@ -24246,6 +24543,16 @@ "smithy.api#required": {}, "smithy.api#xmlName": "ruleNumber" } + }, + "Egress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Egress", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Indicates whether the rule is an egress rule.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "egress" + } } }, "traits": { @@ -24613,7 +24920,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, @@ -24834,22 +25141,6 @@ "com.amazonaws.ec2#DeleteRouteRequest": { "type": "structure", "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" - } - }, "DestinationPrefixListId": { "target": "com.amazonaws.ec2#PrefixListResourceId", "traits": { @@ -24873,6 +25164,22 @@ "smithy.api#required": {}, "smithy.api#xmlName": "routeTableId" } + }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } } }, "traits": { @@ -26264,7 +26571,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the VPC's default security group, network ACL, and route table.

", + "smithy.api#documentation": "

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated \n\t\t with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, \n\t\t delete all security groups associated with the VPC (except the default one), delete all route tables \n\t\t associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the \n\t\t default security group, network ACL, and route table for the VPC.

\n

If you created a flow log for the VPC that you are deleting, note that flow logs for deleted \n VPCs are eventually automatically removed.

", "smithy.api#examples": [ { "title": "To delete a VPC", @@ -27185,14 +27492,6 @@ "com.amazonaws.ec2#DescribeAccountAttributesRequest": { "type": "structure", "members": { - "AttributeNames": { - "target": "com.amazonaws.ec2#AccountAttributeNameStringList", - "traits": { - "aws.protocols#ec2QueryName": "AttributeName", - "smithy.api#documentation": "

The account attribute names.

", - "smithy.api#xmlName": "attributeName" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -27200,6 +27499,14 @@ "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.

", "smithy.api#xmlName": "dryRun" } + }, + "AttributeNames": { + "target": "com.amazonaws.ec2#AccountAttributeNameStringList", + "traits": { + "aws.protocols#ec2QueryName": "AttributeName", + "smithy.api#documentation": "

The account attribute names.

", + "smithy.api#xmlName": "attributeName" + } } }, "traits": { @@ -27427,13 +27734,6 @@ "com.amazonaws.ec2#DescribeAddressesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n
    \n
  • \n

    \n allocation-id - The allocation ID for the address.

    \n
    • \n
  • \n

    \n association-id - The association ID for the address.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance the address is associated with, if any.

    \n
    • \n
  • \n

    \n network-border-group - A unique set of Availability Zones, Local Zones,\n or Wavelength Zones from where Amazon Web Services advertises IP addresses.

    \n
    • \n
  • \n

    \n network-interface-id - The ID of the network interface that the address is associated with, if any.

    \n
    • \n
  • \n

    \n network-interface-owner-id - The Amazon Web Services account ID of the owner.

    \n
    • \n
  • \n

    \n private-ip-address - The private IP address associated with the Elastic IP address.

    \n
    • \n
  • \n

    \n public-ip - The Elastic IP address, or the carrier IP address.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "PublicIps": { "target": "com.amazonaws.ec2#PublicIpStringList", "traits": { @@ -27441,13 +27741,6 @@ "smithy.api#xmlName": "PublicIp" } }, - "AllocationIds": { - "target": "com.amazonaws.ec2#AllocationIdList", - "traits": { - "smithy.api#documentation": "

Information about the allocation IDs.

", - "smithy.api#xmlName": "AllocationId" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -27455,6 +27748,20 @@ "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.

", "smithy.api#xmlName": "dryRun" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

\n
    \n
  • \n

    \n allocation-id - The allocation ID for the address.

    \n
    • \n
  • \n

    \n association-id - The association ID for the address.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance the address is associated with, if any.

    \n
    • \n
  • \n

    \n network-border-group - A unique set of Availability Zones, Local Zones,\n or Wavelength Zones from where Amazon Web Services advertises IP addresses.

    \n
    • \n
  • \n

    \n network-interface-id - The ID of the network interface that the address is associated with, if any.

    \n
    • \n
  • \n

    \n network-interface-owner-id - The Amazon Web Services account ID of the owner.

    \n
    • \n
  • \n

    \n private-ip-address - The private IP address associated with the Elastic IP address.

    \n
    • \n
  • \n

    \n public-ip - The Elastic IP address, or the carrier IP address.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } + }, + "AllocationIds": { + "target": "com.amazonaws.ec2#AllocationIdList", + "traits": { + "smithy.api#documentation": "

Information about the allocation IDs.

", + "smithy.api#xmlName": "AllocationId" + } } }, "traits": { @@ -27576,13 +27883,6 @@ "com.amazonaws.ec2#DescribeAvailabilityZonesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n group-name - For Availability Zones, use the Region name. For Local\n Zones, use the name of the group associated with the Local Zone (for example,\n us-west-2-lax-1) For Wavelength Zones, use the name of the group associated\n with the Wavelength Zone (for example, us-east-1-wl1).

    \n
    • \n
  • \n

    \n message - The Zone message.

    \n
    • \n
  • \n

    \n opt-in-status - The opt-in status (opted-in |\n not-opted-in | opt-in-not-required).

    \n
    • \n
  • \n

    \n parent-zone-id - The ID of the zone that handles some of the Local Zone\n and Wavelength Zone control plane operations, such as API calls.

    \n
    • \n
  • \n

    \n parent-zone-name - The ID of the zone that handles some of the Local Zone\n and Wavelength Zone control plane operations, such as API calls.

    \n
    • \n
  • \n

    \n region-name - The name of the Region for the Zone (for example,\n us-east-1).

    \n
    • \n
  • \n

    \n state - The state of the Availability Zone, the Local Zone, or the\n Wavelength Zone (available).

    \n
    • \n
  • \n

    \n zone-id - The ID of the Availability Zone (for example,\n use1-az1), the Local Zone (for example, usw2-lax1-az1), or the\n Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

    \n
    • \n
  • \n

    \n zone-name - The name of the Availability Zone (for example,\n us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or\n the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

    \n
    • \n
  • \n

    \n zone-type - The type of zone (availability-zone | \n local-zone | wavelength-zone).

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "ZoneNames": { "target": "com.amazonaws.ec2#ZoneNameStringList", "traits": { @@ -27610,6 +27910,13 @@ "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.

", "smithy.api#xmlName": "dryRun" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n group-name - For Availability Zones, use the Region name. For Local\n Zones, use the name of the group associated with the Local Zone (for example,\n us-west-2-lax-1) For Wavelength Zones, use the name of the group associated\n with the Wavelength Zone (for example, us-east-1-wl1).

    \n
    • \n
  • \n

    \n message - The Zone message.

    \n
    • \n
  • \n

    \n opt-in-status - The opt-in status (opted-in |\n not-opted-in | opt-in-not-required).

    \n
    • \n
  • \n

    \n parent-zone-id - The ID of the zone that handles some of the Local Zone\n and Wavelength Zone control plane operations, such as API calls.

    \n
    • \n
  • \n

    \n parent-zone-name - The ID of the zone that handles some of the Local Zone\n and Wavelength Zone control plane operations, such as API calls.

    \n
    • \n
  • \n

    \n region-name - The name of the Region for the Zone (for example,\n us-east-1).

    \n
    • \n
  • \n

    \n state - The state of the Availability Zone, the Local Zone, or the\n Wavelength Zone (available).

    \n
    • \n
  • \n

    \n zone-id - The ID of the Availability Zone (for example,\n use1-az1), the Local Zone (for example, usw2-lax1-az1), or the\n Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

    \n
    • \n
  • \n

    \n zone-name - The name of the Availability Zone (for example,\n us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or\n the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

    \n
    • \n
  • \n

    \n zone-type - The type of zone (availability-zone | \n local-zone | wavelength-zone).

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -27756,13 +28063,6 @@ "smithy.api#xmlName": "BundleId" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n bundle-id - The ID of the bundle task.

    \n
    • \n
  • \n

    \n error-code - If the task failed, the error code returned.

    \n
    • \n
  • \n

    \n error-message - If the task failed, the error message returned.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance.

    \n
    • \n
  • \n

    \n progress - The level of task completion, as a percentage (for example, 20%).

    \n
    • \n
  • \n

    \n s3-bucket - The Amazon S3 bucket to store the AMI.

    \n
    • \n
  • \n

    \n s3-prefix - The beginning of the AMI name.

    \n
    • \n
  • \n

    \n start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

    \n
    • \n
  • \n

    \n state - The state of the task (pending | waiting-for-shutdown | bundling |\n storing | cancelling | complete | failed).

    \n
    • \n
  • \n

    \n update-time - The time of the most recent update for the task.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -27770,6 +28070,13 @@ "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n bundle-id - The ID of the bundle task.

    \n
    • \n
  • \n

    \n error-code - If the task failed, the error code returned.

    \n
    • \n
  • \n

    \n error-message - If the task failed, the error message returned.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance.

    \n
    • \n
  • \n

    \n progress - The level of task completion, as a percentage (for example, 20%).

    \n
    • \n
  • \n

    \n s3-bucket - The Amazon S3 bucket to store the AMI.

    \n
    • \n
  • \n

    \n s3-prefix - The beginning of the AMI name.

    \n
    • \n
  • \n

    \n start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

    \n
    • \n
  • \n

    \n state - The state of the task (pending | waiting-for-shutdown | bundling |\n storing | cancelling | complete | failed).

    \n
    • \n
  • \n

    \n update-time - The time of the most recent update for the task.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -27980,6 +28287,105 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DescribeCapacityReservationBillingRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsResult" + }, + "traits": { + "smithy.api#documentation": "

Describes a request to assign the billing of the unused capacity of a Capacity Reservation.\n\t\t\tFor more information, see \n\t\t\t\tBilling assignment for shared Amazon EC2 Capacity Reservations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CapacityReservationBillingRequests", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsRequest": { + "type": "structure", + "members": { + "CapacityReservationIds": { + "target": "com.amazonaws.ec2#CapacityReservationIdSet", + "traits": { + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#xmlName": "CapacityReservationId" + } + }, + "Role": { + "target": "com.amazonaws.ec2#CallerRole", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specify one of the following:

\n
    \n
  • \n

    \n odcr-owner - If you are the Capacity Reservation owner, specify this \n\t\t\t\t\tvalue to view requests that you have initiated. Not supported with the requested-by \n\t\t\t\t\tfilter.

    \n
    • \n
  • \n

    \n unused-reservation-billing-owner - If you are the consumer account, \n\t\t\t\t\tspecify this value to view requests that have been sent to you. Not supported with the \n\t\t\t\t\tunused-reservation-billing-owner filter.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The token to use to retrieve the next page of results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsRequestMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, \n see Pagination.

" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n status - The state of the request (pending | accepted | \n\t\t\t\t\trejected | cancelled | revoked | expired).

    \n
    • \n
  • \n

    \n requested-by - The account ID of the Capacity Reservation owner that initiated \n\t\t\t\t\tthe request. Not supported if you specify requested-by for Role.

    \n
    • \n
  • \n

    \n unused-reservation-billing-owner - The ID of the consumer account to which the \n\t\t\t\t\trequest was sent. Not supported if you specify unused-reservation-billing-owner for \n\t\t\t\t\tRole.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } + }, + "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, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#DescribeCapacityReservationBillingRequestsResult": { + "type": "structure", + "members": { + "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.

", + "smithy.api#xmlName": "nextToken" + } + }, + "CapacityReservationBillingRequests": { + "target": "com.amazonaws.ec2#CapacityReservationBillingRequestSet", + "traits": { + "aws.protocols#ec2QueryName": "CapacityReservationBillingRequestSet", + "smithy.api#documentation": "

Information about the request.

", + "smithy.api#xmlName": "capacityReservationBillingRequestSet" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DescribeCapacityReservationFleets": { "type": "operation", "input": { @@ -28274,13 +28680,6 @@ "com.amazonaws.ec2#DescribeClassicLinkInstancesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n group-id - The ID of a VPC security group that's associated with the instance.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC to which the instance is linked.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -28296,12 +28695,11 @@ "smithy.api#xmlName": "InstanceId" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

\n

Constraint: If the value is greater than 1000, we return only 1000 items.

", - "smithy.api#xmlName": "maxResults" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n group-id - The ID of a VPC security group that's associated with the instance.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC to which the instance is linked.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } }, "NextToken": { @@ -28311,6 +28709,14 @@ "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", "smithy.api#xmlName": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeClassicLinkInstancesMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

\n

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "smithy.api#xmlName": "maxResults" + } } }, "traits": { @@ -28979,14 +29385,6 @@ "com.amazonaws.ec2#DescribeConversionTasksRequest": { "type": "structure", "members": { - "ConversionTaskIds": { - "target": "com.amazonaws.ec2#ConversionIdStringList", - "traits": { - "aws.protocols#ec2QueryName": "ConversionTaskId", - "smithy.api#documentation": "

The conversion task IDs.

", - "smithy.api#xmlName": "conversionTaskId" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -28994,6 +29392,14 @@ "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.

", "smithy.api#xmlName": "dryRun" } + }, + "ConversionTaskIds": { + "target": "com.amazonaws.ec2#ConversionIdStringList", + "traits": { + "aws.protocols#ec2QueryName": "ConversionTaskId", + "smithy.api#documentation": "

The conversion task IDs.

", + "smithy.api#xmlName": "conversionTaskId" + } } }, "traits": { @@ -29203,11 +29609,16 @@ "smithy.api#xmlName": "DhcpOptionsId" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n dhcp-options-id - The ID of a DHCP options set.

    \n
    • \n
  • \n

    \n key - The key for one of the options (for example, domain-name).

    \n
    • \n
  • \n

    \n value - The value for one of the options.

    \n
    • \n
  • \n

    \n owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" } }, "DryRun": { @@ -29218,16 +29629,11 @@ "smithy.api#xmlName": "dryRun" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeDhcpOptionsMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n dhcp-options-id - The ID of a DHCP options set.

    \n
    • \n
  • \n

    \n key - The key for one of the options (for example, domain-name).

    \n
    • \n
  • \n

    \n value - The value for one of the options.

    \n
    • \n
  • \n

    \n owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -29238,14 +29644,6 @@ "com.amazonaws.ec2#DescribeDhcpOptionsResult": { "type": "structure", "members": { - "DhcpOptions": { - "target": "com.amazonaws.ec2#DhcpOptionsList", - "traits": { - "aws.protocols#ec2QueryName": "DhcpOptionsSet", - "smithy.api#documentation": "

Information about the DHCP options sets.

", - "smithy.api#xmlName": "dhcpOptionsSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -29253,6 +29651,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "DhcpOptions": { + "target": "com.amazonaws.ec2#DhcpOptionsList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsSet", + "smithy.api#documentation": "

Information about the DHCP options sets.

", + "smithy.api#xmlName": "dhcpOptionsSet" + } } }, "traits": { @@ -29359,7 +29765,7 @@ "target": "com.amazonaws.ec2#DescribeElasticGpusResult" }, "traits": { - "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.

\n \n

Describes the Elastic Graphics accelerator associated with your instances.

" + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes the Elastic Graphics accelerator associated with your instances.

" } }, "com.amazonaws.ec2#DescribeElasticGpusMaxResults": { @@ -29581,6 +29987,13 @@ "com.amazonaws.ec2#DescribeExportTasksRequest": { "type": "structure", "members": { + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

the filters for the export tasks.

", + "smithy.api#xmlName": "Filter" + } + }, "ExportTaskIds": { "target": "com.amazonaws.ec2#ExportTaskIdStringList", "traits": { @@ -29588,13 +30001,6 @@ "smithy.api#documentation": "

The export task IDs.

", "smithy.api#xmlName": "exportTaskId" } - }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

the filters for the export tasks.

", - "smithy.api#xmlName": "Filter" - } } }, "traits": { @@ -30285,7 +30691,7 @@ "target": "com.amazonaws.ec2#PlatformValues", "traits": { "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The value is Windows for Windows instances. Otherwise, the value is\n blank.

", + "smithy.api#documentation": "

The value is windows for Windows instances in an EC2 Fleet. Otherwise, the value is\n blank.

", "smithy.api#xmlName": "platform" } } @@ -30794,14 +31200,6 @@ "com.amazonaws.ec2#DescribeHostsRequest": { "type": "structure", "members": { - "Filter": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n auto-placement - Whether auto-placement is enabled or disabled\n (on | off).

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone of the host.

    \n
    • \n
  • \n

    \n client-token - The idempotency token that you provided when you\n allocated the host.

    \n
    • \n
  • \n

    \n host-reservation-id - The ID of the reservation assigned to this\n host.

    \n
    • \n
  • \n

    \n instance-type - The instance type size that the Dedicated Host is\n configured to support.

    \n
    • \n
  • \n

    \n state - The allocation state of the Dedicated Host\n (available | under-assessment |\n permanent-failure | released |\n released-permanent-failure).

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", - "smithy.api#xmlName": "filter" - } - }, "HostIds": { "target": "com.amazonaws.ec2#RequestHostIdList", "traits": { @@ -30810,6 +31208,14 @@ "smithy.api#xmlName": "hostId" } }, + "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.

", + "smithy.api#xmlName": "nextToken" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -30818,12 +31224,12 @@ "smithy.api#xmlName": "maxResults" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", + "Filter": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "aws.protocols#ec2QueryName": "NextToken", - "smithy.api#documentation": "

The token to use to retrieve the next page of results.

", - "smithy.api#xmlName": "nextToken" + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n auto-placement - Whether auto-placement is enabled or disabled\n (on | off).

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone of the host.

    \n
    • \n
  • \n

    \n client-token - The idempotency token that you provided when you\n allocated the host.

    \n
    • \n
  • \n

    \n host-reservation-id - The ID of the reservation assigned to this\n host.

    \n
    • \n
  • \n

    \n instance-type - The instance type size that the Dedicated Host is\n configured to support.

    \n
    • \n
  • \n

    \n state - The allocation state of the Dedicated Host\n (available | under-assessment |\n permanent-failure | released |\n released-permanent-failure).

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", + "smithy.api#xmlName": "filter" } } }, @@ -31021,6 +31427,14 @@ "com.amazonaws.ec2#DescribeIdentityIdFormatRequest": { "type": "structure", "members": { + "Resource": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Resource", + "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", + "smithy.api#xmlName": "resource" + } + }, "PrincipalArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -31030,14 +31444,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "principalArn" } - }, - "Resource": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Resource", - "smithy.api#documentation": "

The type of resource: bundle |\n conversion-task | customer-gateway | dhcp-options |\n elastic-ip-allocation | elastic-ip-association |\n export-task | flow-log | image |\n import-task | instance | internet-gateway |\n network-acl | network-acl-association |\n network-interface | network-interface-attachment |\n prefix-list | reservation | route-table |\n route-table-association | security-group |\n snapshot | subnet |\n subnet-cidr-block-association | volume | vpc\n | vpc-cidr-block-association | vpc-endpoint |\n vpc-peering-connection | vpn-connection | vpn-gateway\n

", - "smithy.api#xmlName": "resource" - } } }, "traits": { @@ -31244,13 +31650,6 @@ "smithy.api#xmlName": "ExecutableBy" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n architecture - The image architecture (i386 | x86_64 | \n arm64 | x86_64_mac | arm64_mac).

    \n
    • \n
  • \n

    \n block-device-mapping.delete-on-termination - A Boolean value that indicates\n \twhether the Amazon EBS volume is deleted on instance termination.

    \n
    • \n
  • \n

    \n block-device-mapping.device-name - The device name specified in the block device mapping (for\n example, /dev/sdh or xvdh).

    \n
    • \n
  • \n

    \n block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS\n volume.

    \n
    • \n
  • \n

    \n block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

    \n
    • \n
  • \n

    \n block-device-mapping.volume-type - The volume type of the Amazon EBS volume\n (io1 | io2 | gp2 | gp3 | sc1\n | st1 | standard).

    \n
    • \n
  • \n

    \n block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.

    \n
    • \n
  • \n

    \n creation-date - The time when the image was created, in the ISO 8601\n format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for\n example, 2021-09-29T*, which matches an entire day.

    \n
    • \n
  • \n

    \n description - The description of the image (provided during image\n creation).

    \n
    • \n
  • \n

    \n ena-support - A Boolean that indicates whether enhanced networking\n with ENA is enabled.

    \n
    • \n
  • \n

    \n hypervisor - The hypervisor type (ovm |\n xen).

    \n
    • \n
  • \n

    \n image-id - The ID of the image.

    \n
    • \n
  • \n

    \n image-type - The image type (machine | kernel |\n ramdisk).

    \n
    • \n
  • \n

    \n is-public - A Boolean that indicates whether the image is public.

    \n
    • \n
  • \n

    \n kernel-id - The kernel ID.

    \n
    • \n
  • \n

    \n manifest-location - The location of the image manifest.

    \n
    • \n
  • \n

    \n name - The name of the AMI (provided during image creation).

    \n
    • \n
  • \n

    \n owner-alias - The owner alias (amazon | aws-marketplace). \n The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be \n \tset using the IAM console. We recommend that you use the Owner \n \trequest parameter instead of this filter.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the \n \t\tOwner request parameter instead of this filter.

    \n
    • \n
  • \n

    \n platform - The platform. The only supported value is windows.

    \n
    • \n
  • \n

    \n product-code - The product code.

    \n
    • \n
  • \n

    \n product-code.type - The type of the product code (marketplace).

    \n
    • \n
  • \n

    \n ramdisk-id - The RAM disk ID.

    \n
    • \n
  • \n

    \n root-device-name - The device name of the root device volume (for example, /dev/sda1).

    \n
    • \n
  • \n

    \n root-device-type - The type of the root device volume (ebs |\n instance-store).

    \n
    • \n
  • \n

    \n source-instance-id - The ID of the instance that the AMI was created from\n if the AMI was created using CreateImage. This filter is applicable only if the AMI was\n created using CreateImage.

    \n
    • \n
  • \n

    \n state - The state of the image (available | pending\n | failed).

    \n
    • \n
  • \n

    \n state-reason-code - The reason code for the state change.

    \n
    • \n
  • \n

    \n state-reason-message - The message for the state change.

    \n
    • \n
  • \n

    \n sriov-net-support - A value of simple indicates\n that enhanced networking with the Intel 82599 VF interface is enabled.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n virtualization-type - The virtualization type (paravirtual |\n hvm).

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "ImageIds": { "target": "com.amazonaws.ec2#ImageIdStringList", "traits": { @@ -31277,14 +31676,6 @@ "smithy.api#documentation": "

Specifies whether to include disabled AMIs.

\n

Default: No disabled AMIs are included in the response.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -31296,6 +31687,21 @@ "traits": { "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n architecture - The image architecture (i386 | x86_64 | \n arm64 | x86_64_mac | arm64_mac).

    \n
    • \n
  • \n

    \n block-device-mapping.delete-on-termination - A Boolean value that indicates\n \twhether the Amazon EBS volume is deleted on instance termination.

    \n
    • \n
  • \n

    \n block-device-mapping.device-name - The device name specified in the block device mapping (for\n example, /dev/sdh or xvdh).

    \n
    • \n
  • \n

    \n block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS\n volume.

    \n
    • \n
  • \n

    \n block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

    \n
    • \n
  • \n

    \n block-device-mapping.volume-type - The volume type of the Amazon EBS volume\n (io1 | io2 | gp2 | gp3 | sc1\n | st1 | standard).

    \n
    • \n
  • \n

    \n block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.

    \n
    • \n
  • \n

    \n creation-date - The time when the image was created, in the ISO 8601\n format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for\n example, 2021-09-29T*, which matches an entire day.

    \n
    • \n
  • \n

    \n description - The description of the image (provided during image\n creation).

    \n
    • \n
  • \n

    \n ena-support - A Boolean that indicates whether enhanced networking\n with ENA is enabled.

    \n
    • \n
  • \n

    \n hypervisor - The hypervisor type (ovm |\n xen).

    \n
    • \n
  • \n

    \n image-id - The ID of the image.

    \n
    • \n
  • \n

    \n image-type - The image type (machine | kernel |\n ramdisk).

    \n
    • \n
  • \n

    \n is-public - A Boolean that indicates whether the image is public.

    \n
    • \n
  • \n

    \n kernel-id - The kernel ID.

    \n
    • \n
  • \n

    \n manifest-location - The location of the image manifest.

    \n
    • \n
  • \n

    \n name - The name of the AMI (provided during image creation).

    \n
    • \n
  • \n

    \n owner-alias - The owner alias (amazon | aws-marketplace). \n The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be \n \tset using the IAM console. We recommend that you use the Owner \n \trequest parameter instead of this filter.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the \n \t\tOwner request parameter instead of this filter.

    \n
    • \n
  • \n

    \n platform - The platform. The only supported value is windows.

    \n
    • \n
  • \n

    \n product-code - The product code.

    \n
    • \n
  • \n

    \n product-code.type - The type of the product code (marketplace).

    \n
    • \n
  • \n

    \n ramdisk-id - The RAM disk ID.

    \n
    • \n
  • \n

    \n root-device-name - The device name of the root device volume (for example, /dev/sda1).

    \n
    • \n
  • \n

    \n root-device-type - The type of the root device volume (ebs |\n instance-store).

    \n
    • \n
  • \n

    \n source-instance-id - The ID of the instance that the AMI was created from\n if the AMI was created using CreateImage. This filter is applicable only if the AMI was\n created using CreateImage.

    \n
    • \n
  • \n

    \n state - The state of the image (available | pending\n | failed).

    \n
    • \n
  • \n

    \n state-reason-code - The reason code for the state change.

    \n
    • \n
  • \n

    \n state-reason-message - The message for the state change.

    \n
    • \n
  • \n

    \n sriov-net-support - A value of simple indicates\n that enhanced networking with the Intel 82599 VF interface is enabled.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n virtualization-type - The virtualization type (paravirtual |\n hvm).

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -31305,14 +31711,6 @@ "com.amazonaws.ec2#DescribeImagesResult": { "type": "structure", "members": { - "Images": { - "target": "com.amazonaws.ec2#ImageList", - "traits": { - "aws.protocols#ec2QueryName": "ImagesSet", - "smithy.api#documentation": "

Information about the images.

", - "smithy.api#xmlName": "imagesSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -31320,6 +31718,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "Images": { + "target": "com.amazonaws.ec2#ImageList", + "traits": { + "aws.protocols#ec2QueryName": "ImagesSet", + "smithy.api#documentation": "

Information about the images.

", + "smithy.api#xmlName": "imagesSet" + } } }, "traits": { @@ -31579,21 +31985,11 @@ "com.amazonaws.ec2#DescribeInstanceAttributeRequest": { "type": "structure", "members": { - "Attribute": { - "target": "com.amazonaws.ec2#InstanceAttributeName", - "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The instance attribute.

\n

Note: The enaSupport attribute is not supported at this time.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "attribute" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, @@ -31606,6 +32002,16 @@ "smithy.api#required": {}, "smithy.api#xmlName": "instanceId" } + }, + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The instance attribute.

\n

Note: The enaSupport attribute is not supported at this time.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "attribute" + } } }, "traits": { @@ -31727,7 +32133,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "Filters": { @@ -31882,7 +32288,7 @@ } }, "traits": { - "smithy.api#documentation": "Describe instance event windows by InstanceEventWindow.", + "smithy.api#documentation": "

Describe instance event windows by InstanceEventWindow.

", "smithy.api#input": {} } }, @@ -32013,13 +32419,6 @@ "com.amazonaws.ec2#DescribeInstanceStatusRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
    • \n
  • \n

    \n event.code - The code for the scheduled event\n (instance-reboot | system-reboot |\n system-maintenance | instance-retirement |\n instance-stop).

    \n
    • \n
  • \n

    \n event.description - A description of the event.

    \n
    • \n
  • \n

    \n event.instance-event-id - The ID of the event whose date and time\n you are modifying.

    \n
    • \n
  • \n

    \n event.not-after - The latest end time for the scheduled event\n (for example, 2014-09-15T17:15:20.000Z).

    \n
    • \n
  • \n

    \n event.not-before - The earliest start time for the scheduled\n event (for example, 2014-09-15T17:15:20.000Z).

    \n
    • \n
  • \n

    \n event.not-before-deadline - The deadline for starting the event\n (for example, 2014-09-15T17:15:20.000Z).

    \n
    • \n
  • \n

    \n instance-state-code - The code for the instance state, as a\n 16-bit unsigned integer. The high byte is used for internal purposes and should\n be ignored. The low byte is set based on the state represented. The valid values\n are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).

    \n
    • \n
  • \n

    \n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).

    \n
    • \n
  • \n

    \n instance-status.reachability - Filters on instance status where\n the name is reachability (passed | failed\n | initializing | insufficient-data).

    \n
    • \n
  • \n

    \n instance-status.status - The status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).

    \n
    • \n
  • \n

    \n system-status.reachability - Filters on system status where the\n name is reachability (passed | failed |\n initializing | insufficient-data).

    \n
    • \n
  • \n

    \n system-status.status - The system status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).

    \n
    • \n
  • \n

    \n attached-ebs-status.status - The status of the attached EBS volume \n for the instance (ok | impaired | initializing | \n insufficient-data | not-applicable).

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { @@ -32043,10 +32442,17 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
    • \n
  • \n

    \n event.code - The code for the scheduled event\n (instance-reboot | system-reboot |\n system-maintenance | instance-retirement |\n instance-stop).

    \n
    • \n
  • \n

    \n event.description - A description of the event.

    \n
    • \n
  • \n

    \n event.instance-event-id - The ID of the event whose date and time\n you are modifying.

    \n
    • \n
  • \n

    \n event.not-after - The latest end time for the scheduled event\n (for example, 2014-09-15T17:15:20.000Z).

    \n
    • \n
  • \n

    \n event.not-before - The earliest start time for the scheduled\n event (for example, 2014-09-15T17:15:20.000Z).

    \n
    • \n
  • \n

    \n event.not-before-deadline - The deadline for starting the event\n (for example, 2014-09-15T17:15:20.000Z).

    \n
    • \n
  • \n

    \n instance-state-code - The code for the instance state, as a\n 16-bit unsigned integer. The high byte is used for internal purposes and should\n be ignored. The low byte is set based on the state represented. The valid values\n are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).

    \n
    • \n
  • \n

    \n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).

    \n
    • \n
  • \n

    \n instance-status.reachability - Filters on instance status where\n the name is reachability (passed | failed\n | initializing | insufficient-data).

    \n
    • \n
  • \n

    \n instance-status.status - The status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).

    \n
    • \n
  • \n

    \n system-status.reachability - Filters on system status where the\n name is reachability (passed | failed |\n initializing | insufficient-data).

    \n
    • \n
  • \n

    \n system-status.status - The system status of the instance\n (ok | impaired | initializing |\n insufficient-data | not-applicable).

    \n
    • \n
  • \n

    \n attached-ebs-status.status - The status of the attached EBS volume \n for the instance (ok | impaired | initializing | \n insufficient-data | not-applicable).

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } + }, "IncludeAllInstances": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -32093,7 +32499,7 @@ "target": "com.amazonaws.ec2#DescribeInstanceTopologyResult" }, "traits": { - "smithy.api#documentation": "

Describes a tree-based hierarchy that represents the physical host placement of your\n EC2 instances within an Availability Zone or Local Zone. You can use this information to\n determine the relative proximity of your EC2 instances within the Amazon Web Services network to\n support your tightly coupled workloads.

\n

\n Limitations\n

\n
    \n
  • \n

    Supported zones

    \n
      \n
    • \n

      Availability Zone

      \n
      • \n
    • \n

      Local Zone

      \n
      • \n
    \n
    • \n
  • \n

    Supported instance types

    \n
      \n
    • \n

      \n hpc6a.48xlarge | hpc6id.32xlarge |\n hpc7a.12xlarge | hpc7a.24xlarge |\n hpc7a.48xlarge | hpc7a.96xlarge |\n hpc7g.4xlarge | hpc7g.8xlarge |\n hpc7g.16xlarge\n

      \n
      • \n
    • \n

      \n p3dn.24xlarge | p4d.24xlarge |\n p4de.24xlarge | p5.48xlarge\n

      \n
      • \n
    • \n

      \n trn1.2xlarge | trn1.32xlarge |\n trn1n.32xlarge\n

      \n
      • \n
    \n
    • \n
\n

For more information, see Amazon EC2 instance\n topology in the Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Describes a tree-based hierarchy that represents the physical host placement of your\n EC2 instances within an Availability Zone or Local Zone. You can use this information to\n determine the relative proximity of your EC2 instances within the Amazon Web Services network to\n support your tightly coupled workloads.

\n

\n Limitations\n

\n
    \n
  • \n

    Supported zones

    \n
      \n
    • \n

      Availability Zone

      \n
      • \n
    • \n

      Local Zone

      \n
      • \n
    \n
    • \n
  • \n

    Supported instance types

    \n
      \n
    • \n

      \n hpc6a.48xlarge | hpc6id.32xlarge |\n hpc7a.12xlarge | hpc7a.24xlarge |\n hpc7a.48xlarge | hpc7a.96xlarge |\n hpc7g.4xlarge | hpc7g.8xlarge |\n hpc7g.16xlarge\n

      \n
      • \n
    • \n

      \n p3dn.24xlarge | p4d.24xlarge |\n p4de.24xlarge | p5.48xlarge |\n p5e.48xlarge\n

      \n
      • \n
    • \n

      \n trn1.2xlarge | trn1.32xlarge |\n trn1n.32xlarge\n

      \n
      • \n
    \n
    • \n
\n

For more information, see Amazon EC2 instance\n topology in the Amazon EC2 User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32129,7 +32535,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "NextToken": { @@ -32584,13 +32990,6 @@ "com.amazonaws.ec2#DescribeInstancesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).

    \n
    • \n
  • \n

    \n architecture - The instance architecture (i386 |\n x86_64 | arm64).

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
    • \n
  • \n

    \n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z.

    \n
    • \n
  • \n

    \n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.

    \n
    • \n
  • \n

    \n block-device-mapping.device-name - The device name specified in\n the block device mapping (for example, /dev/sdh or\n xvdh).

    \n
    • \n
  • \n

    \n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).

    \n
    • \n
  • \n

    \n block-device-mapping.volume-id - The volume ID of the EBS\n volume.

    \n
    • \n
  • \n

    \n boot-mode - The boot mode that was specified by the AMI\n (legacy-bios | uefi |\n uefi-preferred).

    \n
    • \n
  • \n

    \n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.

    \n
    • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-preference\n - The instance's Capacity Reservation preference (open | none).

    \n
    • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id\n - The ID of the targeted Capacity Reservation.

    \n
    • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn\n - The ARN of the targeted Capacity Reservation group.

    \n
    • \n
  • \n

    \n client-token - The idempotency token you provided when you\n launched the instance.

    \n
    • \n
  • \n

    \n current-instance-boot-mode - The boot mode that is used to launch\n the instance at launch or start (legacy-bios |\n uefi).

    \n
    • \n
  • \n

    \n dns-name - The public DNS name of the instance.

    \n
    • \n
  • \n

    \n ebs-optimized - A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.

    \n
    • \n
  • \n

    \n ena-support - A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.

    \n
    • \n
  • \n

    \n enclave-options.enabled - A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.

    \n
    • \n
  • \n

    \n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.

    \n
    • \n
  • \n

    \n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.

    \n
    • \n
  • \n

    \n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.

    \n
    • \n
  • \n

    \n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.

    \n
    • \n
  • \n

    \n iam-instance-profile.id - The instance profile associated with\n the instance. Specified as an ID.

    \n
    • \n
  • \n

    \n iam-instance-profile.name - The instance profile associated with\n the instance. Specified as an name.

    \n
    • \n
  • \n

    \n image-id - The ID of the image used to launch the\n instance.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance.

    \n
    • \n
  • \n

    \n instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or\n a Capacity Block (spot | scheduled | capacity-block).

    \n
    • \n
  • \n

    \n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).

    \n
    • \n
  • \n

    \n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).

    \n
    • \n
  • \n

    \n instance-type - The type of instance (for example,\n t2.micro).

    \n
    • \n
  • \n

    \n instance.group-id - The ID of the security group for the\n instance.

    \n
    • \n
  • \n

    \n instance.group-name - The name of the security group for the\n instance.

    \n
    • \n
  • \n

    \n ip-address - The public IPv4 address of the instance.

    \n
    • \n
  • \n

    \n ipv6-address - The IPv6 address of the instance.

    \n
    • \n
  • \n

    \n kernel-id - The kernel ID.

    \n
    • \n
  • \n

    \n key-name - The name of the key pair used when the instance was\n launched.

    \n
    • \n
  • \n

    \n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n

    \n
    • \n
  • \n

    \n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.

    \n
    • \n
  • \n

    \n maintenance-options.auto-recovery - The current automatic\n recovery behavior of the instance (disabled | default).

    \n
    • \n
  • \n

    \n metadata-options.http-endpoint - The status of access to the HTTP\n metadata endpoint on your instance (enabled |\n disabled)

    \n
    • \n
  • \n

    \n metadata-options.http-protocol-ipv4 - Indicates whether the IPv4\n endpoint is enabled (disabled | enabled).

    \n
    • \n
  • \n

    \n metadata-options.http-protocol-ipv6 - Indicates whether the IPv6\n endpoint is enabled (disabled | enabled).

    \n
    • \n
  • \n

    \n metadata-options.http-put-response-hop-limit - The HTTP metadata\n request put response hop limit (integer, possible values 1 to\n 64)

    \n
    • \n
  • \n

    \n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)

    \n
    • \n
  • \n

    \n metadata-options.instance-metadata-tags - The status of access to\n instance tags from the instance metadata (enabled |\n disabled)

    \n
    • \n
  • \n

    \n metadata-options.state - The state of the metadata option changes\n (pending | applied).

    \n
    • \n
  • \n

    \n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).

    \n
    • \n
  • \n

    \n network-interface.addresses.association.allocation-id - The allocation ID.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.association-id - The association ID.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.carrier-ip - The carrier IP address.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.public-dns-name - The public DNS name.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.

    \n
    • \n
  • \n

    \n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.

    \n
    • \n
  • \n

    \n network-interface.addresses.private-dns-name - The private DNS name.

    \n
    • \n
  • \n

    \n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.

    \n
    • \n
  • \n

    \n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.

    \n
    • \n
  • \n

    \n network-interface.association.carrier-ip - The customer-owned IP address.

    \n
    • \n
  • \n

    \n network-interface.association.customer-owned-ip - The customer-owned IP address.

    \n
    • \n
  • \n

    \n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.association.public-dns-name - The public DNS name.

    \n
    • \n
  • \n

    \n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.

    \n
    • \n
  • \n

    \n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.

    \n
    • \n
  • \n

    \n network-interface.attachment.attachment-id - The ID of the\n interface attachment.

    \n
    • \n
  • \n

    \n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.

    \n
    • \n
  • \n

    \n network-interface.attachment.device-index - The device index to\n which the network interface is attached.

    \n
    • \n
  • \n

    \n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.

    \n
    • \n
  • \n

    \n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.

    \n
    • \n
  • \n

    \n network-interface.attachment.network-card-index - The index of the network card.

    \n
    • \n
  • \n

    \n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).

    \n
    • \n
  • \n

    \n network-interface.availability-zone - The Availability Zone for\n the network interface.

    \n
    • \n
  • \n

    \n network-interface.deny-all-igw-traffic - A Boolean that indicates whether \n a network interface with an IPv6 address is unreachable from the public internet.

    \n
    • \n
  • \n

    \n network-interface.description - The description of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.group-id - The ID of a security group\n associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.group-name - The name of a security group\n associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv6-address - The IPv6 address associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this\n is the primary IPv6 address.

    \n
    • \n
  • \n

    \n network-interface.ipv6-native - A Boolean that indicates whether this is\n an IPv6 only network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.

    \n
    • \n
  • \n

    \n network-interface.mac-address - The MAC address of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.network-interface-id - The ID of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.outpost-arn - The ARN of the Outpost.

    \n
    • \n
  • \n

    \n network-interface.owner-id - The ID of the owner of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.private-dns-name - The private DNS name of the\n network interface.

    \n
    • \n
  • \n

    \n network-interface.private-ip-address - The private IPv4 address.

    \n
    • \n
  • \n

    \n network-interface.public-dns-name - The public DNS name.

    \n
    • \n
  • \n

    \n network-interface.requester-id - The requester ID for the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.

    \n
    • \n
  • \n

    \n network-interface.status - The status of the network interface\n (available) | in-use).

    \n
    • \n
  • \n

    \n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.

    \n
    • \n
  • \n

    \n network-interface.subnet-id - The ID of the subnet for the\n network interface.

    \n
    • \n
  • \n

    \n network-interface.tag-key - The key of a tag assigned to the network interface.

    \n
    • \n
  • \n

    \n network-interface.tag-value - The value of a tag assigned to the network interface.

    \n
    • \n
  • \n

    \n network-interface.vpc-id - The ID of the VPC for the network\n interface.

    \n
    • \n
  • \n

    \n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the instance\n owner.

    \n
    • \n
  • \n

    \n placement-group-name - The name of the placement group for the\n instance.

    \n
    • \n
  • \n

    \n placement-partition-number - The partition in which the instance is\n located.

    \n
    • \n
  • \n

    \n platform - The platform. To list only Windows instances, use\n windows.

    \n
    • \n
  • \n

    \n platform-details - The platform (Linux/UNIX |\n Red Hat BYOL Linux | Red Hat Enterprise Linux |\n Red Hat Enterprise Linux with HA | Red Hat Enterprise\n Linux with SQL Server Standard and HA | Red Hat Enterprise\n Linux with SQL Server Enterprise and HA | Red Hat Enterprise\n Linux with SQL Server Standard | Red Hat Enterprise Linux with\n SQL Server Web | Red Hat Enterprise Linux with SQL Server\n Enterprise | SQL Server Enterprise | SQL Server\n Standard | SQL Server Web | SUSE Linux |\n Ubuntu Pro | Windows | Windows BYOL |\n Windows with SQL Server Enterprise | Windows with SQL\n Server Standard | Windows with SQL Server Web).

    \n
    • \n
  • \n

    \n private-dns-name - The private IPv4 DNS name of the\n instance.

    \n
    • \n
  • \n

    \n private-dns-name-options.enable-resource-name-dns-a-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.

    \n
    • \n
  • \n

    \n private-dns-name-options.enable-resource-name-dns-aaaa-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.

    \n
    • \n
  • \n

    \n private-dns-name-options.hostname-type - The type of hostname\n (ip-name | resource-name).

    \n
    • \n
  • \n

    \n private-ip-address - The private IPv4 address of the instance.\n This can only be used to filter by the primary IP address of the network\n interface attached to the instance. To filter by additional IP addresses\n assigned to the network interface, use the filter\n network-interface.addresses.private-ip-address.

    \n
    • \n
  • \n

    \n product-code - The product code associated with the AMI used to\n launch the instance.

    \n
    • \n
  • \n

    \n product-code.type - The type of product code (devpay\n | marketplace).

    \n
    • \n
  • \n

    \n ramdisk-id - The RAM disk ID.

    \n
    • \n
  • \n

    \n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.

    \n
    • \n
  • \n

    \n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).

    \n
    • \n
  • \n

    \n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.

    \n
    • \n
  • \n

    \n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).

    \n
    • \n
  • \n

    \n root-device-type - The type of the root device volume\n (ebs | instance-store).

    \n
    • \n
  • \n

    \n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.

    \n
    • \n
  • \n

    \n spot-instance-request-id - The ID of the Spot Instance\n request.

    \n
    • \n
  • \n

    \n state-reason-code - The reason code for the state change.

    \n
    • \n
  • \n

    \n state-reason-message - A message that describes the state\n change.

    \n
    • \n
  • \n

    \n subnet-id - The ID of the subnet for the instance.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n tenancy - The tenancy of an instance (dedicated |\n default | host).

    \n
    • \n
  • \n

    \n tpm-support - Indicates if the instance is configured for\n NitroTPM support (v2.0).

    \n
    • \n
  • \n

    \n usage-operation - The usage operation value for the instance\n (RunInstances | RunInstances:00g0 |\n RunInstances:0010 | RunInstances:1010 |\n RunInstances:1014 | RunInstances:1110 |\n RunInstances:0014 | RunInstances:0210 |\n RunInstances:0110 | RunInstances:0100 |\n RunInstances:0004 | RunInstances:0200 |\n RunInstances:000g | RunInstances:0g00 |\n RunInstances:0002 | RunInstances:0800 |\n RunInstances:0102 | RunInstances:0006 |\n RunInstances:0202).

    \n
    • \n
  • \n

    \n usage-operation-update-time - The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z.

    \n
    • \n
  • \n

    \n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC that the instance is running in.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "InstanceIds": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { @@ -32602,16 +33001,15 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs parameter in the same request.

", - "smithy.api#xmlName": "maxResults" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n affinity - The affinity setting for an instance running on a\n Dedicated Host (default | host).

    \n
    • \n
  • \n

    \n architecture - The instance architecture (i386 |\n x86_64 | arm64).

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
    • \n
  • \n

    \n block-device-mapping.attach-time - The attach time for an EBS\n volume mapped to the instance, for example,\n 2022-09-15T17:15:20.000Z.

    \n
    • \n
  • \n

    \n block-device-mapping.delete-on-termination - A Boolean that\n indicates whether the EBS volume is deleted on instance termination.

    \n
    • \n
  • \n

    \n block-device-mapping.device-name - The device name specified in\n the block device mapping (for example, /dev/sdh or\n xvdh).

    \n
    • \n
  • \n

    \n block-device-mapping.status - The status for the EBS volume\n (attaching | attached | detaching |\n detached).

    \n
    • \n
  • \n

    \n block-device-mapping.volume-id - The volume ID of the EBS\n volume.

    \n
    • \n
  • \n

    \n boot-mode - The boot mode that was specified by the AMI\n (legacy-bios | uefi |\n uefi-preferred).

    \n
    • \n
  • \n

    \n capacity-reservation-id - The ID of the Capacity Reservation into which the\n instance was launched.

    \n
    • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-preference\n - The instance's Capacity Reservation preference (open | none).

    \n
    • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id\n - The ID of the targeted Capacity Reservation.

    \n
    • \n
  • \n

    \n capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn\n - The ARN of the targeted Capacity Reservation group.

    \n
    • \n
  • \n

    \n client-token - The idempotency token you provided when you\n launched the instance.

    \n
    • \n
  • \n

    \n current-instance-boot-mode - The boot mode that is used to launch\n the instance at launch or start (legacy-bios |\n uefi).

    \n
    • \n
  • \n

    \n dns-name - The public DNS name of the instance.

    \n
    • \n
  • \n

    \n ebs-optimized - A Boolean that indicates whether the instance is\n optimized for Amazon EBS I/O.

    \n
    • \n
  • \n

    \n ena-support - A Boolean that indicates whether the instance is\n enabled for enhanced networking with ENA.

    \n
    • \n
  • \n

    \n enclave-options.enabled - A Boolean that indicates whether the\n instance is enabled for Amazon Web Services Nitro Enclaves.

    \n
    • \n
  • \n

    \n hibernation-options.configured - A Boolean that indicates whether\n the instance is enabled for hibernation. A value of true means that\n the instance is enabled for hibernation.

    \n
    • \n
  • \n

    \n host-id - The ID of the Dedicated Host on which the instance is\n running, if applicable.

    \n
    • \n
  • \n

    \n hypervisor - The hypervisor type of the instance\n (ovm | xen). The value xen is used\n for both Xen and Nitro hypervisors.

    \n
    • \n
  • \n

    \n iam-instance-profile.arn - The instance profile associated with\n the instance. Specified as an ARN.

    \n
    • \n
  • \n

    \n iam-instance-profile.id - The instance profile associated with\n the instance. Specified as an ID.

    \n
    • \n
  • \n

    \n image-id - The ID of the image used to launch the\n instance.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance.

    \n
    • \n
  • \n

    \n instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or\n a Capacity Block (spot | scheduled | capacity-block).

    \n
    • \n
  • \n

    \n instance-state-code - The state of the instance, as a 16-bit\n unsigned integer. The high byte is used for internal purposes and should be\n ignored. The low byte is set based on the state represented. The valid values\n are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64\n (stopping), and 80 (stopped).

    \n
    • \n
  • \n

    \n instance-state-name - The state of the instance\n (pending | running | shutting-down |\n terminated | stopping |\n stopped).

    \n
    • \n
  • \n

    \n instance-type - The type of instance (for example,\n t2.micro).

    \n
    • \n
  • \n

    \n instance.group-id - The ID of the security group for the\n instance.

    \n
    • \n
  • \n

    \n instance.group-name - The name of the security group for the\n instance.

    \n
    • \n
  • \n

    \n ip-address - The public IPv4 address of the instance.

    \n
    • \n
  • \n

    \n ipv6-address - The IPv6 address of the instance.

    \n
    • \n
  • \n

    \n kernel-id - The kernel ID.

    \n
    • \n
  • \n

    \n key-name - The name of the key pair used when the instance was\n launched.

    \n
    • \n
  • \n

    \n launch-index - When launching multiple instances, this is the\n index for the instance in the launch group (for example, 0, 1, 2, and so on).\n

    \n
    • \n
  • \n

    \n launch-time - The time when the instance was launched, in the ISO\n 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,\n 2021-09-29T11:04:43.305Z. You can use a wildcard\n (*), for example, 2021-09-29T*, which matches an\n entire day.

    \n
    • \n
  • \n

    \n maintenance-options.auto-recovery - The current automatic\n recovery behavior of the instance (disabled | default).

    \n
    • \n
  • \n

    \n metadata-options.http-endpoint - The status of access to the HTTP\n metadata endpoint on your instance (enabled |\n disabled)

    \n
    • \n
  • \n

    \n metadata-options.http-protocol-ipv4 - Indicates whether the IPv4\n endpoint is enabled (disabled | enabled).

    \n
    • \n
  • \n

    \n metadata-options.http-protocol-ipv6 - Indicates whether the IPv6\n endpoint is enabled (disabled | enabled).

    \n
    • \n
  • \n

    \n metadata-options.http-put-response-hop-limit - The HTTP metadata\n request put response hop limit (integer, possible values 1 to\n 64)

    \n
    • \n
  • \n

    \n metadata-options.http-tokens - The metadata request authorization\n state (optional | required)

    \n
    • \n
  • \n

    \n metadata-options.instance-metadata-tags - The status of access to\n instance tags from the instance metadata (enabled |\n disabled)

    \n
    • \n
  • \n

    \n metadata-options.state - The state of the metadata option changes\n (pending | applied).

    \n
    • \n
  • \n

    \n monitoring-state - Indicates whether detailed monitoring is\n enabled (disabled | enabled).

    \n
    • \n
  • \n

    \n network-interface.addresses.association.allocation-id - The allocation ID.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.association-id - The association ID.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.carrier-ip - The carrier IP address.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.ip-owner-id - The owner\n ID of the private IPv4 address associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.public-dns-name - The public DNS name.

    \n
    • \n
  • \n

    \n network-interface.addresses.association.public-ip - The ID of the\n association of an Elastic IP address (IPv4) with a network interface.

    \n
    • \n
  • \n

    \n network-interface.addresses.primary - Specifies whether the IPv4\n address of the network interface is the primary private IPv4 address.

    \n
    • \n
  • \n

    \n network-interface.addresses.private-dns-name - The private DNS name.

    \n
    • \n
  • \n

    \n network-interface.addresses.private-ip-address - The private IPv4\n address associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.association.allocation-id - The allocation ID\n returned when you allocated the Elastic IP address (IPv4) for your network\n interface.

    \n
    • \n
  • \n

    \n network-interface.association.association-id - The association ID\n returned when the network interface was associated with an IPv4 address.

    \n
    • \n
  • \n

    \n network-interface.association.carrier-ip - The customer-owned IP address.

    \n
    • \n
  • \n

    \n network-interface.association.customer-owned-ip - The customer-owned IP address.

    \n
    • \n
  • \n

    \n network-interface.association.ip-owner-id - The owner of the\n Elastic IP address (IPv4) associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.association.public-dns-name - The public DNS name.

    \n
    • \n
  • \n

    \n network-interface.association.public-ip - The address of the\n Elastic IP address (IPv4) bound to the network interface.

    \n
    • \n
  • \n

    \n network-interface.attachment.attach-time - The time that the\n network interface was attached to an instance.

    \n
    • \n
  • \n

    \n network-interface.attachment.attachment-id - The ID of the\n interface attachment.

    \n
    • \n
  • \n

    \n network-interface.attachment.delete-on-termination - Specifies\n whether the attachment is deleted when an instance is terminated.

    \n
    • \n
  • \n

    \n network-interface.attachment.device-index - The device index to\n which the network interface is attached.

    \n
    • \n
  • \n

    \n network-interface.attachment.instance-id - The ID of the instance\n to which the network interface is attached.

    \n
    • \n
  • \n

    \n network-interface.attachment.instance-owner-id - The owner ID of\n the instance to which the network interface is attached.

    \n
    • \n
  • \n

    \n network-interface.attachment.network-card-index - The index of the network card.

    \n
    • \n
  • \n

    \n network-interface.attachment.status - The status of the\n attachment (attaching | attached |\n detaching | detached).

    \n
    • \n
  • \n

    \n network-interface.availability-zone - The Availability Zone for\n the network interface.

    \n
    • \n
  • \n

    \n network-interface.deny-all-igw-traffic - A Boolean that indicates whether \n a network interface with an IPv6 address is unreachable from the public internet.

    \n
    • \n
  • \n

    \n network-interface.description - The description of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.group-id - The ID of a security group\n associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.group-name - The name of a security group\n associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv6-address - The IPv6 address associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv6-addresses.ipv6-address - The IPv6 address\n associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this\n is the primary IPv6 address.

    \n
    • \n
  • \n

    \n network-interface.ipv6-native - A Boolean that indicates whether this is\n an IPv6 only network interface.

    \n
    • \n
  • \n

    \n network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.

    \n
    • \n
  • \n

    \n network-interface.mac-address - The MAC address of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.network-interface-id - The ID of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.outpost-arn - The ARN of the Outpost.

    \n
    • \n
  • \n

    \n network-interface.owner-id - The ID of the owner of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.private-dns-name - The private DNS name of the\n network interface.

    \n
    • \n
  • \n

    \n network-interface.private-ip-address - The private IPv4 address.

    \n
    • \n
  • \n

    \n network-interface.public-dns-name - The public DNS name.

    \n
    • \n
  • \n

    \n network-interface.requester-id - The requester ID for the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.requester-managed - Indicates whether the\n network interface is being managed by Amazon Web Services.

    \n
    • \n
  • \n

    \n network-interface.status - The status of the network interface\n (available) | in-use).

    \n
    • \n
  • \n

    \n network-interface.source-dest-check - Whether the network\n interface performs source/destination checking. A value of true\n means that checking is enabled, and false means that checking is\n disabled. The value must be false for the network interface to\n perform network address translation (NAT) in your VPC.

    \n
    • \n
  • \n

    \n network-interface.subnet-id - The ID of the subnet for the\n network interface.

    \n
    • \n
  • \n

    \n network-interface.tag-key - The key of a tag assigned to the network interface.

    \n
    • \n
  • \n

    \n network-interface.tag-value - The value of a tag assigned to the network interface.

    \n
    • \n
  • \n

    \n network-interface.vpc-id - The ID of the VPC for the network\n interface.

    \n
    • \n
  • \n

    \n outpost-arn - The Amazon Resource Name (ARN) of the\n Outpost.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the instance\n owner.

    \n
    • \n
  • \n

    \n placement-group-name - The name of the placement group for the\n instance.

    \n
    • \n
  • \n

    \n placement-partition-number - The partition in which the instance is\n located.

    \n
    • \n
  • \n

    \n platform - The platform. To list only Windows instances, use\n windows.

    \n
    • \n
  • \n

    \n platform-details - The platform (Linux/UNIX |\n Red Hat BYOL Linux | Red Hat Enterprise Linux |\n Red Hat Enterprise Linux with HA | Red Hat Enterprise\n Linux with SQL Server Standard and HA | Red Hat Enterprise\n Linux with SQL Server Enterprise and HA | Red Hat Enterprise\n Linux with SQL Server Standard | Red Hat Enterprise Linux with\n SQL Server Web | Red Hat Enterprise Linux with SQL Server\n Enterprise | SQL Server Enterprise | SQL Server\n Standard | SQL Server Web | SUSE Linux |\n Ubuntu Pro | Windows | Windows BYOL |\n Windows with SQL Server Enterprise | Windows with SQL\n Server Standard | Windows with SQL Server Web).

    \n
    • \n
  • \n

    \n private-dns-name - The private IPv4 DNS name of the\n instance.

    \n
    • \n
  • \n

    \n private-dns-name-options.enable-resource-name-dns-a-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS A records.

    \n
    • \n
  • \n

    \n private-dns-name-options.enable-resource-name-dns-aaaa-record - A\n Boolean that indicates whether to respond to DNS queries for instance hostnames\n with DNS AAAA records.

    \n
    • \n
  • \n

    \n private-dns-name-options.hostname-type - The type of hostname\n (ip-name | resource-name).

    \n
    • \n
  • \n

    \n private-ip-address - The private IPv4 address of the instance.\n This can only be used to filter by the primary IP address of the network\n interface attached to the instance. To filter by additional IP addresses\n assigned to the network interface, use the filter\n network-interface.addresses.private-ip-address.

    \n
    • \n
  • \n

    \n product-code - The product code associated with the AMI used to\n launch the instance.

    \n
    • \n
  • \n

    \n product-code.type - The type of product code (devpay\n | marketplace).

    \n
    • \n
  • \n

    \n ramdisk-id - The RAM disk ID.

    \n
    • \n
  • \n

    \n reason - The reason for the current state of the instance (for\n example, shows \"User Initiated [date]\" when you stop or terminate the instance).\n Similar to the state-reason-code filter.

    \n
    • \n
  • \n

    \n requester-id - The ID of the entity that launched the instance on\n your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so\n on).

    \n
    • \n
  • \n

    \n reservation-id - The ID of the instance's reservation. A\n reservation ID is created any time you launch an instance. A reservation ID has\n a one-to-one relationship with an instance launch request, but can be associated\n with more than one instance if you launch multiple instances using the same\n launch request. For example, if you launch one instance, you get one reservation\n ID. If you launch ten instances using the same launch request, you also get one\n reservation ID.

    \n
    • \n
  • \n

    \n root-device-name - The device name of the root device volume (for\n example, /dev/sda1).

    \n
    • \n
  • \n

    \n root-device-type - The type of the root device volume\n (ebs | instance-store).

    \n
    • \n
  • \n

    \n source-dest-check - Indicates whether the instance performs\n source/destination checking. A value of true means that checking is\n enabled, and false means that checking is disabled. The value must\n be false for the instance to perform network address translation\n (NAT) in your VPC.

    \n
    • \n
  • \n

    \n spot-instance-request-id - The ID of the Spot Instance\n request.

    \n
    • \n
  • \n

    \n state-reason-code - The reason code for the state change.

    \n
    • \n
  • \n

    \n state-reason-message - A message that describes the state\n change.

    \n
    • \n
  • \n

    \n subnet-id - The ID of the subnet for the instance.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n tenancy - The tenancy of an instance (dedicated |\n default | host).

    \n
    • \n
  • \n

    \n tpm-support - Indicates if the instance is configured for\n NitroTPM support (v2.0).

    \n
    • \n
  • \n

    \n usage-operation - The usage operation value for the instance\n (RunInstances | RunInstances:00g0 |\n RunInstances:0010 | RunInstances:1010 |\n RunInstances:1014 | RunInstances:1110 |\n RunInstances:0014 | RunInstances:0210 |\n RunInstances:0110 | RunInstances:0100 |\n RunInstances:0004 | RunInstances:0200 |\n RunInstances:000g | RunInstances:0g00 |\n RunInstances:0002 | RunInstances:0800 |\n RunInstances:0102 | RunInstances:0006 |\n RunInstances:0202).

    \n
    • \n
  • \n

    \n usage-operation-update-time - The time that the usage operation\n was last updated, for example, 2022-09-15T17:15:20.000Z.

    \n
    • \n
  • \n

    \n virtualization-type - The virtualization type of the instance\n (paravirtual | hvm).

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC that the instance is running in.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } }, "NextToken": { @@ -32621,6 +33019,14 @@ "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", "smithy.api#xmlName": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the instance IDs parameter in the same request.

", + "smithy.api#xmlName": "maxResults" + } } }, "traits": { @@ -32630,14 +33036,6 @@ "com.amazonaws.ec2#DescribeInstancesResult": { "type": "structure", "members": { - "Reservations": { - "target": "com.amazonaws.ec2#ReservationList", - "traits": { - "aws.protocols#ec2QueryName": "ReservationSet", - "smithy.api#documentation": "

Information about the reservations.

", - "smithy.api#xmlName": "reservationSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -32645,6 +33043,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "Reservations": { + "target": "com.amazonaws.ec2#ReservationList", + "traits": { + "aws.protocols#ec2QueryName": "ReservationSet", + "smithy.api#documentation": "

Information about the reservations.

", + "smithy.api#xmlName": "reservationSet" + } } }, "traits": { @@ -32737,11 +33143,16 @@ "com.amazonaws.ec2#DescribeInternetGatewaysRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n attachment.state - The current state of the attachment between the gateway\n and the VPC (available). Present only if a VPC is attached.

    \n
    • \n
  • \n

    \n attachment.vpc-id - The ID of an attached VPC.

    \n
    • \n
  • \n

    \n internet-gateway-id - The ID of the Internet gateway.

    \n
    • \n
  • \n

    \n owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" } }, "DryRun": { @@ -32760,16 +33171,11 @@ "smithy.api#xmlName": "internetGatewayId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeInternetGatewaysMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n attachment.state - The current state of the attachment between the gateway\n and the VPC (available). Present only if a VPC is attached.

    \n
    • \n
  • \n

    \n attachment.vpc-id - The ID of an attached VPC.

    \n
    • \n
  • \n

    \n internet-gateway-id - The ID of the Internet gateway.

    \n
    • \n
  • \n

    \n owner-id - The ID of the Amazon Web Services account that owns the internet gateway.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -33500,13 +33906,6 @@ "com.amazonaws.ec2#DescribeKeyPairsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n key-pair-id - The ID of the key pair.

    \n
    • \n
  • \n

    \n fingerprint - The fingerprint of the key pair.

    \n
    • \n
  • \n

    \n key-name - The name of the key pair.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "KeyNames": { "target": "com.amazonaws.ec2#KeyNameStringList", "traits": { @@ -33521,6 +33920,12 @@ "smithy.api#xmlName": "KeyPairId" } }, + "IncludePublicKey": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

If true, the public key material is included in the response.

\n

Default: false\n

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -33529,10 +33934,11 @@ "smithy.api#xmlName": "dryRun" } }, - "IncludePublicKey": { - "target": "com.amazonaws.ec2#Boolean", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

If true, the public key material is included in the response.

\n

Default: false\n

" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n key-pair-id - The ID of the key pair.

    \n
    • \n
  • \n

    \n fingerprint - The fingerprint of the key pair.

    \n
    • \n
  • \n

    \n key-name - The name of the key pair.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -34637,14 +35043,6 @@ "com.amazonaws.ec2#DescribeMovingAddressesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n moving-status - The status of the Elastic IP address\n (MovingToVpc | RestoringToClassic).

    \n
    • \n
", - "smithy.api#xmlName": "filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -34653,12 +35051,12 @@ "smithy.api#xmlName": "dryRun" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeMovingAddressesMaxResults", + "PublicIps": { + "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1000; if\n MaxResults is given a value outside of this range, an error is returned.

\n

Default: If no value is provided, the default is 1000.

", - "smithy.api#xmlName": "maxResults" + "aws.protocols#ec2QueryName": "PublicIp", + "smithy.api#documentation": "

One or more Elastic IP addresses.

", + "smithy.api#xmlName": "publicIp" } }, "NextToken": { @@ -34669,12 +35067,20 @@ "smithy.api#xmlName": "nextToken" } }, - "PublicIps": { - "target": "com.amazonaws.ec2#ValueStringList", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "aws.protocols#ec2QueryName": "PublicIp", - "smithy.api#documentation": "

One or more Elastic IP addresses.

", - "smithy.api#xmlName": "publicIp" + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n moving-status - The status of the Elastic IP address\n (MovingToVpc | RestoringToClassic).

    \n
    • \n
", + "smithy.api#xmlName": "filter" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeMovingAddressesMaxResults", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n results of the initial request can be seen by sending another request with the returned\n NextToken value. This value can be between 5 and 1000; if\n MaxResults is given a value outside of this range, an error is returned.

\n

Default: If no value is provided, the default is 1000.

", + "smithy.api#xmlName": "maxResults" } } }, @@ -34982,11 +35388,16 @@ "com.amazonaws.ec2#DescribeNetworkAclsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n association.association-id - The ID of an association ID for the ACL.

    \n
    • \n
  • \n

    \n association.network-acl-id - The ID of the network ACL involved in the association.

    \n
    • \n
  • \n

    \n association.subnet-id - The ID of the subnet involved in the association.

    \n
    • \n
  • \n

    \n default - Indicates whether the ACL is the default network ACL for the VPC.

    \n
    • \n
  • \n

    \n entry.cidr - The IPv4 CIDR range specified in the entry.

    \n
    • \n
  • \n

    \n entry.icmp.code - The ICMP code specified in the entry, if any.

    \n
    • \n
  • \n

    \n entry.icmp.type - The ICMP type specified in the entry, if any.

    \n
    • \n
  • \n

    \n entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

    \n
    • \n
  • \n

    \n entry.port-range.from - The start of the port range specified in the entry.

    \n
    • \n
  • \n

    \n entry.port-range.to - The end of the port range specified in the entry.

    \n
    • \n
  • \n

    \n entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

    \n
    • \n
  • \n

    \n entry.rule-action - Allows or denies the matching traffic (allow | deny).

    \n
    • \n
  • \n

    \n entry.egress - A Boolean that indicates the type of rule. Specify true \n\t\t for egress rules, or false for ingress rules.

    \n
    • \n
  • \n

    \n entry.rule-number - The number of an entry (in other words, rule) in\n the set of ACL entries.

    \n
    • \n
  • \n

    \n network-acl-id - The ID of the network ACL.

    \n
    • \n
  • \n

    \n owner-id - The ID of the Amazon Web Services account that owns the network ACL.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC for the network ACL.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkAclsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" } }, "DryRun": { @@ -35004,16 +35415,11 @@ "smithy.api#xmlName": "NetworkAclId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeNetworkAclsMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n association.association-id - The ID of an association ID for the ACL.

    \n
    • \n
  • \n

    \n association.network-acl-id - The ID of the network ACL involved in the association.

    \n
    • \n
  • \n

    \n association.subnet-id - The ID of the subnet involved in the association.

    \n
    • \n
  • \n

    \n default - Indicates whether the ACL is the default network ACL for the VPC.

    \n
    • \n
  • \n

    \n entry.cidr - The IPv4 CIDR range specified in the entry.

    \n
    • \n
  • \n

    \n entry.icmp.code - The ICMP code specified in the entry, if any.

    \n
    • \n
  • \n

    \n entry.icmp.type - The ICMP type specified in the entry, if any.

    \n
    • \n
  • \n

    \n entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

    \n
    • \n
  • \n

    \n entry.port-range.from - The start of the port range specified in the entry.

    \n
    • \n
  • \n

    \n entry.port-range.to - The end of the port range specified in the entry.

    \n
    • \n
  • \n

    \n entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

    \n
    • \n
  • \n

    \n entry.rule-action - Allows or denies the matching traffic (allow | deny).

    \n
    • \n
  • \n

    \n entry.egress - A Boolean that indicates the type of rule. Specify true \n\t\t for egress rules, or false for ingress rules.

    \n
    • \n
  • \n

    \n entry.rule-number - The number of an entry (in other words, rule) in\n the set of ACL entries.

    \n
    • \n
  • \n

    \n network-acl-id - The ID of the network ACL.

    \n
    • \n
  • \n

    \n owner-id - The ID of the Amazon Web Services account that owns the network ACL.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC for the network ACL.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -35491,14 +35897,6 @@ "com.amazonaws.ec2#DescribeNetworkInterfaceAttributeRequest": { "type": "structure", "members": { - "Attribute": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttribute", - "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#documentation": "

The attribute of the network interface. This parameter is required.

", - "smithy.api#xmlName": "attribute" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -35516,6 +35914,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "networkInterfaceId" } + }, + "Attribute": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttribute", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#documentation": "

The attribute of the network interface. This parameter is required.

", + "smithy.api#xmlName": "attribute" + } } }, "traits": { @@ -35787,12 +36193,16 @@ "com.amazonaws.ec2#DescribeNetworkInterfacesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Filter", - "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n association.allocation-id - The allocation ID returned when you\n\t\t allocated the Elastic IP address (IPv4) for your network interface.

    \n
    • \n
  • \n

    \n association.association-id - The association ID returned when the\n\t\t network interface was associated with an IPv4 address.

    \n
    • \n
  • \n

    \n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

    \n
    • \n
  • \n

    \n addresses.association.public-ip - The association ID returned when\n\t\t the network interface was associated with the Elastic IP address\n\t\t (IPv4).

    \n
    • \n
  • \n

    \n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.

    \n
    • \n
  • \n

    \n addresses.private-ip-address - The private IPv4 addresses\n\t\t associated with the network interface.

    \n
    • \n
  • \n

    \n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.

    \n
    • \n
  • \n

    \n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.

    \n
    • \n
  • \n

    \n association.public-dns-name - The public DNS name for the network\n interface (IPv4).

    \n
    • \n
  • \n

    \n attachment.attach-time - The time that the network interface was attached to an instance.

    \n
    • \n
  • \n

    \n attachment.attachment-id - The ID of the interface attachment.

    \n
    • \n
  • \n

    \n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

    \n
    • \n
  • \n

    \n attachment.device-index - The device index to which the network interface is attached.

    \n
    • \n
  • \n

    \n attachment.instance-id - The ID of the instance to which the network interface is attached.

    \n
    • \n
  • \n

    \n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

    \n
    • \n
  • \n

    \n attachment.status - The status of the attachment (attaching | attached | detaching | detached).

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone of the network interface.

    \n
    • \n
  • \n

    \n description - The description of the network interface.

    \n
    • \n
  • \n

    \n group-id - The ID of a security group associated with the network interface.

    \n
    • \n
  • \n

    \n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.

    \n
    • \n
  • \n

    \n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | \n\t\t ec2_instance_connect_endpoint | efa | efs | \n\t\t gateway_load_balancer | gateway_load_balancer_endpoint | \n\t\t global_accelerator_managed | \n\t\t interface | iot_rules_managed | \n\t\t lambda | load_balancer | \n\t\t nat_gateway | network_load_balancer | \n\t\t quicksight | \n\t\t transit_gateway | trunk | \n\t\t vpc_endpoint).

    \n
    • \n
  • \n

    \n mac-address - The MAC address of the network interface.

    \n
    • \n
  • \n

    \n network-interface-id - The ID of the network interface.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the network interface owner.

    \n
    • \n
  • \n

    \n private-dns-name - The private DNS name of the network interface (IPv4).

    \n
    • \n
  • \n

    \n private-ip-address - The private IPv4 address or addresses of the\n network interface.

    \n
    • \n
  • \n

    \n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.

    \n
    • \n
  • \n

    \n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services \n\t\t service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

    \n
    • \n
  • \n

    \n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.

    \n
    • \n
  • \n

    \n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.

    \n
    • \n
  • \n

    \n subnet-id - The ID of the subnet for the network interface.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC for the network interface.

    \n
    • \n
", - "smithy.api#xmlName": "filter" + "smithy.api#documentation": "

The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n\t\t make another request with the token returned in the output. You cannot specify this\n\t\t parameter and the network interface IDs parameter in the same request. For more information, \n\t\t see Pagination.

" } }, "DryRun": { @@ -35810,16 +36220,12 @@ "smithy.api#xmlName": "NetworkInterfaceId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request.\n\t\t Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeNetworkInterfacesMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n\t\t make another request with the token returned in the output. You cannot specify this\n\t\t parameter and the network interface IDs parameter in the same request. For more information, \n\t\t see Pagination.

" + "aws.protocols#ec2QueryName": "Filter", + "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n association.allocation-id - The allocation ID returned when you\n\t\t allocated the Elastic IP address (IPv4) for your network interface.

    \n
    • \n
  • \n

    \n association.association-id - The association ID returned when the\n\t\t network interface was associated with an IPv4 address.

    \n
    • \n
  • \n

    \n addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

    \n
    • \n
  • \n

    \n addresses.association.public-ip - The association ID returned when\n\t\t the network interface was associated with the Elastic IP address\n\t\t (IPv4).

    \n
    • \n
  • \n

    \n addresses.primary - Whether the private IPv4 address is the primary\n IP address associated with the network interface.

    \n
    • \n
  • \n

    \n addresses.private-ip-address - The private IPv4 addresses\n\t\t associated with the network interface.

    \n
    • \n
  • \n

    \n association.ip-owner-id - The owner of the Elastic IP address\n (IPv4) associated with the network interface.

    \n
    • \n
  • \n

    \n association.public-ip - The address of the Elastic IP address\n (IPv4) bound to the network interface.

    \n
    • \n
  • \n

    \n association.public-dns-name - The public DNS name for the network\n interface (IPv4).

    \n
    • \n
  • \n

    \n attachment.attach-time - The time that the network interface was attached to an instance.

    \n
    • \n
  • \n

    \n attachment.attachment-id - The ID of the interface attachment.

    \n
    • \n
  • \n

    \n attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

    \n
    • \n
  • \n

    \n attachment.device-index - The device index to which the network interface is attached.

    \n
    • \n
  • \n

    \n attachment.instance-id - The ID of the instance to which the network interface is attached.

    \n
    • \n
  • \n

    \n attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

    \n
    • \n
  • \n

    \n attachment.status - The status of the attachment (attaching | attached | detaching | detached).

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone of the network interface.

    \n
    • \n
  • \n

    \n description - The description of the network interface.

    \n
    • \n
  • \n

    \n group-id - The ID of a security group associated with the network interface.

    \n
    • \n
  • \n

    \n ipv6-addresses.ipv6-address - An IPv6 address associated with\n the network interface.

    \n
    • \n
  • \n

    \n interface-type - The type of network interface (api_gateway_managed | \n\t\t aws_codestar_connections_managed | branch | \n\t\t ec2_instance_connect_endpoint | efa | efs | \n\t\t gateway_load_balancer | gateway_load_balancer_endpoint | \n\t\t global_accelerator_managed | \n\t\t interface | iot_rules_managed | \n\t\t lambda | load_balancer | \n\t\t nat_gateway | network_load_balancer | \n\t\t quicksight | \n\t\t transit_gateway | trunk | \n\t\t vpc_endpoint).

    \n
    • \n
  • \n

    \n mac-address - The MAC address of the network interface.

    \n
    • \n
  • \n

    \n network-interface-id - The ID of the network interface.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the network interface owner.

    \n
    • \n
  • \n

    \n private-dns-name - The private DNS name of the network interface (IPv4).

    \n
    • \n
  • \n

    \n private-ip-address - The private IPv4 address or addresses of the\n network interface.

    \n
    • \n
  • \n

    \n requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.

    \n
    • \n
  • \n

    \n requester-managed - Indicates whether the network interface is being managed by an Amazon Web Services \n\t\t service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

    \n
    • \n
  • \n

    \n source-dest-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform network address translation (NAT) in your VPC.

    \n
    • \n
  • \n

    \n status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.

    \n
    • \n
  • \n

    \n subnet-id - The ID of the subnet for the network interface.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC for the network interface.

    \n
    • \n
", + "smithy.api#xmlName": "filter" } } }, @@ -35867,18 +36273,18 @@ "com.amazonaws.ec2#DescribePlacementGroupsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "GroupIds": { + "target": "com.amazonaws.ec2#PlacementGroupIdStringList", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n group-name - The name of the placement group.

    \n
    • \n
  • \n

    \n group-arn - The Amazon Resource Name (ARN) of the placement\n group.

    \n
    • \n
  • \n

    \n spread-level - The spread level for the placement group\n (host | rack).

    \n
    • \n
  • \n

    \n state - The state of the placement group (pending |\n available | deleting |\n deleted).

    \n
    • \n
  • \n

    \n strategy - The strategy of the placement group\n (cluster | spread |\n partition).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The IDs of the placement groups.

", + "smithy.api#xmlName": "GroupId" } }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, @@ -35890,11 +36296,11 @@ "smithy.api#xmlName": "groupName" } }, - "GroupIds": { - "target": "com.amazonaws.ec2#PlacementGroupIdStringList", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The IDs of the placement groups.

", - "smithy.api#xmlName": "GroupId" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n group-name - The name of the placement group.

    \n
    • \n
  • \n

    \n group-arn - The Amazon Resource Name (ARN) of the placement\n group.

    \n
    • \n
  • \n

    \n spread-level - The spread level for the placement group\n (host | rack).

    \n
    • \n
  • \n

    \n state - The state of the placement group (pending |\n available | deleting |\n deleted).

    \n
    • \n
  • \n

    \n strategy - The strategy of the placement group\n (cluster | spread |\n partition).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -36242,13 +36648,6 @@ "com.amazonaws.ec2#DescribeRegionsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

    \n
    • \n
  • \n

    \n opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | \n not-opted-in).

    \n
    • \n
  • \n

    \n region-name - The name of the Region (for example, us-east-1).

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "RegionNames": { "target": "com.amazonaws.ec2#RegionNameStringList", "traits": { @@ -36256,6 +36655,12 @@ "smithy.api#xmlName": "RegionName" } }, + "AllRegions": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to display all Regions, including Regions that are disabled for your account.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -36264,10 +36669,11 @@ "smithy.api#xmlName": "dryRun" } }, - "AllRegions": { - "target": "com.amazonaws.ec2#Boolean", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

Indicates whether to display all Regions, including Regions that are disabled for your account.

" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

    \n
    • \n
  • \n

    \n opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | \n not-opted-in).

    \n
    • \n
  • \n

    \n region-name - The name of the Region (for example, us-east-1).

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -36409,13 +36815,6 @@ "com.amazonaws.ec2#DescribeReservedInstancesListingsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n reserved-instances-id - The ID of the Reserved Instances.

    \n
    • \n
  • \n

    \n reserved-instances-listing-id - The ID of the Reserved Instances listing.

    \n
    • \n
  • \n

    \n status - The status of the Reserved Instance listing (pending | active |\n cancelled | closed).

    \n
    • \n
  • \n

    \n status-message - The reason for the status.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "ReservedInstancesId": { "target": "com.amazonaws.ec2#ReservationId", "traits": { @@ -36431,6 +36830,13 @@ "smithy.api#documentation": "

One or more Reserved Instance listing IDs.

", "smithy.api#xmlName": "reservedInstancesListingId" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n reserved-instances-id - The ID of the Reserved Instances.

    \n
    • \n
  • \n

    \n reserved-instances-listing-id - The ID of the Reserved Instances listing.

    \n
    • \n
  • \n

    \n status - The status of the Reserved Instance listing (pending | active |\n cancelled | closed).

    \n
    • \n
  • \n

    \n status-message - The reason for the status.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -36475,13 +36881,6 @@ "com.amazonaws.ec2#DescribeReservedInstancesModificationsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n client-token - The idempotency token for the modification request.

    \n
    • \n
  • \n

    \n create-date - The time when the modification request was created.

    \n
    • \n
  • \n

    \n effective-date - The time when the modification becomes effective.

    \n
    • \n
  • \n

    \n modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

    \n
    • \n
  • \n

    \n modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

    \n
    • \n
  • \n

    \n modification-result.target-configuration.instance-count - The number of new Reserved Instances.

    \n
    • \n
  • \n

    \n modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

    \n
    • \n
  • \n

    \n reserved-instances-id - The ID of the Reserved Instances modified.

    \n
    • \n
  • \n

    \n reserved-instances-modification-id - The ID of the modification request.

    \n
    • \n
  • \n

    \n status - The status of the Reserved Instances modification request\n (processing | fulfilled | failed).

    \n
    • \n
  • \n

    \n status-message - The reason for the status.

    \n
    • \n
  • \n

    \n update-date - The time when the modification request was last updated.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "ReservedInstancesModificationIds": { "target": "com.amazonaws.ec2#ReservedInstancesModificationIdStringList", "traits": { @@ -36496,6 +36895,13 @@ "smithy.api#documentation": "

The token to retrieve the next page of results.

", "smithy.api#xmlName": "nextToken" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n client-token - The idempotency token for the modification request.

    \n
    • \n
  • \n

    \n create-date - The time when the modification request was created.

    \n
    • \n
  • \n

    \n effective-date - The time when the modification becomes effective.

    \n
    • \n
  • \n

    \n modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

    \n
    • \n
  • \n

    \n modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

    \n
    • \n
  • \n

    \n modification-result.target-configuration.instance-count - The number of new Reserved Instances.

    \n
    • \n
  • \n

    \n modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

    \n
    • \n
  • \n

    \n reserved-instances-id - The ID of the Reserved Instances modified.

    \n
    • \n
  • \n

    \n reserved-instances-modification-id - The ID of the modification request.

    \n
    • \n
  • \n

    \n status - The status of the Reserved Instances modification request\n (processing | fulfilled | failed).

    \n
    • \n
  • \n

    \n status-message - The reason for the status.

    \n
    • \n
  • \n

    \n update-date - The time when the modification request was last updated.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -36555,13 +36961,6 @@ "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

" } }, - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone where the Reserved Instance can be\n used.

    \n
    • \n
  • \n

    \n duration - The duration of the Reserved Instance (for example, one year or\n three years), in seconds (31536000 | 94608000).

    \n
    • \n
  • \n

    \n fixed-price - The purchase price of the Reserved Instance (for example,\n 9800.0).

    \n
    • \n
  • \n

    \n instance-type - The instance type that is covered by the\n reservation.

    \n
    • \n
  • \n

    \n marketplace - Set to true to show only Reserved Instance\n Marketplace offerings. When this filter is not used, which is the default behavior, all\n offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.

    \n
    • \n
  • \n

    \n product-description - The Reserved Instance product platform description\n (Linux/UNIX | Linux with SQL Server Standard |\n Linux with SQL Server Web | Linux with SQL Server Enterprise |\n SUSE Linux | \n Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | \n Windows | Windows with SQL Server Standard |\n Windows with SQL Server Web | Windows with SQL Server Enterprise).

    \n
    • \n
  • \n

    \n reserved-instances-offering-id - The Reserved Instances offering\n ID.

    \n
    • \n
  • \n

    \n scope - The scope of the Reserved Instance (Availability Zone or\n Region).

    \n
    • \n
  • \n

    \n usage-price - The usage price of the Reserved Instance, per hour (for\n example, 0.84).

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "IncludeMarketplace": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -36619,6 +37018,13 @@ "smithy.api#xmlName": "dryRun" } }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone where the Reserved Instance can be\n used.

    \n
    • \n
  • \n

    \n duration - The duration of the Reserved Instance (for example, one year or\n three years), in seconds (31536000 | 94608000).

    \n
    • \n
  • \n

    \n fixed-price - The purchase price of the Reserved Instance (for example,\n 9800.0).

    \n
    • \n
  • \n

    \n instance-type - The instance type that is covered by the\n reservation.

    \n
    • \n
  • \n

    \n marketplace - Set to true to show only Reserved Instance\n Marketplace offerings. When this filter is not used, which is the default behavior, all\n offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.

    \n
    • \n
  • \n

    \n product-description - The Reserved Instance product platform description\n (Linux/UNIX | Linux with SQL Server Standard |\n Linux with SQL Server Web | Linux with SQL Server Enterprise |\n SUSE Linux | \n Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | \n Windows | Windows with SQL Server Standard |\n Windows with SQL Server Web | Windows with SQL Server Enterprise).

    \n
    • \n
  • \n

    \n reserved-instances-offering-id - The Reserved Instances offering\n ID.

    \n
    • \n
  • \n

    \n scope - The scope of the Reserved Instance (Availability Zone or\n Region).

    \n
    • \n
  • \n

    \n usage-price - The usage price of the Reserved Instance, per hour (for\n example, 0.84).

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } + }, "InstanceTenancy": { "target": "com.amazonaws.ec2#Tenancy", "traits": { @@ -36627,12 +37033,12 @@ "smithy.api#xmlName": "instanceTenancy" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n

Default: 100

", - "smithy.api#xmlName": "maxResults" + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", + "smithy.api#xmlName": "offeringType" } }, "NextToken": { @@ -36643,12 +37049,12 @@ "smithy.api#xmlName": "nextToken" } }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API\n\t\t\tversion, you only have access to the Medium Utilization Reserved Instance\n\t\t\toffering type.

", - "smithy.api#xmlName": "offeringType" + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of results to return for the request in a single page. The remaining\n\t\t\tresults of the initial request can be seen by sending another request with the returned\n\t\t\t\tNextToken value. The maximum is 100.

\n

Default: 100

", + "smithy.api#xmlName": "maxResults" } } }, @@ -36660,14 +37066,6 @@ "com.amazonaws.ec2#DescribeReservedInstancesOfferingsResult": { "type": "structure", "members": { - "ReservedInstancesOfferings": { - "target": "com.amazonaws.ec2#ReservedInstancesOfferingList", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesOfferingsSet", - "smithy.api#documentation": "

A list of Reserved Instances offerings.

", - "smithy.api#xmlName": "reservedInstancesOfferingsSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -36675,6 +37073,14 @@ "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when\n\t\t\tthere are no more results to return.

", "smithy.api#xmlName": "nextToken" } + }, + "ReservedInstancesOfferings": { + "target": "com.amazonaws.ec2#ReservedInstancesOfferingList", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesOfferingsSet", + "smithy.api#documentation": "

A list of Reserved Instances offerings.

", + "smithy.api#xmlName": "reservedInstancesOfferingsSet" + } } }, "traits": { @@ -36685,13 +37091,6 @@ "com.amazonaws.ec2#DescribeReservedInstancesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone where the Reserved Instance can be used.

    \n
    • \n
  • \n

    \n duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

    \n
    • \n
  • \n

    \n end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

    \n
    • \n
  • \n

    \n fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

    \n
    • \n
  • \n

    \n instance-type - The instance type that is covered by the reservation.

    \n
    • \n
  • \n

    \n scope - The scope of the Reserved Instance (Region or Availability Zone).

    \n
    • \n
  • \n

    \n product-description - The Reserved Instance product platform description\n (Linux/UNIX | Linux with SQL Server Standard |\n Linux with SQL Server Web | Linux with SQL Server Enterprise |\n SUSE Linux | \n Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | \n Windows | Windows with SQL Server Standard |\n Windows with SQL Server Web | Windows with SQL Server Enterprise).

    \n
    • \n
  • \n

    \n reserved-instances-id - The ID of the Reserved Instance.

    \n
    • \n
  • \n

    \n start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

    \n
    • \n
  • \n

    \n state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "OfferingClass": { "target": "com.amazonaws.ec2#OfferingClassType", "traits": { @@ -36713,6 +37112,13 @@ "smithy.api#xmlName": "dryRun" } }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

One or more filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone where the Reserved Instance can be used.

    \n
    • \n
  • \n

    \n duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

    \n
    • \n
  • \n

    \n end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

    \n
    • \n
  • \n

    \n fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

    \n
    • \n
  • \n

    \n instance-type - The instance type that is covered by the reservation.

    \n
    • \n
  • \n

    \n scope - The scope of the Reserved Instance (Region or Availability Zone).

    \n
    • \n
  • \n

    \n product-description - The Reserved Instance product platform description\n (Linux/UNIX | Linux with SQL Server Standard |\n Linux with SQL Server Web | Linux with SQL Server Enterprise |\n SUSE Linux | \n Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | \n Windows | Windows with SQL Server Standard |\n Windows with SQL Server Web | Windows with SQL Server Enterprise).

    \n
    • \n
  • \n

    \n reserved-instances-id - The ID of the Reserved Instance.

    \n
    • \n
  • \n

    \n start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

    \n
    • \n
  • \n

    \n state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } + }, "OfferingType": { "target": "com.amazonaws.ec2#OfferingTypeValues", "traits": { @@ -36809,11 +37215,16 @@ "com.amazonaws.ec2#DescribeRouteTablesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n association.gateway-id - The ID of the gateway involved in the\n\t\t association.

    \n
    • \n
  • \n

    \n association.route-table-association-id - The ID of an association\n ID for the route table.

    \n
    • \n
  • \n

    \n association.route-table-id - The ID of the route table involved in\n the association.

    \n
    • \n
  • \n

    \n association.subnet-id - The ID of the subnet involved in the\n association.

    \n
    • \n
  • \n

    \n association.main - Indicates whether the route table is the main\n route table for the VPC (true | false). Route tables\n that do not have an association ID are not returned in the response.

    \n
    • \n
  • \n

    \n owner-id - The ID of the Amazon Web Services account that owns the route table.

    \n
    • \n
  • \n

    \n route-table-id - The ID of the route table.

    \n
    • \n
  • \n

    \n route.destination-cidr-block - The IPv4 CIDR range specified in a\n route in the table.

    \n
    • \n
  • \n

    \n route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.

    \n
    • \n
  • \n

    \n route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Services \n\t\t\t\t service specified in a route in the table.

    \n
    • \n
  • \n

    \n route.egress-only-internet-gateway-id - The ID of an\n egress-only Internet gateway specified in a route in the route table.

    \n
    • \n
  • \n

    \n route.gateway-id - The ID of a gateway specified in a route in the table.

    \n
    • \n
  • \n

    \n route.instance-id - The ID of an instance specified in a route in the table.

    \n
    • \n
  • \n

    \n route.nat-gateway-id - The ID of a NAT gateway.

    \n
    • \n
  • \n

    \n route.transit-gateway-id - The ID of a transit gateway.

    \n
    • \n
  • \n

    \n route.origin - Describes how the route was created. \n CreateRouteTable indicates that the route was automatically\n created when the route table was created; CreateRoute indicates\n that the route was manually added to the route table;\n EnableVgwRoutePropagation indicates that the route was\n propagated by route propagation.

    \n
    • \n
  • \n

    \n route.state - The state of a route in the route table\n (active | blackhole). The blackhole state\n indicates that the route's target isn't available (for example, the specified\n gateway isn't attached to the VPC, the specified NAT instance has been\n terminated, and so on).

    \n
    • \n
  • \n

    \n route.vpc-peering-connection-id - The ID of a VPC peering\n\t\t connection specified in a route in the table.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC for the route table.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeRouteTablesMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" } }, "DryRun": { @@ -36831,16 +37242,11 @@ "smithy.api#xmlName": "RouteTableId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeRouteTablesMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n association.gateway-id - The ID of the gateway involved in the\n\t\t association.

    \n
    • \n
  • \n

    \n association.route-table-association-id - The ID of an association\n ID for the route table.

    \n
    • \n
  • \n

    \n association.route-table-id - The ID of the route table involved in\n the association.

    \n
    • \n
  • \n

    \n association.subnet-id - The ID of the subnet involved in the\n association.

    \n
    • \n
  • \n

    \n association.main - Indicates whether the route table is the main\n route table for the VPC (true | false). Route tables\n that do not have an association ID are not returned in the response.

    \n
    • \n
  • \n

    \n owner-id - The ID of the Amazon Web Services account that owns the route table.

    \n
    • \n
  • \n

    \n route-table-id - The ID of the route table.

    \n
    • \n
  • \n

    \n route.destination-cidr-block - The IPv4 CIDR range specified in a\n route in the table.

    \n
    • \n
  • \n

    \n route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.

    \n
    • \n
  • \n

    \n route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Services \n\t\t\t\t service specified in a route in the table.

    \n
    • \n
  • \n

    \n route.egress-only-internet-gateway-id - The ID of an\n egress-only Internet gateway specified in a route in the route table.

    \n
    • \n
  • \n

    \n route.gateway-id - The ID of a gateway specified in a route in the table.

    \n
    • \n
  • \n

    \n route.instance-id - The ID of an instance specified in a route in the table.

    \n
    • \n
  • \n

    \n route.nat-gateway-id - The ID of a NAT gateway.

    \n
    • \n
  • \n

    \n route.transit-gateway-id - The ID of a transit gateway.

    \n
    • \n
  • \n

    \n route.origin - Describes how the route was created. \n CreateRouteTable indicates that the route was automatically\n created when the route table was created; CreateRoute indicates\n that the route was manually added to the route table;\n EnableVgwRoutePropagation indicates that the route was\n propagated by route propagation.

    \n
    • \n
  • \n

    \n route.state - The state of a route in the route table\n (active | blackhole). The blackhole state\n indicates that the route's target isn't available (for example, the specified\n gateway isn't attached to the VPC, the specified NAT instance has been\n terminated, and so on).

    \n
    • \n
  • \n

    \n route.vpc-peering-connection-id - The ID of a VPC peering\n\t\t connection specified in a route in the table.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC for the route table.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -37321,13 +37727,6 @@ "com.amazonaws.ec2#DescribeSecurityGroupsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

\n
    \n
  • \n

    \n description - The description of the security group.

    \n
    • \n
  • \n

    \n egress.ip-permission.cidr - An IPv4 CIDR block for an outbound\n security group rule.

    \n
    • \n
  • \n

    \n egress.ip-permission.from-port - For an outbound rule, the\n start of port range for the TCP and UDP protocols, or an ICMP type\n number.

    \n
    • \n
  • \n

    \n egress.ip-permission.group-id - The ID of a security group\n that has been referenced in an outbound security group rule.

    \n
    • \n
  • \n

    \n egress.ip-permission.group-name - The name of a security group\n that is referenced in an outbound security group rule.

    \n
    • \n
  • \n

    \n egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an\n outbound security group rule.

    \n
    • \n
  • \n

    \n egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

    \n
    • \n
  • \n

    \n egress.ip-permission.protocol - The IP protocol for an\n outbound security group rule (tcp | udp |\n icmp, a protocol number, or -1 for all protocols).

    \n
    • \n
  • \n

    \n egress.ip-permission.to-port - For an outbound rule, the end\n of port range for the TCP and UDP protocols, or an ICMP code.

    \n
    • \n
  • \n

    \n egress.ip-permission.user-id - The ID of an Amazon Web Services account that\n has been referenced in an outbound security group rule.

    \n
    • \n
  • \n

    \n group-id - The ID of the security group.

    \n
    • \n
  • \n

    \n group-name - The name of the security group.

    \n
    • \n
  • \n

    \n ip-permission.cidr - An IPv4 CIDR block for an inbound security\n group rule.

    \n
    • \n
  • \n

    \n ip-permission.from-port - For an inbound rule, the start of port\n range for the TCP and UDP protocols, or an ICMP type number.

    \n
    • \n
  • \n

    \n ip-permission.group-id - The ID of a security group that has been\n referenced in an inbound security group rule.

    \n
    • \n
  • \n

    \n ip-permission.group-name - The name of a security group that is\n referenced in an inbound security group rule.

    \n
    • \n
  • \n

    \n ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security\n group rule.

    \n
    • \n
  • \n

    \n ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

    \n
    • \n
  • \n

    \n ip-permission.protocol - The IP protocol for an inbound security\n group rule (tcp | udp | icmp, a\n protocol number, or -1 for all protocols).

    \n
    • \n
  • \n

    \n ip-permission.to-port - For an inbound rule, the end of port range\n for the TCP and UDP protocols, or an ICMP code.

    \n
    • \n
  • \n

    \n ip-permission.user-id - The ID of an Amazon Web Services account that has been\n referenced in an inbound security group rule.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the owner of the security group.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC specified when the security group was created.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "GroupIds": { "target": "com.amazonaws.ec2#GroupIdStringList", "traits": { @@ -37342,14 +37741,6 @@ "smithy.api#xmlName": "GroupName" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -37361,6 +37752,21 @@ "traits": { "smithy.api#documentation": "

The maximum number of items to return for this request. To get the next page of items,\n make another request with the token returned in the output. This value can be between 5 and 1000. \n If this parameter is not specified, then all items are returned. For more information, see \n Pagination.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

\n
    \n
  • \n

    \n description - The description of the security group.

    \n
    • \n
  • \n

    \n egress.ip-permission.cidr - An IPv4 CIDR block for an outbound\n security group rule.

    \n
    • \n
  • \n

    \n egress.ip-permission.from-port - For an outbound rule, the\n start of port range for the TCP and UDP protocols, or an ICMP type\n number.

    \n
    • \n
  • \n

    \n egress.ip-permission.group-id - The ID of a security group\n that has been referenced in an outbound security group rule.

    \n
    • \n
  • \n

    \n egress.ip-permission.group-name - The name of a security group\n that is referenced in an outbound security group rule.

    \n
    • \n
  • \n

    \n egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an\n outbound security group rule.

    \n
    • \n
  • \n

    \n egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

    \n
    • \n
  • \n

    \n egress.ip-permission.protocol - The IP protocol for an\n outbound security group rule (tcp | udp |\n icmp, a protocol number, or -1 for all protocols).

    \n
    • \n
  • \n

    \n egress.ip-permission.to-port - For an outbound rule, the end\n of port range for the TCP and UDP protocols, or an ICMP code.

    \n
    • \n
  • \n

    \n egress.ip-permission.user-id - The ID of an Amazon Web Services account that\n has been referenced in an outbound security group rule.

    \n
    • \n
  • \n

    \n group-id - The ID of the security group.

    \n
    • \n
  • \n

    \n group-name - The name of the security group.

    \n
    • \n
  • \n

    \n ip-permission.cidr - An IPv4 CIDR block for an inbound security\n group rule.

    \n
    • \n
  • \n

    \n ip-permission.from-port - For an inbound rule, the start of port\n range for the TCP and UDP protocols, or an ICMP type number.

    \n
    • \n
  • \n

    \n ip-permission.group-id - The ID of a security group that has been\n referenced in an inbound security group rule.

    \n
    • \n
  • \n

    \n ip-permission.group-name - The name of a security group that is\n referenced in an inbound security group rule.

    \n
    • \n
  • \n

    \n ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security\n group rule.

    \n
    • \n
  • \n

    \n ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

    \n
    • \n
  • \n

    \n ip-permission.protocol - The IP protocol for an inbound security\n group rule (tcp | udp | icmp, a\n protocol number, or -1 for all protocols).

    \n
    • \n
  • \n

    \n ip-permission.to-port - For an inbound rule, the end of port range\n for the TCP and UDP protocols, or an ICMP code.

    \n
    • \n
  • \n

    \n ip-permission.user-id - The ID of an Amazon Web Services account that has been\n referenced in an inbound security group rule.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the owner of the security group.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-id - The ID of the VPC specified when the security group was created.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -37370,14 +37776,6 @@ "com.amazonaws.ec2#DescribeSecurityGroupsResult": { "type": "structure", "members": { - "SecurityGroups": { - "target": "com.amazonaws.ec2#SecurityGroupList", - "traits": { - "aws.protocols#ec2QueryName": "SecurityGroupInfo", - "smithy.api#documentation": "

Information about the security groups.

", - "smithy.api#xmlName": "securityGroupInfo" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -37385,6 +37783,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#SecurityGroupList", + "traits": { + "aws.protocols#ec2QueryName": "SecurityGroupInfo", + "smithy.api#documentation": "

Information about the security groups.

", + "smithy.api#xmlName": "securityGroupInfo" + } } }, "traits": { @@ -37452,14 +37858,6 @@ "com.amazonaws.ec2#DescribeSnapshotAttributeResult": { "type": "structure", "members": { - "CreateVolumePermissions": { - "target": "com.amazonaws.ec2#CreateVolumePermissionList", - "traits": { - "aws.protocols#ec2QueryName": "CreateVolumePermission", - "smithy.api#documentation": "

The users and groups that have the permissions for creating volumes from the\n snapshot.

", - "smithy.api#xmlName": "createVolumePermission" - } - }, "ProductCodes": { "target": "com.amazonaws.ec2#ProductCodeList", "traits": { @@ -37475,6 +37873,14 @@ "smithy.api#documentation": "

The ID of the EBS snapshot.

", "smithy.api#xmlName": "snapshotId" } + }, + "CreateVolumePermissions": { + "target": "com.amazonaws.ec2#CreateVolumePermissionList", + "traits": { + "aws.protocols#ec2QueryName": "CreateVolumePermission", + "smithy.api#documentation": "

The users and groups that have the permissions for creating volumes from the\n snapshot.

", + "smithy.api#xmlName": "createVolumePermission" + } } }, "traits": { @@ -37665,13 +38071,6 @@ "com.amazonaws.ec2#DescribeSnapshotsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n description - A description of the snapshot.

    \n
    • \n
  • \n

    \n encrypted - Indicates whether the snapshot is encrypted\n (true | false)

    \n
    • \n
  • \n

    \n owner-alias - The owner alias, from an Amazon-maintained list \n (amazon). \n This is not the user-configured Amazon Web Services account alias set using the IAM console.\n We recommend that you use the related parameter instead of this filter.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the owner. We recommend that \n you use the related parameter instead of this filter.

    \n
    • \n
  • \n

    \n progress - The progress of the snapshot, as a percentage (for example,\n 80%).

    \n
    • \n
  • \n

    \n snapshot-id - The snapshot ID.

    \n
    • \n
  • \n

    \n start-time - The time stamp when the snapshot was initiated.

    \n
    • \n
  • \n

    \n status - The status of the snapshot (pending |\n completed | error).

    \n
    • \n
  • \n

    \n storage-tier - The storage tier of the snapshot (archive |\n standard).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n volume-id - The ID of the volume the snapshot is for.

    \n
    • \n
  • \n

    \n volume-size - The size of the volume, in GiB.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -37712,6 +38111,13 @@ "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.

", "smithy.api#xmlName": "dryRun" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n description - A description of the snapshot.

    \n
    • \n
  • \n

    \n encrypted - Indicates whether the snapshot is encrypted\n (true | false)

    \n
    • \n
  • \n

    \n owner-alias - The owner alias, from an Amazon-maintained list \n (amazon). \n This is not the user-configured Amazon Web Services account alias set using the IAM console.\n We recommend that you use the related parameter instead of this filter.

    \n
    • \n
  • \n

    \n owner-id - The Amazon Web Services account ID of the owner. We recommend that \n you use the related parameter instead of this filter.

    \n
    • \n
  • \n

    \n progress - The progress of the snapshot, as a percentage (for example,\n 80%).

    \n
    • \n
  • \n

    \n snapshot-id - The snapshot ID.

    \n
    • \n
  • \n

    \n start-time - The time stamp when the snapshot was initiated.

    \n
    • \n
  • \n

    \n status - The status of the snapshot (pending |\n completed | error).

    \n
    • \n
  • \n

    \n storage-tier - The storage tier of the snapshot (archive |\n standard).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n volume-id - The ID of the volume the snapshot is for.

    \n
    • \n
  • \n

    \n volume-size - The size of the volume, in GiB.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -37721,14 +38127,6 @@ "com.amazonaws.ec2#DescribeSnapshotsResult": { "type": "structure", "members": { - "Snapshots": { - "target": "com.amazonaws.ec2#SnapshotList", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotSet", - "smithy.api#documentation": "

Information about the snapshots.

", - "smithy.api#xmlName": "snapshotSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -37736,6 +38134,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "Snapshots": { + "target": "com.amazonaws.ec2#SnapshotList", + "traits": { + "aws.protocols#ec2QueryName": "SnapshotSet", + "smithy.api#documentation": "

Information about the snapshots.

", + "smithy.api#xmlName": "snapshotSet" + } } }, "traits": { @@ -37853,12 +38259,14 @@ "smithy.api#xmlName": "dryRun" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults", + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" } }, "NextToken": { @@ -37869,14 +38277,12 @@ "smithy.api#xmlName": "nextToken" } }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#SpotFleetRequestId", + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSpotFleetInstancesMaxResults", "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "spotFleetRequestId" + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" } } }, @@ -37997,6 +38403,16 @@ "smithy.api#xmlName": "dryRun" } }, + "SpotFleetRequestId": { + "target": "com.amazonaws.ec2#SpotFleetRequestId", + "traits": { + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Spot Fleet request.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "spotFleetRequestId" + } + }, "EventType": { "target": "com.amazonaws.ec2#EventType", "traits": { @@ -38005,12 +38421,14 @@ "smithy.api#xmlName": "eventType" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults", + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#required": {}, + "smithy.api#xmlName": "startTime" } }, "NextToken": { @@ -38021,24 +38439,12 @@ "smithy.api#xmlName": "nextToken" } }, - "SpotFleetRequestId": { - "target": "com.amazonaws.ec2#SpotFleetRequestId", - "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the Spot Fleet request.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "spotFleetRequestId" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeSpotFleetRequestHistoryMaxResults", "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The starting date and time for the events, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#required": {}, - "smithy.api#xmlName": "startTime" + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" } } }, @@ -38179,12 +38585,12 @@ "smithy.api#xmlName": "dryRun" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "SpotFleetRequestIds": { + "target": "com.amazonaws.ec2#SpotFleetRequestIdList", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" + "aws.protocols#ec2QueryName": "SpotFleetRequestId", + "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

", + "smithy.api#xmlName": "spotFleetRequestId" } }, "NextToken": { @@ -38195,12 +38601,12 @@ "smithy.api#xmlName": "nextToken" } }, - "SpotFleetRequestIds": { - "target": "com.amazonaws.ec2#SpotFleetRequestIdList", + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "SpotFleetRequestId", - "smithy.api#documentation": "

The IDs of the Spot Fleet requests.

", - "smithy.api#xmlName": "spotFleetRequestId" + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" } } }, @@ -38383,11 +38789,16 @@ "com.amazonaws.ec2#DescribeSpotInstanceRequestsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone-group - The Availability Zone group.

    \n
    • \n
  • \n

    \n create-time - The time stamp when the Spot Instance request was\n created.

    \n
    • \n
  • \n

    \n fault-code - The fault code related to the request.

    \n
    • \n
  • \n

    \n fault-message - The fault message related to the request.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance that fulfilled the\n request.

    \n
    • \n
  • \n

    \n launch-group - The Spot Instance launch group.

    \n
    • \n
  • \n

    \n launch.block-device-mapping.delete-on-termination - Indicates\n whether the EBS volume is deleted on instance termination.

    \n
    • \n
  • \n

    \n launch.block-device-mapping.device-name - The device name for the\n volume in the block device mapping (for example, /dev/sdh or\n xvdh).

    \n
    • \n
  • \n

    \n launch.block-device-mapping.snapshot-id - The ID of the snapshot\n for the EBS volume.

    \n
    • \n
  • \n

    \n launch.block-device-mapping.volume-size - The size of the EBS\n volume, in GiB.

    \n
    • \n
  • \n

    \n launch.block-device-mapping.volume-type - The type of EBS volume:\n gp2 or gp3 for General Purpose SSD, io1 \n or io2 for Provisioned IOPS SSD, st1 for Throughput\n Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic.

    \n
    • \n
  • \n

    \n launch.group-id - The ID of the security group for the\n instance.

    \n
    • \n
  • \n

    \n launch.group-name - The name of the security group for the\n instance.

    \n
    • \n
  • \n

    \n launch.image-id - The ID of the AMI.

    \n
    • \n
  • \n

    \n launch.instance-type - The type of instance (for example,\n m3.medium).

    \n
    • \n
  • \n

    \n launch.kernel-id - The kernel ID.

    \n
    • \n
  • \n

    \n launch.key-name - The name of the key pair the instance launched\n with.

    \n
    • \n
  • \n

    \n launch.monitoring-enabled - Whether detailed monitoring is\n enabled for the Spot Instance.

    \n
    • \n
  • \n

    \n launch.ramdisk-id - The RAM disk ID.

    \n
    • \n
  • \n

    \n launched-availability-zone - The Availability Zone in which the\n request is launched.

    \n
    • \n
  • \n

    \n network-interface.addresses.primary - Indicates whether the IP\n address is the primary private IP address.

    \n
    • \n
  • \n

    \n network-interface.delete-on-termination - Indicates whether the\n network interface is deleted when the instance is terminated.

    \n
    • \n
  • \n

    \n network-interface.description - A description of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.device-index - The index of the device for the\n network interface attachment on the instance.

    \n
    • \n
  • \n

    \n network-interface.group-id - The ID of the security group\n associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.network-interface-id - The ID of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.private-ip-address - The primary private IP\n address of the network interface.

    \n
    • \n
  • \n

    \n network-interface.subnet-id - The ID of the subnet for the\n instance.

    \n
    • \n
  • \n

    \n product-description - The product description associated with the\n instance (Linux/UNIX | Windows).

    \n
    • \n
  • \n

    \n spot-instance-request-id - The Spot Instance request ID.

    \n
    • \n
  • \n

    \n spot-price - The maximum hourly price for any Spot Instance\n launched to fulfill the request.

    \n
    • \n
  • \n

    \n state - The state of the Spot Instance request (open\n | active | closed | cancelled |\n failed). Spot request status information can help you track\n your Amazon EC2 Spot Instance requests. For more information, see Spot\n request status in the Amazon EC2 User Guide.

    \n
    • \n
  • \n

    \n status-code - The short code describing the most recent\n evaluation of your Spot Instance request.

    \n
    • \n
  • \n

    \n status-message - The message explaining the status of the Spot\n Instance request.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n type - The type of Spot Instance request (one-time |\n persistent).

    \n
    • \n
  • \n

    \n valid-from - The start date of the request.

    \n
    • \n
  • \n

    \n valid-until - The end date of the request.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" } }, "DryRun": { @@ -38405,16 +38816,11 @@ "smithy.api#xmlName": "SpotInstanceRequestId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone-group - The Availability Zone group.

    \n
    • \n
  • \n

    \n create-time - The time stamp when the Spot Instance request was\n created.

    \n
    • \n
  • \n

    \n fault-code - The fault code related to the request.

    \n
    • \n
  • \n

    \n fault-message - The fault message related to the request.

    \n
    • \n
  • \n

    \n instance-id - The ID of the instance that fulfilled the\n request.

    \n
    • \n
  • \n

    \n launch-group - The Spot Instance launch group.

    \n
    • \n
  • \n

    \n launch.block-device-mapping.delete-on-termination - Indicates\n whether the EBS volume is deleted on instance termination.

    \n
    • \n
  • \n

    \n launch.block-device-mapping.device-name - The device name for the\n volume in the block device mapping (for example, /dev/sdh or\n xvdh).

    \n
    • \n
  • \n

    \n launch.block-device-mapping.snapshot-id - The ID of the snapshot\n for the EBS volume.

    \n
    • \n
  • \n

    \n launch.block-device-mapping.volume-size - The size of the EBS\n volume, in GiB.

    \n
    • \n
  • \n

    \n launch.block-device-mapping.volume-type - The type of EBS volume:\n gp2 or gp3 for General Purpose SSD, io1 \n or io2 for Provisioned IOPS SSD, st1 for Throughput\n Optimized HDD, sc1 for Cold HDD, or standard for\n Magnetic.

    \n
    • \n
  • \n

    \n launch.group-id - The ID of the security group for the\n instance.

    \n
    • \n
  • \n

    \n launch.group-name - The name of the security group for the\n instance.

    \n
    • \n
  • \n

    \n launch.image-id - The ID of the AMI.

    \n
    • \n
  • \n

    \n launch.instance-type - The type of instance (for example,\n m3.medium).

    \n
    • \n
  • \n

    \n launch.kernel-id - The kernel ID.

    \n
    • \n
  • \n

    \n launch.key-name - The name of the key pair the instance launched\n with.

    \n
    • \n
  • \n

    \n launch.monitoring-enabled - Whether detailed monitoring is\n enabled for the Spot Instance.

    \n
    • \n
  • \n

    \n launch.ramdisk-id - The RAM disk ID.

    \n
    • \n
  • \n

    \n launched-availability-zone - The Availability Zone in which the\n request is launched.

    \n
    • \n
  • \n

    \n network-interface.addresses.primary - Indicates whether the IP\n address is the primary private IP address.

    \n
    • \n
  • \n

    \n network-interface.delete-on-termination - Indicates whether the\n network interface is deleted when the instance is terminated.

    \n
    • \n
  • \n

    \n network-interface.description - A description of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.device-index - The index of the device for the\n network interface attachment on the instance.

    \n
    • \n
  • \n

    \n network-interface.group-id - The ID of the security group\n associated with the network interface.

    \n
    • \n
  • \n

    \n network-interface.network-interface-id - The ID of the network\n interface.

    \n
    • \n
  • \n

    \n network-interface.private-ip-address - The primary private IP\n address of the network interface.

    \n
    • \n
  • \n

    \n network-interface.subnet-id - The ID of the subnet for the\n instance.

    \n
    • \n
  • \n

    \n product-description - The product description associated with the\n instance (Linux/UNIX | Windows).

    \n
    • \n
  • \n

    \n spot-instance-request-id - The Spot Instance request ID.

    \n
    • \n
  • \n

    \n spot-price - The maximum hourly price for any Spot Instance\n launched to fulfill the request.

    \n
    • \n
  • \n

    \n state - The state of the Spot Instance request (open\n | active | closed | cancelled |\n failed). Spot request status information can help you track\n your Amazon EC2 Spot Instance requests. For more information, see Spot\n request status in the Amazon EC2 User Guide.

    \n
    • \n
  • \n

    \n status-code - The short code describing the most recent\n evaluation of your Spot Instance request.

    \n
    • \n
  • \n

    \n status-message - The message explaining the status of the Spot\n Instance request.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n type - The type of Spot Instance request (one-time |\n persistent).

    \n
    • \n
  • \n

    \n valid-from - The start date of the request.

    \n
    • \n
  • \n

    \n valid-until - The end date of the request.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -38503,21 +38909,6 @@ "com.amazonaws.ec2#DescribeSpotPriceHistoryRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone for which prices should\n be returned.

    \n
    • \n
  • \n

    \n instance-type - The type of instance (for example,\n m3.medium).

    \n
    • \n
  • \n

    \n product-description - The product description for the Spot price\n (Linux/UNIX | Red Hat Enterprise Linux |\n SUSE Linux | Windows | Linux/UNIX (Amazon\n VPC) | Red Hat Enterprise Linux (Amazon VPC) |\n SUSE Linux (Amazon VPC) | Windows (Amazon\n VPC)).

    \n
    • \n
  • \n

    \n spot-price - The Spot price. The value must match exactly (or use\n wildcards; greater than or less than comparison is not supported).

    \n
    • \n
  • \n

    \n timestamp - The time stamp of the Spot price history, in UTC format\n (for example, ddd MMM dd\n HH:mm:ss UTC\n YYYY). You can use wildcards (* and\n ?). Greater than or less than comparison is not\n supported.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

", - "smithy.api#xmlName": "availabilityZone" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -38526,6 +38917,14 @@ "smithy.api#xmlName": "dryRun" } }, + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The date and time, up to the past 90 days, from which to start retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", + "smithy.api#xmlName": "startTime" + } + }, "EndTime": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -38541,6 +38940,28 @@ "smithy.api#xmlName": "InstanceType" } }, + "ProductDescriptions": { + "target": "com.amazonaws.ec2#ProductDescriptionList", + "traits": { + "smithy.api#documentation": "

Filters the results by the specified basic product descriptions.

", + "smithy.api#xmlName": "ProductDescription" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n availability-zone - The Availability Zone for which prices should\n be returned.

    \n
    • \n
  • \n

    \n instance-type - The type of instance (for example,\n m3.medium).

    \n
    • \n
  • \n

    \n product-description - The product description for the Spot price\n (Linux/UNIX | Red Hat Enterprise Linux |\n SUSE Linux | Windows | Linux/UNIX (Amazon\n VPC) | Red Hat Enterprise Linux (Amazon VPC) |\n SUSE Linux (Amazon VPC) | Windows (Amazon\n VPC)).

    \n
    • \n
  • \n

    \n spot-price - The Spot price. The value must match exactly (or use\n wildcards; greater than or less than comparison is not supported).

    \n
    • \n
  • \n

    \n timestamp - The time stamp of the Spot price history, in UTC format\n (for example, ddd MMM dd\n HH:mm:ss UTC\n YYYY). You can use wildcards (* and\n ?). Greater than or less than comparison is not\n supported.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

Filters the results by the specified Availability Zone.

", + "smithy.api#xmlName": "availabilityZone" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -38556,21 +38977,6 @@ "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", "smithy.api#xmlName": "nextToken" } - }, - "ProductDescriptions": { - "target": "com.amazonaws.ec2#ProductDescriptionList", - "traits": { - "smithy.api#documentation": "

Filters the results by the specified basic product descriptions.

", - "smithy.api#xmlName": "ProductDescription" - } - }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The date and time, up to the past 90 days, from which to start retrieving the price\n history data, in UTC format (for example,\n YYYY-MM-DDTHH:MM:SSZ).

", - "smithy.api#xmlName": "startTime" - } } }, "traits": { @@ -38916,14 +39322,6 @@ "smithy.api#xmlName": "SubnetId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -38935,6 +39333,14 @@ "traits": { "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } } }, "traits": { @@ -38944,14 +39350,6 @@ "com.amazonaws.ec2#DescribeSubnetsResult": { "type": "structure", "members": { - "Subnets": { - "target": "com.amazonaws.ec2#SubnetList", - "traits": { - "aws.protocols#ec2QueryName": "SubnetSet", - "smithy.api#documentation": "

Information about the subnets.

", - "smithy.api#xmlName": "subnetSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -38959,6 +39357,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "Subnets": { + "target": "com.amazonaws.ec2#SubnetList", + "traits": { + "aws.protocols#ec2QueryName": "SubnetSet", + "smithy.api#documentation": "

Information about the subnets.

", + "smithy.api#xmlName": "subnetSet" + } } }, "traits": { @@ -40944,13 +41350,6 @@ "com.amazonaws.ec2#DescribeVolumeStatusRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n action.code - The action code for the event (for example,\n enable-volume-io).

    \n
    • \n
  • \n

    \n action.description - A description of the action.

    \n
    • \n
  • \n

    \n action.event-id - The event ID associated with the action.

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
    • \n
  • \n

    \n event.description - A description of the event.

    \n
    • \n
  • \n

    \n event.event-id - The event ID.

    \n
    • \n
  • \n

    \n event.event-type - The event type (for io-enabled:\n passed | failed; for io-performance:\n io-performance:degraded | io-performance:severely-degraded |\n io-performance:stalled).

    \n
    • \n
  • \n

    \n event.not-after - The latest end time for the event.

    \n
    • \n
  • \n

    \n event.not-before - The earliest start time for the event.

    \n
    • \n
  • \n

    \n volume-status.details-name - The cause for\n volume-status.status (io-enabled |\n io-performance).

    \n
    • \n
  • \n

    \n volume-status.details-status - The status of\n volume-status.details-name (for io-enabled:\n passed | failed; for io-performance:\n normal | degraded | severely-degraded |\n stalled).

    \n
    • \n
  • \n

    \n volume-status.status - The status of the volume (ok |\n impaired | warning | insufficient-data).

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "MaxResults": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -40977,6 +41376,13 @@ "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.

", "smithy.api#xmlName": "dryRun" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n action.code - The action code for the event (for example,\n enable-volume-io).

    \n
    • \n
  • \n

    \n action.description - A description of the action.

    \n
    • \n
  • \n

    \n action.event-id - The event ID associated with the action.

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone of the instance.

    \n
    • \n
  • \n

    \n event.description - A description of the event.

    \n
    • \n
  • \n

    \n event.event-id - The event ID.

    \n
    • \n
  • \n

    \n event.event-type - The event type (for io-enabled:\n passed | failed; for io-performance:\n io-performance:degraded | io-performance:severely-degraded |\n io-performance:stalled).

    \n
    • \n
  • \n

    \n event.not-after - The latest end time for the event.

    \n
    • \n
  • \n

    \n event.not-before - The earliest start time for the event.

    \n
    • \n
  • \n

    \n volume-status.details-name - The cause for\n volume-status.status (io-enabled |\n io-performance).

    \n
    • \n
  • \n

    \n volume-status.details-status - The status of\n volume-status.details-name (for io-enabled:\n passed | failed; for io-performance:\n normal | degraded | severely-degraded |\n stalled).

    \n
    • \n
  • \n

    \n volume-status.status - The status of the volume (ok |\n impaired | warning | insufficient-data).

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -41235,14 +41641,6 @@ "com.amazonaws.ec2#DescribeVolumesModificationsResult": { "type": "structure", "members": { - "VolumesModifications": { - "target": "com.amazonaws.ec2#VolumeModificationList", - "traits": { - "aws.protocols#ec2QueryName": "VolumeModificationSet", - "smithy.api#documentation": "

Information about the volume modifications.

", - "smithy.api#xmlName": "volumeModificationSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -41250,6 +41648,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "VolumesModifications": { + "target": "com.amazonaws.ec2#VolumeModificationList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeModificationSet", + "smithy.api#documentation": "

Information about the volume modifications.

", + "smithy.api#xmlName": "volumeModificationSet" + } } }, "traits": { @@ -41259,13 +41665,6 @@ "com.amazonaws.ec2#DescribeVolumesRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n attachment.attach-time - The time stamp when the attachment\n initiated.

    \n
    • \n
  • \n

    \n attachment.delete-on-termination - Whether the volume is deleted on\n instance termination.

    \n
    • \n
  • \n

    \n attachment.device - The device name specified in the block device mapping\n (for example, /dev/sda1).

    \n
    • \n
  • \n

    \n attachment.instance-id - The ID of the instance the volume is attached\n to.

    \n
    • \n
  • \n

    \n attachment.status - The attachment state (attaching |\n attached | detaching).

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone in which the volume was\n created.

    \n
    • \n
  • \n

    \n create-time - The time stamp when the volume was created.

    \n
    • \n
  • \n

    \n encrypted - Indicates whether the volume is encrypted (true\n | false)

    \n
    • \n
  • \n

    \n multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true\n \t\t\t| false)

    \n
    • \n
  • \n

    \n fast-restored - Indicates whether the volume was created from a \n snapshot that is enabled for fast snapshot restore (true | \n false).

    \n
    • \n
  • \n

    \n size - The size of the volume, in GiB.

    \n
    • \n
  • \n

    \n snapshot-id - The snapshot from which the volume was created.

    \n
    • \n
  • \n

    \n status - The state of the volume (creating |\n available | in-use | deleting |\n deleted | error).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n volume-id - The volume ID.

    \n
    • \n
  • \n

    \n volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | \n st1 | sc1| standard)

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "VolumeIds": { "target": "com.amazonaws.ec2#VolumeIdStringList", "traits": { @@ -41281,12 +41680,11 @@ "smithy.api#xmlName": "dryRun" } }, - "MaxResults": { - "target": "com.amazonaws.ec2#Integer", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "aws.protocols#ec2QueryName": "MaxResults", - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

", - "smithy.api#xmlName": "maxResults" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n attachment.attach-time - The time stamp when the attachment\n initiated.

    \n
    • \n
  • \n

    \n attachment.delete-on-termination - Whether the volume is deleted on\n instance termination.

    \n
    • \n
  • \n

    \n attachment.device - The device name specified in the block device mapping\n (for example, /dev/sda1).

    \n
    • \n
  • \n

    \n attachment.instance-id - The ID of the instance the volume is attached\n to.

    \n
    • \n
  • \n

    \n attachment.status - The attachment state (attaching |\n attached | detaching).

    \n
    • \n
  • \n

    \n availability-zone - The Availability Zone in which the volume was\n created.

    \n
    • \n
  • \n

    \n create-time - The time stamp when the volume was created.

    \n
    • \n
  • \n

    \n encrypted - Indicates whether the volume is encrypted (true\n | false)

    \n
    • \n
  • \n

    \n multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true\n \t\t\t| false)

    \n
    • \n
  • \n

    \n fast-restored - Indicates whether the volume was created from a \n snapshot that is enabled for fast snapshot restore (true | \n false).

    \n
    • \n
  • \n

    \n size - The size of the volume, in GiB.

    \n
    • \n
  • \n

    \n snapshot-id - The snapshot from which the volume was created.

    \n
    • \n
  • \n

    \n status - The state of the volume (creating |\n available | in-use | deleting |\n deleted | error).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n volume-id - The volume ID.

    \n
    • \n
  • \n

    \n volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | \n st1 | sc1| standard)

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } }, "NextToken": { @@ -41296,6 +41694,14 @@ "smithy.api#documentation": "

The token returned from a previous paginated request.\n Pagination continues from the end of the items returned by the previous request.

", "smithy.api#xmlName": "nextToken" } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "MaxResults", + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output. \n\tFor more information, see Pagination.

", + "smithy.api#xmlName": "maxResults" + } } }, "traits": { @@ -41305,14 +41711,6 @@ "com.amazonaws.ec2#DescribeVolumesResult": { "type": "structure", "members": { - "Volumes": { - "target": "com.amazonaws.ec2#VolumeList", - "traits": { - "aws.protocols#ec2QueryName": "VolumeSet", - "smithy.api#documentation": "

Information about the volumes.

", - "smithy.api#xmlName": "volumeSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -41320,6 +41718,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. \n This value is null when there are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "Volumes": { + "target": "com.amazonaws.ec2#VolumeList", + "traits": { + "aws.protocols#ec2QueryName": "VolumeSet", + "smithy.api#documentation": "

Information about the volumes.

", + "smithy.api#xmlName": "volumeSet" + } } }, "traits": { @@ -41403,14 +41809,6 @@ "com.amazonaws.ec2#DescribeVpcAttributeResult": { "type": "structure", "members": { - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, "EnableDnsHostnames": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { @@ -41434,6 +41832,14 @@ "smithy.api#documentation": "

Indicates whether Network Address Usage metrics are enabled for your VPC.

", "smithy.api#xmlName": "enableNetworkAddressUsageMetrics" } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } } }, "traits": { @@ -41491,6 +41897,13 @@ "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportRequest": { "type": "structure", "members": { + "VpcIds": { + "target": "com.amazonaws.ec2#VpcClassicLinkIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the VPCs.

", + "smithy.api#xmlName": "VpcIds" + } + }, "MaxResults": { "target": "com.amazonaws.ec2#DescribeVpcClassicLinkDnsSupportMaxResults", "traits": { @@ -41506,13 +41919,6 @@ "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

", "smithy.api#xmlName": "nextToken" } - }, - "VpcIds": { - "target": "com.amazonaws.ec2#VpcClassicLinkIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the VPCs.

", - "smithy.api#xmlName": "VpcIds" - } } }, "traits": { @@ -41546,13 +41952,6 @@ "com.amazonaws.ec2#DescribeVpcClassicLinkRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", - "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n is-classic-link-enabled - Whether the VPC is enabled for ClassicLink\n\t\t\t\t\t (true | false).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -41567,6 +41966,13 @@ "smithy.api#documentation": "

The VPCs for which you want to describe the ClassicLink status.

", "smithy.api#xmlName": "VpcId" } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n is-classic-link-enabled - Whether the VPC is enabled for ClassicLink\n\t\t\t\t\t (true | false).

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" + } } }, "traits": { @@ -42149,11 +42555,16 @@ "com.amazonaws.ec2#DescribeVpcPeeringConnectionsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.ec2#FilterList", + "NextToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter\n VPC.

    \n
    • \n
  • \n

    \n accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the\n accepter VPC.

    \n
    • \n
  • \n

    \n accepter-vpc-info.vpc-id - The ID of the accepter VPC.

    \n
    • \n
  • \n

    \n expiration-time - The expiration date and time for the VPC peering\n connection.

    \n
    • \n
  • \n

    \n requester-vpc-info.cidr-block - The IPv4 CIDR block of the\n requester's VPC.

    \n
    • \n
  • \n

    \n requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the\n requester VPC.

    \n
    • \n
  • \n

    \n requester-vpc-info.vpc-id - The ID of the requester VPC.

    \n
    • \n
  • \n

    \n status-code - The status of the VPC peering connection\n (pending-acceptance | failed |\n expired | provisioning | active |\n deleting | deleted |\n rejected).

    \n
    • \n
  • \n

    \n status-message - A message that provides more information about the status\n of the VPC peering connection, if applicable.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-peering-connection-id - The ID of the VPC peering connection.

    \n
    • \n
", - "smithy.api#xmlName": "Filter" + "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" } }, "DryRun": { @@ -42171,16 +42582,11 @@ "smithy.api#xmlName": "VpcPeeringConnectionId" } }, - "NextToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "smithy.api#documentation": "

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.ec2#DescribeVpcPeeringConnectionsMaxResults", + "Filters": { + "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" + "smithy.api#documentation": "

The filters.

\n
    \n
  • \n

    \n accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter\n VPC.

    \n
    • \n
  • \n

    \n accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the\n accepter VPC.

    \n
    • \n
  • \n

    \n accepter-vpc-info.vpc-id - The ID of the accepter VPC.

    \n
    • \n
  • \n

    \n expiration-time - The expiration date and time for the VPC peering\n connection.

    \n
    • \n
  • \n

    \n requester-vpc-info.cidr-block - The IPv4 CIDR block of the\n requester's VPC.

    \n
    • \n
  • \n

    \n requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the\n requester VPC.

    \n
    • \n
  • \n

    \n requester-vpc-info.vpc-id - The ID of the requester VPC.

    \n
    • \n
  • \n

    \n status-code - The status of the VPC peering connection\n (pending-acceptance | failed |\n expired | provisioning | active |\n deleting | deleted |\n rejected).

    \n
    • \n
  • \n

    \n status-message - A message that provides more information about the status\n of the VPC peering connection, if applicable.

    \n
    • \n
  • \n

    \n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    \n
    • \n
  • \n

    \n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    \n
    • \n
  • \n

    \n vpc-peering-connection-id - The ID of the VPC peering connection.

    \n
    • \n
", + "smithy.api#xmlName": "Filter" } } }, @@ -42322,14 +42728,6 @@ "smithy.api#xmlName": "VpcId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -42341,6 +42739,14 @@ "traits": { "smithy.api#documentation": "

The maximum number of items to return for this request.\n\tTo get the next page of items, make another request with the token returned in the output.\n\tFor more information, see Pagination.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } } }, "traits": { @@ -42350,14 +42756,6 @@ "com.amazonaws.ec2#DescribeVpcsResult": { "type": "structure", "members": { - "Vpcs": { - "target": "com.amazonaws.ec2#VpcList", - "traits": { - "aws.protocols#ec2QueryName": "VpcSet", - "smithy.api#documentation": "

Information about the VPCs.

", - "smithy.api#xmlName": "vpcSet" - } - }, "NextToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -42365,6 +42763,14 @@ "smithy.api#documentation": "

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

", "smithy.api#xmlName": "nextToken" } + }, + "Vpcs": { + "target": "com.amazonaws.ec2#VpcList", + "traits": { + "aws.protocols#ec2QueryName": "VpcSet", + "smithy.api#documentation": "

Information about the VPCs.

", + "smithy.api#xmlName": "vpcSet" + } } }, "traits": { @@ -42774,6 +43180,14 @@ "com.amazonaws.ec2#DetachNetworkInterfaceRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } + }, "AttachmentId": { "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentId", "traits": { @@ -42784,14 +43198,6 @@ "smithy.api#xmlName": "attachmentId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "Force": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -43103,22 +43509,6 @@ "com.amazonaws.ec2#DhcpOptions": { "type": "structure", "members": { - "DhcpConfigurations": { - "target": "com.amazonaws.ec2#DhcpConfigurationList", - "traits": { - "aws.protocols#ec2QueryName": "DhcpConfigurationSet", - "smithy.api#documentation": "

The DHCP options in the set.

", - "smithy.api#xmlName": "dhcpConfigurationSet" - } - }, - "DhcpOptionsId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DhcpOptionsId", - "smithy.api#documentation": "

The ID of the set of DHCP options.

", - "smithy.api#xmlName": "dhcpOptionsId" - } - }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -43134,6 +43524,22 @@ "smithy.api#documentation": "

Any tags assigned to the DHCP options set.

", "smithy.api#xmlName": "tagSet" } + }, + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsId", + "smithy.api#documentation": "

The ID of the set of DHCP options.

", + "smithy.api#xmlName": "dhcpOptionsId" + } + }, + "DhcpConfigurations": { + "target": "com.amazonaws.ec2#DhcpConfigurationList", + "traits": { + "aws.protocols#ec2QueryName": "DhcpConfigurationSet", + "smithy.api#documentation": "

The DHCP options in the set.

", + "smithy.api#xmlName": "dhcpConfigurationSet" + } } }, "traits": { @@ -43741,7 +44147,7 @@ "target": "com.amazonaws.ec2#DisableImageResult" }, "traits": { - "smithy.api#documentation": "

Sets the AMI state to disabled and removes all launch permissions from the\n AMI. A disabled AMI can't be used for instance launches.

\n

A disabled AMI can't be shared. If an AMI was public or previously shared, it is made\n private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit,\n they lose access to the disabled AMI.

\n

A disabled AMI does not appear in DescribeImages API calls by\n default.

\n

Only the AMI owner can disable an AMI.

\n

You can re-enable a disabled AMI using EnableImage.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" + "smithy.api#documentation": "

Sets the AMI state to disabled and removes all launch permissions from the\n AMI. A disabled AMI can't be used for instance launches.

\n

A disabled AMI can't be shared. If an AMI was public or previously shared, it is made\n private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit,\n they lose access to the disabled AMI.

\n

A disabled AMI does not appear in DescribeImages API calls by\n default.

\n

Only the AMI owner can disable an AMI.

\n

You can re-enable a disabled AMI using EnableImage.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#DisableImageBlockPublicAccess": { @@ -44319,6 +44725,64 @@ "smithy.api#input": {} } }, + "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwner": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwnerRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwnerResult" + }, + "traits": { + "smithy.api#documentation": "

Cancels a pending request to assign billing of the unused capacity of a Capacity Reservation to a \n\t\t\t\tconsumer account, or revokes a request that has already been accepted. For more information, see \n\t\t\t\tBilling assignment for \n\t\t\t\t\tshared Amazon EC2 Capacity Reservations.

" + } + }, + "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwnerRequest": { + "type": "structure", + "members": { + "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, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation.

", + "smithy.api#required": {} + } + }, + "UnusedReservationBillingOwnerId": { + "target": "com.amazonaws.ec2#AccountID", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the consumer account to which the request was sent.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisassociateCapacityReservationBillingOwnerResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DisassociateClientVpnTargetNetwork": { "type": "operation", "input": { @@ -44682,7 +45146,7 @@ "target": "com.amazonaws.ec2#DisassociateNatGatewayAddressResult" }, "traits": { - "smithy.api#documentation": "

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. \n You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.

\n

While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

An EIP is released only at the end of MaxDrainDurationSeconds. It stays\n associated and supports the existing connections but does not support any new connections\n (new connections are distributed across the remaining associated EIPs). As the existing\n connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) \n are released.

" + "smithy.api#documentation": "

Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. \n You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.

\n

While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

An EIP is released only at the end of MaxDrainDurationSeconds. It stays\n associated and supports the existing connections but does not support any new connections\n (new connections are distributed across the remaining associated EIPs). As the existing\n connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) \n are released.

" } }, "com.amazonaws.ec2#DisassociateNatGatewayAddressRequest": { @@ -44770,6 +45234,14 @@ "com.amazonaws.ec2#DisassociateRouteTableRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } + }, "AssociationId": { "target": "com.amazonaws.ec2#RouteTableAssociationId", "traits": { @@ -44779,14 +45251,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "associationId" } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } } }, "traits": { @@ -45228,16 +45692,6 @@ "com.amazonaws.ec2#DiskImageDetail": { "type": "structure", "members": { - "Bytes": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Bytes", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The size of the disk image, in GiB.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "bytes" - } - }, "Format": { "target": "com.amazonaws.ec2#DiskImageFormat", "traits": { @@ -45248,6 +45702,16 @@ "smithy.api#xmlName": "format" } }, + "Bytes": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Bytes", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The size of the disk image, in GiB.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "bytes" + } + }, "ImportManifestUrl": { "target": "com.amazonaws.ec2#ImportManifestUrl", "traits": { @@ -45645,7 +46109,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under\n which the EBS volume is encrypted.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", + "smithy.api#documentation": "

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key \n to use for EBS encryption.

\n

This parameter is only supported on BlockDeviceMapping objects called by\n RunInstances, RequestSpotFleet,\n and RequestSpotInstances.

", "smithy.api#xmlName": "kmsKeyId" } }, @@ -45794,14 +46258,6 @@ "com.amazonaws.ec2#EbsInstanceBlockDeviceSpecification": { "type": "structure", "members": { - "DeleteOnTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DeleteOnTermination", - "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", - "smithy.api#xmlName": "deleteOnTermination" - } - }, "VolumeId": { "target": "com.amazonaws.ec2#VolumeId", "traits": { @@ -45809,6 +46265,14 @@ "smithy.api#documentation": "

The ID of the EBS volume.

", "smithy.api#xmlName": "volumeId" } + }, + "DeleteOnTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DeleteOnTermination", + "smithy.api#documentation": "

Indicates whether the volume is deleted on instance termination.

", + "smithy.api#xmlName": "deleteOnTermination" + } } }, "traits": { @@ -46312,7 +46776,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.

\n \n

Describes the association between an instance and an Elastic Graphics accelerator.

" + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes the association between an instance and an Elastic Graphics accelerator.

" } }, "com.amazonaws.ec2#ElasticGpuAssociationList": { @@ -46337,7 +46801,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.

\n \n

Describes the status of an Elastic Graphics accelerator.

" + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes the status of an Elastic Graphics accelerator.

" } }, "com.amazonaws.ec2#ElasticGpuId": { @@ -46374,7 +46838,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.

\n \n

A specification for an Elastic Graphics accelerator.

" + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

A specification for an Elastic Graphics accelerator.

" } }, "com.amazonaws.ec2#ElasticGpuSpecificationList": { @@ -46393,13 +46857,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n ", + "smithy.api#documentation": "

The elastic GPU type.

", "smithy.api#xmlName": "type" } } }, "traits": { - "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n " + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes an elastic GPU.

" } }, "com.amazonaws.ec2#ElasticGpuSpecificationResponseList": { @@ -46509,7 +46973,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, \n we recommend that you use Amazon EC2 G4, G5, or G6 instances.

\n \n

Describes an Elastic Graphics accelerator.

" + "smithy.api#documentation": "\n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n \n

Describes an Elastic Graphics accelerator.

" } }, "com.amazonaws.ec2#ElasticInferenceAccelerator": { @@ -46531,7 +46995,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Describes an elastic inference accelerator. \n

" + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Describes an elastic inference accelerator. \n

" } }, "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociation": { @@ -46571,7 +47035,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n Describes the association between an instance and an elastic inference accelerator. \n

" + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Describes the association between an instance and an elastic inference accelerator. \n

" } }, "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList": { @@ -49191,14 +49655,6 @@ "com.amazonaws.ec2#ExportToS3TaskSpecification": { "type": "structure", "members": { - "ContainerFormat": { - "target": "com.amazonaws.ec2#ContainerFormat", - "traits": { - "aws.protocols#ec2QueryName": "ContainerFormat", - "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", - "smithy.api#xmlName": "containerFormat" - } - }, "DiskImageFormat": { "target": "com.amazonaws.ec2#DiskImageFormat", "traits": { @@ -49207,6 +49663,14 @@ "smithy.api#xmlName": "diskImageFormat" } }, + "ContainerFormat": { + "target": "com.amazonaws.ec2#ContainerFormat", + "traits": { + "aws.protocols#ec2QueryName": "ContainerFormat", + "smithy.api#documentation": "

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is\n exported.

", + "smithy.api#xmlName": "containerFormat" + } + }, "S3Bucket": { "target": "com.amazonaws.ec2#String", "traits": { @@ -51796,18 +52260,18 @@ "smithy.api#required": {} } }, - "DryRun": { + "Latest": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" + "smithy.api#documentation": "

When enabled, retrieves the latest console output for the instance.

\n

Default: disabled (false)

" } }, - "Latest": { + "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

When enabled, retrieves the latest console output for the instance.

\n

Default: disabled (false)

" + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" } } }, @@ -51826,14 +52290,6 @@ "smithy.api#xmlName": "instanceId" } }, - "Output": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Output", - "smithy.api#documentation": "

The console output, base64-encoded. If you are using a command line tool, the tool\n decodes the output for you.

", - "smithy.api#xmlName": "output" - } - }, "Timestamp": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -51841,6 +52297,14 @@ "smithy.api#documentation": "

The time at which the output was last updated.

", "smithy.api#xmlName": "timestamp" } + }, + "Output": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Output", + "smithy.api#documentation": "

The console output, base64-encoded. If you are using a command line tool, the tool\n decodes the output for you.

", + "smithy.api#xmlName": "output" + } } }, "traits": { @@ -51865,7 +52329,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "InstanceId": { @@ -51929,7 +52393,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "InstanceFamily": { @@ -52341,7 +52805,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } } }, @@ -52465,7 +52929,7 @@ "target": "com.amazonaws.ec2#GetInstanceTypesFromInstanceRequirementsResult" }, "traits": { - "smithy.api#documentation": "

Returns a list of instance types with the specified instance attributes. You can\n use the response to preview the instance types without launching instances. Note\n that the response does not consider capacity.

\n

When you specify multiple parameters, you get instance types that satisfy all of the\n specified parameters. If you specify multiple values for a parameter, you get instance\n types that satisfy any of the specified values.

\n

For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide, and Creating an\n Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

", + "smithy.api#documentation": "

Returns a list of instance types with the specified instance attributes. You can\n use the response to preview the instance types without launching instances. Note\n that the response does not consider capacity.

\n

When you specify multiple parameters, you get instance types that satisfy all of the\n specified parameters. If you specify multiple values for a parameter, you get instance\n types that satisfy any of the specified values.

\n

For more information, see Preview instance types with specified attributes, Specify attributes for instance type selection for EC2 Fleet or Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide, and Creating\n mixed instance groups using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -52577,7 +53041,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } } }, @@ -53751,7 +54215,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } } @@ -53771,14 +54235,6 @@ "smithy.api#xmlName": "instanceId" } }, - "PasswordData": { - "target": "com.amazonaws.ec2#PasswordData", - "traits": { - "aws.protocols#ec2QueryName": "PasswordData", - "smithy.api#documentation": "

The password of the instance. Returns an empty string if the password is not\n available.

", - "smithy.api#xmlName": "passwordData" - } - }, "Timestamp": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -53786,6 +54242,14 @@ "smithy.api#documentation": "

The time the data was last updated.

", "smithy.api#xmlName": "timestamp" } + }, + "PasswordData": { + "target": "com.amazonaws.ec2#PasswordData", + "traits": { + "aws.protocols#ec2QueryName": "PasswordData", + "smithy.api#documentation": "

The password of the instance. Returns an empty string if the password is not\n available.

", + "smithy.api#xmlName": "passwordData" + } } }, "traits": { @@ -55320,14 +55784,6 @@ "com.amazonaws.ec2#GroupIdentifier": { "type": "structure", "members": { - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - }, "GroupId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -55335,6 +55791,14 @@ "smithy.api#documentation": "

The ID of the security group.

", "smithy.api#xmlName": "groupId" } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } } }, "traits": { @@ -56359,78 +56823,6 @@ "com.amazonaws.ec2#Image": { "type": "structure", "members": { - "Architecture": { - "target": "com.amazonaws.ec2#ArchitectureValues", - "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the image.

", - "smithy.api#xmlName": "architecture" - } - }, - "CreationDate": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CreationDate", - "smithy.api#documentation": "

The date and time the image was created.

", - "smithy.api#xmlName": "creationDate" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI.

", - "smithy.api#xmlName": "imageId" - } - }, - "ImageLocation": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageLocation", - "smithy.api#documentation": "

The location of the AMI.

", - "smithy.api#xmlName": "imageLocation" - } - }, - "ImageType": { - "target": "com.amazonaws.ec2#ImageTypeValues", - "traits": { - "aws.protocols#ec2QueryName": "ImageType", - "smithy.api#documentation": "

The type of image.

", - "smithy.api#xmlName": "imageType" - } - }, - "Public": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "IsPublic", - "smithy.api#documentation": "

Indicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.

", - "smithy.api#xmlName": "isPublic" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The kernel associated with the image, if any. Only applicable for machine images.

", - "smithy.api#xmlName": "kernelId" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageOwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the image.

", - "smithy.api#xmlName": "imageOwnerId" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

This value is set to windows for Windows AMIs; otherwise, it is blank.

", - "smithy.api#xmlName": "platform" - } - }, "PlatformDetails": { "target": "com.amazonaws.ec2#String", "traits": { @@ -56447,30 +56839,6 @@ "smithy.api#xmlName": "usageOperation" } }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

Any product codes associated with the AMI.

", - "smithy.api#xmlName": "productCodes" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The RAM disk associated with the image, if any. Only applicable for machine images.

", - "smithy.api#xmlName": "ramdiskId" - } - }, - "State": { - "target": "com.amazonaws.ec2#ImageState", - "traits": { - "aws.protocols#ec2QueryName": "ImageState", - "smithy.api#documentation": "

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", - "smithy.api#xmlName": "imageState" - } - }, "BlockDeviceMappings": { "target": "com.amazonaws.ec2#BlockDeviceMappingList", "traits": { @@ -56622,22 +56990,6 @@ "smithy.api#documentation": "

The date and time, in ISO 8601 date-time\n format, when the AMI was last used to launch an EC2 instance. When the AMI is used\n to launch an instance, there is a 24-hour delay before that usage is reported.

\n \n

\n lastLaunchedTime data is available starting April 2017.

\n ", "smithy.api#xmlName": "lastLaunchedTime" } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an image.

" - } - }, - "com.amazonaws.ec2#ImageAttribute": { - "type": "structure", - "members": { - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

The block device mapping entries.

", - "smithy.api#xmlName": "blockDeviceMapping" - } }, "ImageId": { "target": "com.amazonaws.ec2#String", @@ -56647,22 +56999,102 @@ "smithy.api#xmlName": "imageId" } }, - "LaunchPermissions": { - "target": "com.amazonaws.ec2#LaunchPermissionList", + "ImageLocation": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LaunchPermission", - "smithy.api#documentation": "

The launch permissions.

", - "smithy.api#xmlName": "launchPermission" + "aws.protocols#ec2QueryName": "ImageLocation", + "smithy.api#documentation": "

The location of the AMI.

", + "smithy.api#xmlName": "imageLocation" + } + }, + "State": { + "target": "com.amazonaws.ec2#ImageState", + "traits": { + "aws.protocols#ec2QueryName": "ImageState", + "smithy.api#documentation": "

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "smithy.api#xmlName": "imageState" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageOwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the image.

", + "smithy.api#xmlName": "imageOwnerId" + } + }, + "CreationDate": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CreationDate", + "smithy.api#documentation": "

The date and time the image was created.

", + "smithy.api#xmlName": "creationDate" + } + }, + "Public": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IsPublic", + "smithy.api#documentation": "

Indicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.

", + "smithy.api#xmlName": "isPublic" } }, "ProductCodes": { "target": "com.amazonaws.ec2#ProductCodeList", "traits": { "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes.

", + "smithy.api#documentation": "

Any product codes associated with the AMI.

", "smithy.api#xmlName": "productCodes" } }, + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the image.

", + "smithy.api#xmlName": "architecture" + } + }, + "ImageType": { + "target": "com.amazonaws.ec2#ImageTypeValues", + "traits": { + "aws.protocols#ec2QueryName": "ImageType", + "smithy.api#documentation": "

The type of image.

", + "smithy.api#xmlName": "imageType" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The kernel associated with the image, if any. Only applicable for machine images.

", + "smithy.api#xmlName": "kernelId" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

This value is set to windows for Windows AMIs; otherwise, it is blank.

", + "smithy.api#xmlName": "platform" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an image.

" + } + }, + "com.amazonaws.ec2#ImageAttribute": { + "type": "structure", + "members": { "Description": { "target": "com.amazonaws.ec2#AttributeValue", "traits": { @@ -56742,6 +57174,38 @@ "smithy.api#documentation": "

Indicates whether deregistration protection is enabled for the AMI.

", "smithy.api#xmlName": "deregistrationProtection" } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#xmlName": "imageId" + } + }, + "LaunchPermissions": { + "target": "com.amazonaws.ec2#LaunchPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "LaunchPermission", + "smithy.api#documentation": "

The launch permissions.

", + "smithy.api#xmlName": "launchPermission" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes.

", + "smithy.api#xmlName": "productCodes" + } + }, + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingList", + "traits": { + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

The block device mapping entries.

", + "smithy.api#xmlName": "blockDeviceMapping" + } } }, "traits": { @@ -57611,14 +58075,6 @@ "com.amazonaws.ec2#ImportInstanceLaunchSpecification": { "type": "structure", "members": { - "AdditionalInfo": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalInfo", - "smithy.api#documentation": "

Reserved.

", - "smithy.api#xmlName": "additionalInfo" - } - }, "Architecture": { "target": "com.amazonaws.ec2#ArchitectureValues", "traits": { @@ -57627,6 +58083,13 @@ "smithy.api#xmlName": "architecture" } }, + "GroupNames": { + "target": "com.amazonaws.ec2#SecurityGroupStringList", + "traits": { + "smithy.api#documentation": "

The security group names.

", + "smithy.api#xmlName": "GroupName" + } + }, "GroupIds": { "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { @@ -57634,19 +58097,20 @@ "smithy.api#xmlName": "GroupId" } }, - "GroupNames": { - "target": "com.amazonaws.ec2#SecurityGroupStringList", + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The security group names.

", - "smithy.api#xmlName": "GroupName" + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" } }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", + "UserData": { + "target": "com.amazonaws.ec2#UserData", "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the\n operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + "aws.protocols#ec2QueryName": "UserData", + "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance.

", + "smithy.api#xmlName": "userData" } }, "InstanceType": { @@ -57657,14 +58121,6 @@ "smithy.api#xmlName": "instanceType" } }, - "Monitoring": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

Indicates whether monitoring is enabled.

", - "smithy.api#xmlName": "monitoring" - } - }, "Placement": { "target": "com.amazonaws.ec2#Placement", "traits": { @@ -57673,12 +58129,12 @@ "smithy.api#xmlName": "placement" } }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", + "Monitoring": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

[EC2-VPC] An available IP address from the IP address range of the subnet.

", - "smithy.api#xmlName": "privateIpAddress" + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

Indicates whether monitoring is enabled.

", + "smithy.api#xmlName": "monitoring" } }, "SubnetId": { @@ -57689,12 +58145,20 @@ "smithy.api#xmlName": "subnetId" } }, - "UserData": { - "target": "com.amazonaws.ec2#UserData", + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", "traits": { - "aws.protocols#ec2QueryName": "UserData", - "smithy.api#documentation": "

The Base64-encoded user data to make available to the instance.

", - "smithy.api#xmlName": "userData" + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the\n operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

[EC2-VPC] An available IP address from the IP address range of the subnet.

", + "smithy.api#xmlName": "privateIpAddress" } } }, @@ -57705,22 +58169,6 @@ "com.amazonaws.ec2#ImportInstanceRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the instance being imported.

", - "smithy.api#xmlName": "description" - } - }, - "DiskImages": { - "target": "com.amazonaws.ec2#DiskImageList", - "traits": { - "aws.protocols#ec2QueryName": "DiskImage", - "smithy.api#documentation": "

The disk image.

", - "smithy.api#xmlName": "diskImage" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -57729,6 +58177,14 @@ "smithy.api#xmlName": "dryRun" } }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the instance being imported.

", + "smithy.api#xmlName": "description" + } + }, "LaunchSpecification": { "target": "com.amazonaws.ec2#ImportInstanceLaunchSpecification", "traits": { @@ -57737,6 +58193,14 @@ "smithy.api#xmlName": "launchSpecification" } }, + "DiskImages": { + "target": "com.amazonaws.ec2#DiskImageList", + "traits": { + "aws.protocols#ec2QueryName": "DiskImage", + "smithy.api#documentation": "

The disk image.

", + "smithy.api#xmlName": "diskImage" + } + }, "Platform": { "target": "com.amazonaws.ec2#PlatformValues", "traits": { @@ -57896,6 +58360,13 @@ "com.amazonaws.ec2#ImportKeyPairRequest": { "type": "structure", "members": { + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "

The tags to apply to the imported key pair.

", + "smithy.api#xmlName": "TagSpecification" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -57923,13 +58394,6 @@ "smithy.api#required": {}, "smithy.api#xmlName": "publicKeyMaterial" } - }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", - "traits": { - "smithy.api#documentation": "

The tags to apply to the imported key pair.

", - "smithy.api#xmlName": "TagSpecification" - } } }, "traits": { @@ -58185,6 +58649,14 @@ "com.amazonaws.ec2#ImportVolumeRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } + }, "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { @@ -58195,22 +58667,6 @@ "smithy.api#xmlName": "availabilityZone" } }, - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description of the volume.

", - "smithy.api#xmlName": "description" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "Image": { "target": "com.amazonaws.ec2#DiskImageDetail", "traits": { @@ -58221,6 +58677,14 @@ "smithy.api#xmlName": "image" } }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description of the volume.

", + "smithy.api#xmlName": "description" + } + }, "Volume": { "target": "com.amazonaws.ec2#VolumeDetail", "traits": { @@ -58321,7 +58785,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

" + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes the Inference accelerators for the instance type.

" } }, "com.amazonaws.ec2#InferenceDeviceCount": { @@ -58364,7 +58828,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the Inference accelerators for the instance type.

" + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes the Inference accelerators for the instance type.

" } }, "com.amazonaws.ec2#InferenceDeviceInfoList": { @@ -58389,7 +58853,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the memory available to the inference accelerator.

" + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes the memory available to the inference accelerator.

" } }, "com.amazonaws.ec2#InferenceDeviceMemorySize": { @@ -58410,166 +58874,6 @@ "com.amazonaws.ec2#Instance": { "type": "structure", "members": { - "AmiLaunchIndex": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AmiLaunchIndex", - "smithy.api#documentation": "

The AMI launch index, which can be used to find this instance in the launch\n group.

", - "smithy.api#xmlName": "amiLaunchIndex" - } - }, - "ImageId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "

The ID of the AMI used to launch the instance.

", - "smithy.api#xmlName": "imageId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#xmlName": "instanceId" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type.

", - "smithy.api#xmlName": "instanceType" - } - }, - "KernelId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The kernel associated with this instance, if applicable.

", - "smithy.api#xmlName": "kernelId" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair, if this instance was launched with an associated key\n pair.

", - "smithy.api#xmlName": "keyName" - } - }, - "LaunchTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "LaunchTime", - "smithy.api#documentation": "

The time the instance was launched.

", - "smithy.api#xmlName": "launchTime" - } - }, - "Monitoring": { - "target": "com.amazonaws.ec2#Monitoring", - "traits": { - "aws.protocols#ec2QueryName": "Monitoring", - "smithy.api#documentation": "

The monitoring for the instance.

", - "smithy.api#xmlName": "monitoring" - } - }, - "Placement": { - "target": "com.amazonaws.ec2#Placement", - "traits": { - "aws.protocols#ec2QueryName": "Placement", - "smithy.api#documentation": "

The location where the instance launched, if applicable.

", - "smithy.api#xmlName": "placement" - } - }, - "Platform": { - "target": "com.amazonaws.ec2#PlatformValues", - "traits": { - "aws.protocols#ec2QueryName": "Platform", - "smithy.api#documentation": "

The platform. This value is windows for Windows instances; otherwise, it is empty.

", - "smithy.api#xmlName": "platform" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", - "smithy.api#xmlName": "privateDnsName" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The private IPv4 address assigned to the instance.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, - "ProductCodes": { - "target": "com.amazonaws.ec2#ProductCodeList", - "traits": { - "aws.protocols#ec2QueryName": "ProductCodes", - "smithy.api#documentation": "

The product codes attached to this instance, if applicable.

", - "smithy.api#xmlName": "productCodes" - } - }, - "PublicDnsName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DnsName", - "smithy.api#documentation": "

[IPv4 only] The public DNS name assigned to the instance. This name is not available\n until the instance enters the running state. This name is only\n available if you've enabled DNS hostnames for your VPC.

", - "smithy.api#xmlName": "dnsName" - } - }, - "PublicIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpAddress", - "smithy.api#documentation": "

The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.

\n

A Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.

", - "smithy.api#xmlName": "ipAddress" - } - }, - "RamdiskId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "RamdiskId", - "smithy.api#documentation": "

The RAM disk associated with this instance, if applicable.

", - "smithy.api#xmlName": "ramdiskId" - } - }, - "State": { - "target": "com.amazonaws.ec2#InstanceState", - "traits": { - "aws.protocols#ec2QueryName": "InstanceState", - "smithy.api#documentation": "

The current state of the instance.

", - "smithy.api#xmlName": "instanceState" - } - }, - "StateTransitionReason": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Reason", - "smithy.api#documentation": "

The reason for the most recent state transition. This might be an empty string.

", - "smithy.api#xmlName": "reason" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet in which the instance is running.

", - "smithy.api#xmlName": "subnetId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC in which the instance is running.

", - "smithy.api#xmlName": "vpcId" - } - }, "Architecture": { "target": "com.amazonaws.ec2#ArchitectureValues", "traits": { @@ -58638,7 +58942,7 @@ "target": "com.amazonaws.ec2#ElasticGpuAssociationList", "traits": { "aws.protocols#ec2QueryName": "ElasticGpuAssociationSet", - "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n ", + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n ", "smithy.api#xmlName": "elasticGpuAssociationSet" } }, @@ -58646,7 +58950,7 @@ "target": "com.amazonaws.ec2#ElasticInferenceAcceleratorAssociationList", "traits": { "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorAssociationSet", - "smithy.api#documentation": "

The elastic inference accelerator associated with the instance.

", + "smithy.api#documentation": "

Deprecated

\n \n

Amazon Elastic Inference is no longer available.

\n ", "smithy.api#xmlName": "elasticInferenceAcceleratorAssociationSet" } }, @@ -58865,6 +59169,166 @@ "smithy.api#documentation": "

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the\n Amazon EC2 User Guide.

", "smithy.api#xmlName": "currentInstanceBootMode" } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#xmlName": "instanceId" + } + }, + "ImageId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ImageId", + "smithy.api#documentation": "

The ID of the AMI used to launch the instance.

", + "smithy.api#xmlName": "imageId" + } + }, + "State": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceState", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "instanceState" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateDnsName", + "smithy.api#documentation": "

[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname\n can only be used inside the Amazon EC2 network. This name is not available until the\n instance enters the running state.

\n

The Amazon-provided DNS server resolves Amazon-provided private DNS\n hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not\n using the Amazon-provided DNS server in your VPC, your custom domain name servers must\n resolve the hostname as appropriate.

", + "smithy.api#xmlName": "privateDnsName" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "

[IPv4 only] The public DNS name assigned to the instance. This name is not available\n until the instance enters the running state. This name is only\n available if you've enabled DNS hostnames for your VPC.

", + "smithy.api#xmlName": "dnsName" + } + }, + "StateTransitionReason": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Reason", + "smithy.api#documentation": "

The reason for the most recent state transition. This might be an empty string.

", + "smithy.api#xmlName": "reason" + } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair, if this instance was launched with an associated key\n pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "AmiLaunchIndex": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AmiLaunchIndex", + "smithy.api#documentation": "

The AMI launch index, which can be used to find this instance in the launch\n group.

", + "smithy.api#xmlName": "amiLaunchIndex" + } + }, + "ProductCodes": { + "target": "com.amazonaws.ec2#ProductCodeList", + "traits": { + "aws.protocols#ec2QueryName": "ProductCodes", + "smithy.api#documentation": "

The product codes attached to this instance, if applicable.

", + "smithy.api#xmlName": "productCodes" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type.

", + "smithy.api#xmlName": "instanceType" + } + }, + "LaunchTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "LaunchTime", + "smithy.api#documentation": "

The time the instance was launched.

", + "smithy.api#xmlName": "launchTime" + } + }, + "Placement": { + "target": "com.amazonaws.ec2#Placement", + "traits": { + "aws.protocols#ec2QueryName": "Placement", + "smithy.api#documentation": "

The location where the instance launched, if applicable.

", + "smithy.api#xmlName": "placement" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The kernel associated with this instance, if applicable.

", + "smithy.api#xmlName": "kernelId" + } + }, + "RamdiskId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "RamdiskId", + "smithy.api#documentation": "

The RAM disk associated with this instance, if applicable.

", + "smithy.api#xmlName": "ramdiskId" + } + }, + "Platform": { + "target": "com.amazonaws.ec2#PlatformValues", + "traits": { + "aws.protocols#ec2QueryName": "Platform", + "smithy.api#documentation": "

The platform. This value is windows for Windows instances; otherwise, it is empty.

", + "smithy.api#xmlName": "platform" + } + }, + "Monitoring": { + "target": "com.amazonaws.ec2#Monitoring", + "traits": { + "aws.protocols#ec2QueryName": "Monitoring", + "smithy.api#documentation": "

The monitoring for the instance.

", + "smithy.api#xmlName": "monitoring" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet in which the instance is running.

", + "smithy.api#xmlName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC in which the instance is running.

", + "smithy.api#xmlName": "vpcId" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The private IPv4 address assigned to the instance.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "PublicIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpAddress", + "smithy.api#documentation": "

The public IPv4 address, or the Carrier IP address assigned to the instance, if\n applicable.

\n

A Carrier IP address only applies to an instance launched in a subnet associated with\n a Wavelength Zone.

", + "smithy.api#xmlName": "ipAddress" + } } }, "traits": { @@ -58914,14 +59378,6 @@ "com.amazonaws.ec2#InstanceAttribute": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups associated with the instance.

", - "smithy.api#xmlName": "groupSet" - } - }, "BlockDeviceMappings": { "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingList", "traits": { @@ -59049,6 +59505,14 @@ "smithy.api#documentation": "

To enable the instance for Amazon Web Services Stop Protection, set this parameter to\n true; otherwise, set it to false.

", "smithy.api#xmlName": "disableApiStop" } + }, + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups associated with the instance.

", + "smithy.api#xmlName": "groupSet" + } } }, "traits": { @@ -59225,14 +59689,6 @@ "smithy.api#xmlName": "ebs" } }, - "NoDevice": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "NoDevice", - "smithy.api#documentation": "

suppress the specified device included in the block device mapping.

", - "smithy.api#xmlName": "noDevice" - } - }, "VirtualName": { "target": "com.amazonaws.ec2#String", "traits": { @@ -59240,6 +59696,14 @@ "smithy.api#documentation": "

The virtual device name.

", "smithy.api#xmlName": "virtualName" } + }, + "NoDevice": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NoDevice", + "smithy.api#documentation": "

suppress the specified device included in the block device mapping.

", + "smithy.api#xmlName": "noDevice" + } } }, "traits": { @@ -60998,7 +61462,7 @@ "target": "com.amazonaws.ec2#AcceleratorTypeSet", "traits": { "aws.protocols#ec2QueryName": "AcceleratorTypeSet", - "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n
    \n
  • \n

    For instance types with GPU accelerators, specify gpu.

    \n
    • \n
  • \n

    For instance types with FPGA accelerators, specify fpga.

    \n
    • \n
  • \n

    For instance types with inference accelerators, specify inference.

    \n
    • \n
\n

Default: Any accelerator type

", + "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n
    \n
  • \n

    For instance types with GPU accelerators, specify gpu.

    \n
    • \n
  • \n

    For instance types with FPGA accelerators, specify fpga.

    \n
    • \n
\n

Default: Any accelerator type

", "smithy.api#xmlName": "acceleratorTypeSet" } }, @@ -61060,7 +61524,7 @@ } }, "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n
    \n
  • \n

    \n AllowedInstanceTypes - The instance types to include in the list. All \n other instance types are ignored, even if they match your specified attributes.

    \n
    • \n
  • \n

    \n ExcludedInstanceTypes - The instance types to exclude from the list, \n even if they match your specified attributes.

    \n
    • \n
\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard or with the RunInstances API, you\n can't specify InstanceRequirements.

\n \n

For more information, see Create a mixed instances group using attribute-based instance type selection in\n the Amazon EC2 Auto Scaling User Guide, and also Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n
    \n
  • \n

    \n AllowedInstanceTypes - The instance types to include in the list. All \n other instance types are ignored, even if they match your specified attributes.

    \n
    • \n
  • \n

    \n ExcludedInstanceTypes - The instance types to exclude from the list, \n even if they match your specified attributes.

    \n
    • \n
\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard or with the RunInstances API, you\n can't specify InstanceRequirements.

\n \n

For more information, see Create mixed instances group using attribute-based instance type selection in\n the Amazon EC2 Auto Scaling User Guide, and also Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot\n placement score in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#InstanceRequirementsRequest": { @@ -61173,7 +61637,7 @@ "AcceleratorTypes": { "target": "com.amazonaws.ec2#AcceleratorTypeSet", "traits": { - "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n
    \n
  • \n

    To include instance types with GPU hardware, specify gpu.

    \n
    • \n
  • \n

    To include instance types with FPGA hardware, specify fpga.

    \n
    • \n
  • \n

    To include instance types with inference hardware, specify inference.

    \n
    • \n
\n

Default: Any accelerator type

", + "smithy.api#documentation": "

The accelerator types that must be on the instance type.

\n
    \n
  • \n

    To include instance types with GPU hardware, specify gpu.

    \n
    • \n
  • \n

    To include instance types with FPGA hardware, specify fpga.

    \n
    • \n
\n

Default: Any accelerator type

", "smithy.api#xmlName": "AcceleratorType" } }, @@ -61224,7 +61688,7 @@ } }, "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n
    \n
  • \n

    \n AllowedInstanceTypes - The instance types to include in the list. All \n other instance types are ignored, even if they match your specified attributes.

    \n
    • \n
  • \n

    \n ExcludedInstanceTypes - The instance types to exclude from the list, \n even if they match your specified attributes.

    \n
    • \n
\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard, or with the RunInstances API or\n AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify\n InstanceRequirements.

\n \n

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n
    \n
  • \n

    \n AllowedInstanceTypes - The instance types to include in the list. All \n other instance types are ignored, even if they match your specified attributes.

    \n
    • \n
  • \n

    \n ExcludedInstanceTypes - The instance types to exclude from the list, \n even if they match your specified attributes.

    \n
    • \n
\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard, or with the RunInstances API or\n AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify\n InstanceRequirements.

\n \n

For more information, see Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot\n placement score in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#InstanceRequirementsWithMetadataRequest": { @@ -61320,14 +61784,6 @@ "com.amazonaws.ec2#InstanceStateChange": { "type": "structure", "members": { - "CurrentState": { - "target": "com.amazonaws.ec2#InstanceState", - "traits": { - "aws.protocols#ec2QueryName": "CurrentState", - "smithy.api#documentation": "

The current state of the instance.

", - "smithy.api#xmlName": "currentState" - } - }, "InstanceId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -61336,6 +61792,14 @@ "smithy.api#xmlName": "instanceId" } }, + "CurrentState": { + "target": "com.amazonaws.ec2#InstanceState", + "traits": { + "aws.protocols#ec2QueryName": "CurrentState", + "smithy.api#documentation": "

The current state of the instance.

", + "smithy.api#xmlName": "currentState" + } + }, "PreviousState": { "target": "com.amazonaws.ec2#InstanceState", "traits": { @@ -67340,6 +67804,14 @@ "com.amazonaws.ec2#IpPermission": { "type": "structure", "members": { + "IpProtocol": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) \n or number (see Protocol Numbers).

\n

Use -1 to specify all protocols. When authorizing\n security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify. For tcp,\n udp, and icmp, you must specify a port range. For icmpv6,\n the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

", + "smithy.api#xmlName": "ipProtocol" + } + }, "FromPort": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -67348,12 +67820,20 @@ "smithy.api#xmlName": "fromPort" } }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", + "ToPort": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

The IP protocol name (tcp, udp, icmp, icmpv6) \n or number (see Protocol Numbers).

\n

Use -1 to specify all protocols. When authorizing\n security group rules, specifying -1 or a protocol number other than\n tcp, udp, icmp, or icmpv6 allows\n traffic on all ports, regardless of any port range you specify. For tcp,\n udp, and icmp, you must specify a port range. For icmpv6,\n the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

", - "smithy.api#xmlName": "ipProtocol" + "aws.protocols#ec2QueryName": "ToPort", + "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). \n If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

", + "smithy.api#xmlName": "toPort" + } + }, + "UserIdGroupPairs": { + "target": "com.amazonaws.ec2#UserIdGroupPairList", + "traits": { + "aws.protocols#ec2QueryName": "Groups", + "smithy.api#documentation": "

The security group and Amazon Web Services account ID pairs.

", + "smithy.api#xmlName": "groups" } }, "IpRanges": { @@ -67379,22 +67859,6 @@ "smithy.api#documentation": "

The prefix list IDs.

", "smithy.api#xmlName": "prefixListIds" } - }, - "ToPort": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "ToPort", - "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). \n If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

", - "smithy.api#xmlName": "toPort" - } - }, - "UserIdGroupPairs": { - "target": "com.amazonaws.ec2#UserIdGroupPairList", - "traits": { - "aws.protocols#ec2QueryName": "Groups", - "smithy.api#documentation": "

The security group and Amazon Web Services account ID pairs.

", - "smithy.api#xmlName": "groups" - } } }, "traits": { @@ -67422,14 +67886,6 @@ "com.amazonaws.ec2#IpRange": { "type": "structure", "members": { - "CidrIp": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIp", - "smithy.api#documentation": "

The IPv4 address range. You can either specify a CIDR block or a source security group,\n not both. To specify a single IPv4 address, use the /32 prefix length.

", - "smithy.api#xmlName": "cidrIp" - } - }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -67437,6 +67893,14 @@ "smithy.api#documentation": "

A description for the security group rule that references this IPv4 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", "smithy.api#xmlName": "description" } + }, + "CidrIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

The IPv4 address range. You can either specify a CIDR block or a source security group,\n not both. To specify a single IPv4 address, use the /32 prefix length.

", + "smithy.api#xmlName": "cidrIp" + } } }, "traits": { @@ -68152,6 +68616,14 @@ "smithy.api#xmlName": "vpcId" } }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The subnet ID.

", + "smithy.api#xmlName": "subnetId" + } + }, "NetworkInterfaceAttachmentStatus": { "target": "com.amazonaws.ec2#IpamNetworkInterfaceAttachmentStatus", "traits": { @@ -70581,14 +71053,6 @@ "com.amazonaws.ec2#Ipv6Range": { "type": "structure", "members": { - "CidrIpv6": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrIpv6", - "smithy.api#documentation": "

The IPv6 address range. You can either specify a CIDR block or a source security group,\n not both. To specify a single IPv6 address, use the /128 prefix length.

", - "smithy.api#xmlName": "cidrIpv6" - } - }, "Description": { "target": "com.amazonaws.ec2#String", "traits": { @@ -70596,6 +71060,14 @@ "smithy.api#documentation": "

A description for the security group rule that references this IPv6 address range.

\n

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9,\n spaces, and ._-:/()#,@[]+=&;{}!$*

", "smithy.api#xmlName": "description" } + }, + "CidrIpv6": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrIpv6", + "smithy.api#documentation": "

The IPv6 address range. You can either specify a CIDR block or a source security group,\n not both. To specify a single IPv6 address, use the /128 prefix length.

", + "smithy.api#xmlName": "cidrIpv6" + } } }, "traits": { @@ -70660,20 +71132,20 @@ "com.amazonaws.ec2#KeyPair": { "type": "structure", "members": { - "KeyFingerprint": { + "KeyPairId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "
    \n
  • \n

    For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

    \n
    • \n
  • \n

    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

    \n
    • \n
", - "smithy.api#xmlName": "keyFingerprint" + "aws.protocols#ec2QueryName": "KeyPairId", + "smithy.api#documentation": "

The ID of the key pair.

", + "smithy.api#xmlName": "keyPairId" } }, - "KeyMaterial": { - "target": "com.amazonaws.ec2#SensitiveUserData", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "KeyMaterial", - "smithy.api#documentation": "

An unencrypted PEM encoded RSA or ED25519 private key.

", - "smithy.api#xmlName": "keyMaterial" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags applied to the key pair.

", + "smithy.api#xmlName": "tagSet" } }, "KeyName": { @@ -70684,20 +71156,20 @@ "smithy.api#xmlName": "keyName" } }, - "KeyPairId": { + "KeyFingerprint": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "KeyPairId", - "smithy.api#documentation": "

The ID of the key pair.

", - "smithy.api#xmlName": "keyPairId" + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "
    \n
  • \n

    For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

    \n
    • \n
  • \n

    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

    \n
    • \n
", + "smithy.api#xmlName": "keyFingerprint" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "KeyMaterial": { + "target": "com.amazonaws.ec2#SensitiveUserData", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags applied to the key pair.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "KeyMaterial", + "smithy.api#documentation": "

An unencrypted PEM encoded RSA or ED25519 private key.

", + "smithy.api#xmlName": "keyMaterial" } } }, @@ -70728,22 +71200,6 @@ "smithy.api#xmlName": "keyPairId" } }, - "KeyFingerprint": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyFingerprint", - "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair:

\n
    \n
  • \n

    For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

    \n
    • \n
  • \n

    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which \n is the default for OpenSSH, starting with OpenSSH 6.8.

    \n
    • \n
\n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n
    \n
  • \n

    For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

    \n
    • \n
  • \n

    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256\n digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

    \n
    • \n
", - "smithy.api#xmlName": "keyFingerprint" - } - }, - "KeyName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KeyName", - "smithy.api#documentation": "

The name of the key pair.

", - "smithy.api#xmlName": "keyName" - } - }, "KeyType": { "target": "com.amazonaws.ec2#KeyType", "traits": { @@ -70775,6 +71231,22 @@ "smithy.api#documentation": "

If you used Amazon EC2 to create the key pair, this is the date and time when the key\n was created, in ISO\n 8601 date-time format, in the UTC time zone.

\n

If you imported an existing key pair to Amazon EC2, this is the date and time the key\n was imported, in ISO\n 8601 date-time format, in the UTC time zone.

", "smithy.api#xmlName": "createTime" } + }, + "KeyName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyName", + "smithy.api#documentation": "

The name of the key pair.

", + "smithy.api#xmlName": "keyName" + } + }, + "KeyFingerprint": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KeyFingerprint", + "smithy.api#documentation": "

If you used CreateKeyPair to create the key pair:

\n
    \n
  • \n

    For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.

    \n
    • \n
  • \n

    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which \n is the default for OpenSSH, starting with OpenSSH 6.8.

    \n
    • \n
\n

If you used ImportKeyPair to provide Amazon Web Services the public key:

\n
    \n
  • \n

    For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.

    \n
    • \n
  • \n

    For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256\n digest, which is the default for OpenSSH, starting with OpenSSH 6.8.

    \n
    • \n
", + "smithy.api#xmlName": "keyFingerprint" + } } }, "traits": { @@ -70846,22 +71318,6 @@ "com.amazonaws.ec2#LaunchPermission": { "type": "structure", "members": { - "Group": { - "target": "com.amazonaws.ec2#PermissionGroup", - "traits": { - "aws.protocols#ec2QueryName": "Group", - "smithy.api#documentation": "

The name of the group.

", - "smithy.api#xmlName": "group" - } - }, - "UserId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The Amazon Web Services account ID.

\n

Constraints: Up to 10 000 account IDs can be specified in a single request.

", - "smithy.api#xmlName": "userId" - } - }, "OrganizationArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -70877,6 +71333,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organizational unit (OU).

", "smithy.api#xmlName": "organizationalUnitArn" } + }, + "UserId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The Amazon Web Services account ID.

\n

Constraints: Up to 10 000 account IDs can be specified in a single request.

", + "smithy.api#xmlName": "userId" + } + }, + "Group": { + "target": "com.amazonaws.ec2#PermissionGroup", + "traits": { + "aws.protocols#ec2QueryName": "Group", + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#xmlName": "group" + } } }, "traits": { @@ -70923,14 +71395,6 @@ "smithy.api#xmlName": "userData" } }, - "SecurityGroups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The IDs of the security groups.

", - "smithy.api#xmlName": "groupSet" - } - }, "AddressingType": { "target": "com.amazonaws.ec2#String", "traits": { @@ -71027,6 +71491,14 @@ "smithy.api#xmlName": "subnetId" } }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The IDs of the security groups.

", + "smithy.api#xmlName": "groupSet" + } + }, "Monitoring": { "target": "com.amazonaws.ec2#RunInstancesMonitoringEnabled", "traits": { @@ -71525,7 +71997,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an elastic inference accelerator.

" + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes an elastic inference accelerator.

" } }, "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorCount": { @@ -71566,7 +72038,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an elastic inference accelerator.

" + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

Describes an elastic inference accelerator.

" } }, "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList": { @@ -75436,7 +75908,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "InstanceFamily": { @@ -75717,24 +76189,6 @@ "com.amazonaws.ec2#ModifyHostsRequest": { "type": "structure", "members": { - "AutoPlacement": { - "target": "com.amazonaws.ec2#AutoPlacement", - "traits": { - "aws.protocols#ec2QueryName": "AutoPlacement", - "smithy.api#documentation": "

Specify whether to enable or disable auto-placement.

", - "smithy.api#xmlName": "autoPlacement" - } - }, - "HostIds": { - "target": "com.amazonaws.ec2#RequestHostIdList", - "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The IDs of the Dedicated Hosts to modify.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "hostId" - } - }, "HostRecovery": { "target": "com.amazonaws.ec2#HostRecovery", "traits": { @@ -75758,6 +76212,24 @@ "traits": { "smithy.api#documentation": "

Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.

" } + }, + "HostIds": { + "target": "com.amazonaws.ec2#RequestHostIdList", + "traits": { + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The IDs of the Dedicated Hosts to modify.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "hostId" + } + }, + "AutoPlacement": { + "target": "com.amazonaws.ec2#AutoPlacement", + "traits": { + "aws.protocols#ec2QueryName": "AutoPlacement", + "smithy.api#documentation": "

Specify whether to enable or disable auto-placement.

", + "smithy.api#xmlName": "autoPlacement" + } } }, "traits": { @@ -75839,16 +76311,6 @@ "com.amazonaws.ec2#ModifyIdentityIdFormatRequest": { "type": "structure", "members": { - "PrincipalArn": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrincipalArn", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify\n all to modify the ID format for all IAM users, IAM roles, and the root user of\n the account.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "principalArn" - } - }, "Resource": { "target": "com.amazonaws.ec2#String", "traits": { @@ -75868,6 +76330,16 @@ "smithy.api#required": {}, "smithy.api#xmlName": "useLongIds" } + }, + "PrincipalArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrincipalArn", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify\n all to modify the ID format for all IAM users, IAM roles, and the root user of\n the account.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "principalArn" + } } }, "traits": { @@ -75980,14 +76452,6 @@ "smithy.api#documentation": "

The value of the attribute being modified. \n This parameter can be used only when the Attribute parameter is description or imdsSupport.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" - } - }, "OrganizationArns": { "target": "com.amazonaws.ec2#OrganizationArnStringList", "traits": { @@ -76007,6 +76471,14 @@ "traits": { "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.

\n \n

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, \n you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

\n " } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } } }, "traits": { @@ -76059,77 +76531,60 @@ "smithy.api#documentation": "

Enable or disable source/destination checks, which ensure that the instance is either\n the source or the destination of any traffic that it receives. If the value is\n true, source/destination checks are enabled; otherwise, they are\n disabled. The default value is true. You must disable source/destination\n checks if the instance runs services such as network address translation, routing, or\n firewalls.

" } }, - "Attribute": { - "target": "com.amazonaws.ec2#InstanceAttributeName", - "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#documentation": "

The name of the attribute to modify.

\n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

\n ", - "smithy.api#xmlName": "attribute" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "BlockDeviceMapping", - "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated. You can't modify the DeleteOnTermination \n attribute for volumes that are attached to Fargate tasks.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.

", - "smithy.api#xmlName": "blockDeviceMapping" - } - }, - "DisableApiTermination": { + "DisableApiStop": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#documentation": "

If the value is true, you can't terminate the instance using the Amazon\n EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot\n Instances.

", - "smithy.api#xmlName": "disableApiTermination" + "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Enable stop\n protection for your instance.

\n

" } }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal EBS I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", - "smithy.api#xmlName": "ebsOptimized" + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "instanceId" } }, - "EnaSupport": { - "target": "com.amazonaws.ec2#AttributeBooleanValue", + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the\n instance.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", - "smithy.api#xmlName": "enaSupport" + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#documentation": "

The name of the attribute to modify.

\n \n

You can modify the following attributes only: disableApiTermination |\n instanceType | kernel | ramdisk |\n instanceInitiatedShutdownBehavior | blockDeviceMapping\n | userData | sourceDestCheck | groupSet |\n ebsOptimized | sriovNetSupport |\n enaSupport | nvmeSupport | disableApiStop\n | enclaveOptions\n

\n ", + "smithy.api#xmlName": "attribute" } }, - "Groups": { - "target": "com.amazonaws.ec2#GroupIdStringList", + "Value": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Replaces the security groups of the instance with the specified security groups.\n You must specify the ID of at least one security group, even if it's just the default\n security group for the VPC.

", - "smithy.api#xmlName": "GroupId" + "aws.protocols#ec2QueryName": "Value", + "smithy.api#documentation": "

A new value for the attribute. Use only with the kernel,\n ramdisk, userData, disableApiTermination, or\n instanceInitiatedShutdownBehavior attribute.

", + "smithy.api#xmlName": "value" } }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#InstanceBlockDeviceMappingSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The ID of the instance.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "BlockDeviceMapping", + "smithy.api#documentation": "

Modifies the DeleteOnTermination attribute for volumes that are currently\n attached. The volume must be owned by the caller. If no value is specified for\n DeleteOnTermination, the default is true and the volume is\n deleted when the instance is terminated. You can't modify the DeleteOnTermination \n attribute for volumes that are attached to Fargate tasks.

\n

To add instance store volumes to an Amazon EBS-backed instance, you must add them when\n you launch the instance. For more information, see Update the block device mapping when launching an instance in the\n Amazon EC2 User Guide.

", + "smithy.api#xmlName": "blockDeviceMapping" } }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#AttributeValue", + "DisableApiTermination": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Specifies whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If the value is true, you can't terminate the instance using the Amazon\n EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot\n Instances.

", + "smithy.api#xmlName": "disableApiTermination" } }, "InstanceType": { @@ -76156,14 +76611,6 @@ "smithy.api#xmlName": "ramdisk" } }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#AttributeValue", - "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", - "smithy.api#xmlName": "sriovNetSupport" - } - }, "UserData": { "target": "com.amazonaws.ec2#BlobAttributeValue", "traits": { @@ -76172,18 +76619,43 @@ "smithy.api#xmlName": "userData" } }, - "Value": { - "target": "com.amazonaws.ec2#String", + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#AttributeValue", "traits": { - "aws.protocols#ec2QueryName": "Value", - "smithy.api#documentation": "

A new value for the attribute. Use only with the kernel,\n ramdisk, userData, disableApiTermination, or\n instanceInitiatedShutdownBehavior attribute.

", - "smithy.api#xmlName": "value" + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Specifies whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" } }, - "DisableApiStop": { + "Groups": { + "target": "com.amazonaws.ec2#GroupIdStringList", + "traits": { + "smithy.api#documentation": "

Replaces the security groups of the instance with the specified security groups.\n You must specify the ID of at least one security group, even if it's just the default\n security group for the VPC.

", + "smithy.api#xmlName": "GroupId" + } + }, + "EbsOptimized": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "

Indicates whether an instance is enabled for stop protection. For more information,\n see Enable stop\n protection for your instance.

\n

" + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal EBS I/O performance. This optimization isn't available with all instance\n types. Additional usage charges apply when using an EBS Optimized instance.

", + "smithy.api#xmlName": "ebsOptimized" + } + }, + "SriovNetSupport": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual\n Function interface for the instance.

\n

There is no way to disable enhanced networking with the Intel 82599 Virtual Function\n interface at this time.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#xmlName": "sriovNetSupport" + } + }, + "EnaSupport": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the\n instance.

\n

This option is supported only for HVM instances. Specifying this option with a PV\n instance can make it unreachable.

", + "smithy.api#xmlName": "enaSupport" } } }, @@ -76249,6 +76721,88 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#ModifyInstanceCpuOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyInstanceCpuOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyInstanceCpuOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

By default, all vCPUs for the instance type are active when you launch an instance. When you \n\t\t\tconfigure the number of active vCPUs for the instance, it can help you save on licensing costs and \n\t\t\toptimize performance. The base cost of the instance remains unchanged.

\n

The number of active vCPUs equals the number of threads per CPU core multiplied by the number \n\t\t\tof cores. The instance must be in a Stopped state before you make changes.

\n \n

Some instance type options do not support this capability. For more information, see \n\t\t\t\tSupported CPU \n\t\t\t\t\toptions in the Amazon EC2 User Guide.

\n " + } + }, + "com.amazonaws.ec2#ModifyInstanceCpuOptionsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the instance to update.

", + "smithy.api#required": {} + } + }, + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of CPU cores to activate for the specified instance.

", + "smithy.api#required": {} + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The number of threads to run for each CPU core.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyInstanceCpuOptionsResult": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance that was updated.

", + "smithy.api#xmlName": "instanceId" + } + }, + "CoreCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "CoreCount", + "smithy.api#documentation": "

The number of CPU cores that are running for the specified instance after the \n\t\t\tupdate.

", + "smithy.api#xmlName": "coreCount" + } + }, + "ThreadsPerCore": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "ThreadsPerCore", + "smithy.api#documentation": "

The number of threads that are running per CPU core for the specified \n\t\t\tinstance after the update.

", + "smithy.api#xmlName": "threadsPerCore" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#ModifyInstanceCreditSpecification": { "type": "operation", "input": { @@ -76267,7 +76821,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "ClientToken": { @@ -76332,7 +76886,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } }, "InstanceId": { @@ -76555,7 +77109,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } } }, @@ -76682,26 +77236,28 @@ "com.amazonaws.ec2#ModifyInstancePlacementRequest": { "type": "structure", "members": { - "Affinity": { - "target": "com.amazonaws.ec2#Affinity", - "traits": { - "aws.protocols#ec2QueryName": "Affinity", - "smithy.api#documentation": "

The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "affinity" - } - }, "GroupName": { "target": "com.amazonaws.ec2#PlacementGroupName", "traits": { "smithy.api#documentation": "

The name of the placement group in which to place the instance. For spread placement\n groups, the instance must have a tenancy of default. For cluster and\n partition placement groups, the instance must have a tenancy of default or\n dedicated.

\n

To remove an instance from a placement group, specify an empty string (\"\").

" } }, - "HostId": { - "target": "com.amazonaws.ec2#DedicatedHostId", + "PartitionNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "HostId", - "smithy.api#documentation": "

The ID of the Dedicated Host with which to associate the instance.

", - "smithy.api#xmlName": "hostId" + "smithy.api#documentation": "

The number of the partition in which to place the instance. Valid only if the\n placement group strategy is set to partition.

" + } + }, + "HostResourceGroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The ARN of the host resource group in which to place the instance. The instance must\n have a tenancy of host to specify this parameter.

" + } + }, + "GroupId": { + "target": "com.amazonaws.ec2#PlacementGroupId", + "traits": { + "smithy.api#documentation": "

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement\n group.

" } }, "InstanceId": { @@ -76722,22 +77278,20 @@ "smithy.api#xmlName": "tenancy" } }, - "PartitionNumber": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The number of the partition in which to place the instance. Valid only if the\n placement group strategy is set to partition.

" - } - }, - "HostResourceGroupArn": { - "target": "com.amazonaws.ec2#String", + "Affinity": { + "target": "com.amazonaws.ec2#Affinity", "traits": { - "smithy.api#documentation": "

The ARN of the host resource group in which to place the instance. The instance must\n have a tenancy of host to specify this parameter.

" + "aws.protocols#ec2QueryName": "Affinity", + "smithy.api#documentation": "

The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "affinity" } }, - "GroupId": { - "target": "com.amazonaws.ec2#PlacementGroupId", + "HostId": { + "target": "com.amazonaws.ec2#DedicatedHostId", "traits": { - "smithy.api#documentation": "

The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement\n group.

" + "aws.protocols#ec2QueryName": "HostId", + "smithy.api#documentation": "

The ID of the Dedicated Host with which to associate the instance.

", + "smithy.api#xmlName": "hostId" } } }, @@ -77459,20 +78013,28 @@ "com.amazonaws.ec2#ModifyNetworkInterfaceAttributeRequest": { "type": "structure", "members": { - "Attachment": { - "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges", + "EnaSrdSpecification": { + "target": "com.amazonaws.ec2#EnaSrdSpecification", "traits": { - "aws.protocols#ec2QueryName": "Attachment", - "smithy.api#documentation": "

Information about the interface attachment. If modifying the delete on\n\t\t\t\ttermination attribute, you must specify the ID of the interface\n\t\t\tattachment.

", - "smithy.api#xmlName": "attachment" + "smithy.api#documentation": "

Updates the ENA Express configuration for the network interface that’s attached to the\n\t\t\tinstance.

" } }, - "Description": { - "target": "com.amazonaws.ec2#AttributeValue", + "EnablePrimaryIpv6": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for the network interface.

", - "smithy.api#xmlName": "description" + "smithy.api#documentation": "

If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use\n this option if the instance that this ENI will be attached to relies on its IPv6 address\n not changing. Amazon Web Services will automatically assign an IPv6 address associated\n with the ENI attached to your instance to be the primary IPv6 address. Once you enable\n an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.

" + } + }, + "ConnectionTrackingSpecification": { + "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "traits": { + "smithy.api#documentation": "

A connection tracking specification.

" + } + }, + "AssociatePublicIpAddress": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).

" } }, "DryRun": { @@ -77483,13 +78045,6 @@ "smithy.api#xmlName": "dryRun" } }, - "Groups": { - "target": "com.amazonaws.ec2#SecurityGroupIdStringList", - "traits": { - "smithy.api#documentation": "

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", - "smithy.api#xmlName": "SecurityGroupId" - } - }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { @@ -77500,6 +78055,14 @@ "smithy.api#xmlName": "networkInterfaceId" } }, + "Description": { + "target": "com.amazonaws.ec2#AttributeValue", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for the network interface.

", + "smithy.api#xmlName": "description" + } + }, "SourceDestCheck": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { @@ -77508,28 +78071,19 @@ "smithy.api#xmlName": "sourceDestCheck" } }, - "EnaSrdSpecification": { - "target": "com.amazonaws.ec2#EnaSrdSpecification", - "traits": { - "smithy.api#documentation": "

Updates the ENA Express configuration for the network interface that’s attached to the\n\t\t\tinstance.

" - } - }, - "EnablePrimaryIpv6": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "smithy.api#documentation": "

If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have\n the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA\n address associated with an ENI that you have enabled to use a primary IPv6 address. Use\n this option if the instance that this ENI will be attached to relies on its IPv6 address\n not changing. Amazon Web Services will automatically assign an IPv6 address associated\n with the ENI attached to your instance to be the primary IPv6 address. Once you enable\n an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.

" - } - }, - "ConnectionTrackingSpecification": { - "target": "com.amazonaws.ec2#ConnectionTrackingSpecificationRequest", + "Groups": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringList", "traits": { - "smithy.api#documentation": "

A connection tracking specification.

" + "smithy.api#documentation": "

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "smithy.api#xmlName": "SecurityGroupId" } }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.ec2#Boolean", + "Attachment": { + "target": "com.amazonaws.ec2#NetworkInterfaceAttachmentChanges", "traits": { - "smithy.api#documentation": "

Indicates whether to assign a public IPv4 address to a network interface. \n This option can be enabled for any network interface but will only apply to the primary network interface (eth0).

" + "aws.protocols#ec2QueryName": "Attachment", + "smithy.api#documentation": "

Information about the interface attachment. If modifying the delete on\n\t\t\t\ttermination attribute, you must specify the ID of the interface\n\t\t\tattachment.

", + "smithy.api#xmlName": "attachment" } } }, @@ -77917,14 +78471,6 @@ "com.amazonaws.ec2#ModifySpotFleetRequestRequest": { "type": "structure", "members": { - "ExcessCapacityTerminationPolicy": { - "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", - "traits": { - "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", - "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity\n of the Spot Fleet request is decreased below the current size of the Spot Fleet.

\n

Supported only for fleets of type maintain.

", - "smithy.api#xmlName": "excessCapacityTerminationPolicy" - } - }, "LaunchTemplateConfigs": { "target": "com.amazonaws.ec2#LaunchTemplateConfigList", "traits": { @@ -77932,6 +78478,18 @@ "smithy.api#xmlName": "LaunchTemplateConfig" } }, + "OnDemandTargetCapacity": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The number of On-Demand Instances in the fleet.

" + } + }, + "Context": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } + }, "SpotFleetRequestId": { "target": "com.amazonaws.ec2#SpotFleetRequestId", "traits": { @@ -77950,16 +78508,12 @@ "smithy.api#xmlName": "targetCapacity" } }, - "OnDemandTargetCapacity": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "smithy.api#documentation": "

The number of On-Demand Instances in the fleet.

" - } - }, - "Context": { - "target": "com.amazonaws.ec2#String", + "ExcessCapacityTerminationPolicy": { + "target": "com.amazonaws.ec2#ExcessCapacityTerminationPolicy", "traits": { - "smithy.api#documentation": "

Reserved.

" + "aws.protocols#ec2QueryName": "ExcessCapacityTerminationPolicy", + "smithy.api#documentation": "

Indicates whether running instances should be terminated if the target capacity\n of the Spot Fleet request is decreased below the current size of the Spot Fleet.

\n

Supported only for fleets of type maintain.

", + "smithy.api#xmlName": "excessCapacityTerminationPolicy" } } }, @@ -78049,7 +78603,7 @@ "EnableDns64": { "target": "com.amazonaws.ec2#AttributeBooleanValue", "traits": { - "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

\n \n

You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a 0.0.0.0/0 route pointing to the internet gateway. For more information, see Configure DNS64 and NAT64 in the Amazon VPC User Guide.

\n " + "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

\n

You must first configure a NAT gateway in a public subnet (separate from the subnet \n containing the IPv6-only workloads). For example, the subnet containing the NAT gateway \n should have a 0.0.0.0/0 route pointing to the internet gateway. For more \n information, see Configure DNS64 and NAT64 in the Amazon VPC User Guide.

" } }, "PrivateDnsHostnameTypeOnLaunch": { @@ -78397,7 +78951,7 @@ "SecurityGroupReferencingSupport": { "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", "traits": { - "smithy.api#documentation": "\n

This parameter is in preview and may not be available for your account.

\n \n

Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

" + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.\n\n

\n

This option is disabled by default.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

" } }, "AutoAcceptSharedAttachments": { @@ -78625,7 +79179,7 @@ "SecurityGroupReferencingSupport": { "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", "traits": { - "smithy.api#documentation": "\n

This parameter is in preview and may not be available for your account.

\n \n

Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

" + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.\n\n

\n

This option is disabled by default.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

" } }, "Ipv6Support": { @@ -80521,7 +81075,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } } @@ -82609,6 +83163,12 @@ "smithy.api#enumValue": "efa" } }, + "efa_only": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa-only" + } + }, "branch": { "target": "smithy.api#Unit", "traits": { @@ -82918,6 +83478,12 @@ "smithy.api#enumValue": "efa" } }, + "efa_only": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "efa-only" + } + }, "trunk": { "target": "smithy.api#Unit", "traits": { @@ -84551,14 +85117,6 @@ "com.amazonaws.ec2#Placement": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the instance.

\n

If not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.

\n

This parameter is not supported for CreateFleet.

", - "smithy.api#xmlName": "availabilityZone" - } - }, "Affinity": { "target": "com.amazonaws.ec2#String", "traits": { @@ -84622,6 +85180,14 @@ "smithy.api#documentation": "

The ID of the placement group that the instance is in. If you specify\n GroupId, you can't specify GroupName.

", "smithy.api#xmlName": "groupId" } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the instance.

\n

If not specified, an Availability Zone will be automatically chosen for you based on\n the load balancing criteria for the Region.

\n

This parameter is not supported for CreateFleet.

", + "smithy.api#xmlName": "availabilityZone" + } } }, "traits": { @@ -85238,12 +85804,12 @@ "com.amazonaws.ec2#PriceScheduleSpecification": { "type": "structure", "members": { - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", + "Term": { + "target": "com.amazonaws.ec2#Long", "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" + "aws.protocols#ec2QueryName": "Term", + "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "smithy.api#xmlName": "term" } }, "Price": { @@ -85254,12 +85820,12 @@ "smithy.api#xmlName": "price" } }, - "Term": { - "target": "com.amazonaws.ec2#Long", + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { - "aws.protocols#ec2QueryName": "Term", - "smithy.api#documentation": "

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", - "smithy.api#xmlName": "term" + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" } } }, @@ -86653,6 +87219,12 @@ "smithy.api#required": {} } }, + "PurchaseTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "smithy.api#documentation": "

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -86668,12 +87240,6 @@ "smithy.api#documentation": "

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "smithy.api#xmlName": "limitPrice" } - }, - "PurchaseTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "smithy.api#documentation": "

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" - } } }, "traits": { @@ -86857,7 +87423,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } } @@ -86961,12 +87527,12 @@ "com.amazonaws.ec2#Region": { "type": "structure", "members": { - "Endpoint": { + "OptInStatus": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RegionEndpoint", - "smithy.api#documentation": "

The Region service endpoint.

", - "smithy.api#xmlName": "regionEndpoint" + "aws.protocols#ec2QueryName": "OptInStatus", + "smithy.api#documentation": "

The Region opt-in status. The possible values are opt-in-not-required, opted-in, and \n not-opted-in.

", + "smithy.api#xmlName": "optInStatus" } }, "RegionName": { @@ -86977,12 +87543,12 @@ "smithy.api#xmlName": "regionName" } }, - "OptInStatus": { + "Endpoint": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OptInStatus", - "smithy.api#documentation": "

The Region opt-in status. The possible values are opt-in-not-required, opted-in, and \n not-opted-in.

", - "smithy.api#xmlName": "optInStatus" + "aws.protocols#ec2QueryName": "RegionEndpoint", + "smithy.api#documentation": "

The Region service endpoint.

", + "smithy.api#xmlName": "regionEndpoint" } } }, @@ -87041,51 +87607,50 @@ "smithy.api#documentation": "

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the \n \t\taws-exec-read canned access control list (ACL) to ensure that it can be accessed \n \t\tby Amazon EC2. For more information, see Canned ACLs in the \n \t\tAmazon S3 Service Developer Guide.

" } }, - "Architecture": { - "target": "com.amazonaws.ec2#ArchitectureValues", + "BillingProducts": { + "target": "com.amazonaws.ec2#BillingProductList", "traits": { - "aws.protocols#ec2QueryName": "Architecture", - "smithy.api#documentation": "

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

", - "smithy.api#xmlName": "architecture" + "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product codes.

\n

If your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based\n products in the Amazon Web Services Marketplace Seller Guide.

", + "smithy.api#xmlName": "BillingProduct" } }, - "BlockDeviceMappings": { - "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", "traits": { - "smithy.api#documentation": "

The block device mapping entries.

\n

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

\n

If you create an AMI on an Outpost, then all backing snapshots must be on the same\n Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can\n be used to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EBS User Guide.

", - "smithy.api#xmlName": "BlockDeviceMapping" + "smithy.api#documentation": "

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

\n \n

The operating system contained in the AMI must be configured to support the specified boot mode.

\n \n

For more information, see Boot modes in the\n Amazon EC2 User Guide.

" } }, - "Description": { - "target": "com.amazonaws.ec2#String", + "TpmSupport": { + "target": "com.amazonaws.ec2#TpmSupportValues", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

A description for your AMI.

", - "smithy.api#xmlName": "description" + "smithy.api#documentation": "

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon EC2 User Guide.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", + "UefiData": { + "target": "com.amazonaws.ec2#StringType", "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", - "smithy.api#xmlName": "dryRun" + "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" } }, - "EnaSupport": { - "target": "com.amazonaws.ec2#Boolean", + "ImdsSupport": { + "target": "com.amazonaws.ec2#ImdsSupportValues", "traits": { - "aws.protocols#ec2QueryName": "EnaSupport", - "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", - "smithy.api#xmlName": "enaSupport" + "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.

\n \n

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

\n " } }, - "KernelId": { - "target": "com.amazonaws.ec2#KernelId", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "KernelId", - "smithy.api#documentation": "

The ID of the kernel.

", - "smithy.api#xmlName": "kernelId" + "smithy.api#documentation": "

The tags to apply to the AMI.

\n

To tag the AMI, the value for ResourceType must be image. If you\n specify another value for ResourceType, the request fails.

\n

To tag an AMI after it has been registered, see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" } }, "Name": { @@ -87098,11 +87663,28 @@ "smithy.api#xmlName": "name" } }, - "BillingProducts": { - "target": "com.amazonaws.ec2#BillingProductList", + "Description": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The billing product codes. Your account must be authorized to specify billing product codes.

\n

If your account is not authorized to specify billing product codes, you can publish AMIs\n that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller\n on the Amazon Web Services Marketplace. For more information, see Getting started as a\n seller and AMI-based\n products in the Amazon Web Services Marketplace Seller Guide.

", - "smithy.api#xmlName": "BillingProduct" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

A description for your AMI.

", + "smithy.api#xmlName": "description" + } + }, + "Architecture": { + "target": "com.amazonaws.ec2#ArchitectureValues", + "traits": { + "aws.protocols#ec2QueryName": "Architecture", + "smithy.api#documentation": "

The architecture of the AMI.

\n

Default: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.

", + "smithy.api#xmlName": "architecture" + } + }, + "KernelId": { + "target": "com.amazonaws.ec2#KernelId", + "traits": { + "aws.protocols#ec2QueryName": "KernelId", + "smithy.api#documentation": "

The ID of the kernel.

", + "smithy.api#xmlName": "kernelId" } }, "RamdiskId": { @@ -87121,12 +87703,11 @@ "smithy.api#xmlName": "rootDeviceName" } }, - "SriovNetSupport": { - "target": "com.amazonaws.ec2#String", + "BlockDeviceMappings": { + "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", "traits": { - "aws.protocols#ec2QueryName": "SriovNetSupport", - "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

\n

There is no way to disable sriovNetSupport at this time.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", - "smithy.api#xmlName": "sriovNetSupport" + "smithy.api#documentation": "

The block device mapping entries.

\n

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

\n

If you create an AMI on an Outpost, then all backing snapshots must be on the same\n Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can\n be used to launch instances on the same Outpost only. For more information, Amazon EBS local\n snapshots on Outposts in the Amazon EBS User Guide.

", + "smithy.api#xmlName": "BlockDeviceMapping" } }, "VirtualizationType": { @@ -87137,35 +87718,20 @@ "smithy.api#xmlName": "virtualizationType" } }, - "BootMode": { - "target": "com.amazonaws.ec2#BootModeValues", - "traits": { - "smithy.api#documentation": "

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

\n \n

The operating system contained in the AMI must be configured to support the specified boot mode.

\n \n

For more information, see Boot modes in the\n Amazon EC2 User Guide.

" - } - }, - "TpmSupport": { - "target": "com.amazonaws.ec2#TpmSupportValues", - "traits": { - "smithy.api#documentation": "

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more\n information, see NitroTPM in the Amazon EC2 User Guide.

" - } - }, - "UefiData": { - "target": "com.amazonaws.ec2#StringType", - "traits": { - "smithy.api#documentation": "

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data,\n use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the\n python-uefivars tool on\n GitHub. For more information, see UEFI Secure Boot in the\n Amazon EC2 User Guide.

" - } - }, - "ImdsSupport": { - "target": "com.amazonaws.ec2#ImdsSupportValues", + "SriovNetSupport": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances\n launched from this AMI will have HttpTokens automatically set to\n required so that, by default, the instance requires that IMDSv2 is used when\n requesting instance metadata. In addition, HttpPutResponseHopLimit is set to\n 2. For more information, see Configure\n the AMI in the Amazon EC2 User Guide.

\n \n

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

\n " + "aws.protocols#ec2QueryName": "SriovNetSupport", + "smithy.api#documentation": "

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

\n

There is no way to disable sriovNetSupport at this time.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "smithy.api#xmlName": "sriovNetSupport" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "EnaSupport": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

The tags to apply to the AMI.

\n

To tag the AMI, the value for ResourceType must be image. If you\n specify another value for ResourceType, the request fails.

\n

To tag an AMI after it has been registered, see CreateTags.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "EnaSupport", + "smithy.api#documentation": "

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

\n

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "smithy.api#xmlName": "enaSupport" } } }, @@ -87390,6 +87956,56 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#RejectCapacityReservationBillingOwnership": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#RejectCapacityReservationBillingOwnershipRequest" + }, + "output": { + "target": "com.amazonaws.ec2#RejectCapacityReservationBillingOwnershipResult" + }, + "traits": { + "smithy.api#documentation": "

Rejects a request to assign billing of the available capacity of a shared Capacity Reservation \n\t\t\tto your account. For more information, see \n\t\t\t\tBilling assignment for shared Amazon EC2 Capacity Reservations.

" + } + }, + "com.amazonaws.ec2#RejectCapacityReservationBillingOwnershipRequest": { + "type": "structure", + "members": { + "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, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "CapacityReservationId": { + "target": "com.amazonaws.ec2#CapacityReservationId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the Capacity Reservation for which to reject the request.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#RejectCapacityReservationBillingOwnershipResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#RejectTransitGatewayMulticastDomainAssociations": { "type": "operation", "input": { @@ -87972,6 +88588,14 @@ "com.amazonaws.ec2#ReplaceNetworkAclAssociationRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } + }, "AssociationId": { "target": "com.amazonaws.ec2#NetworkAclAssociationId", "traits": { @@ -87982,14 +88606,6 @@ "smithy.api#xmlName": "associationId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "NetworkAclId": { "target": "com.amazonaws.ec2#NetworkAclId", "traits": { @@ -88054,14 +88670,6 @@ "com.amazonaws.ec2#ReplaceNetworkAclEntryRequest": { "type": "structure", "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n 172.16.0.0/24).

", - "smithy.api#xmlName": "cidrBlock" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -88070,31 +88678,6 @@ "smithy.api#xmlName": "dryRun" } }, - "Egress": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Egress", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n

Default: If no value is specified, we replace the ingress rule.

", - "smithy.api#required": {}, - "smithy.api#xmlName": "egress" - } - }, - "IcmpTypeCode": { - "target": "com.amazonaws.ec2#IcmpTypeCode", - "traits": { - "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol\n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", - "smithy.api#xmlName": "Icmp" - } - }, - "Ipv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6CidrBlock", - "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:bd8:1234:1a00::/64).

", - "smithy.api#xmlName": "ipv6CidrBlock" - } - }, "NetworkAclId": { "target": "com.amazonaws.ec2#NetworkAclId", "traits": { @@ -88105,12 +88688,14 @@ "smithy.api#xmlName": "networkAclId" } }, - "PortRange": { - "target": "com.amazonaws.ec2#PortRange", + "RuleNumber": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "PortRange", - "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to. \n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", - "smithy.api#xmlName": "portRange" + "aws.protocols#ec2QueryName": "RuleNumber", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The rule number of the entry to replace.

", + "smithy.api#required": {}, + "smithy.api#xmlName": "ruleNumber" } }, "Protocol": { @@ -88133,14 +88718,45 @@ "smithy.api#xmlName": "ruleAction" } }, - "RuleNumber": { - "target": "com.amazonaws.ec2#Integer", + "Egress": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "RuleNumber", + "aws.protocols#ec2QueryName": "Egress", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The rule number of the entry to replace.

", + "smithy.api#documentation": "

Indicates whether to replace the egress rule.

\n

Default: If no value is specified, we replace the ingress rule.

", "smithy.api#required": {}, - "smithy.api#xmlName": "ruleNumber" + "smithy.api#xmlName": "egress" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 network range to allow or deny, in CIDR notation (for example\n 172.16.0.0/24).

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "Ipv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6CidrBlock", + "smithy.api#documentation": "

The IPv6 network range to allow or deny, in CIDR notation (for example\n 2001:bd8:1234:1a00::/64).

", + "smithy.api#xmlName": "ipv6CidrBlock" + } + }, + "IcmpTypeCode": { + "target": "com.amazonaws.ec2#IcmpTypeCode", + "traits": { + "smithy.api#documentation": "

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol\n\t\t 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "smithy.api#xmlName": "Icmp" + } + }, + "PortRange": { + "target": "com.amazonaws.ec2#PortRange", + "traits": { + "aws.protocols#ec2QueryName": "PortRange", + "smithy.api#documentation": "

TCP or UDP protocols: The range of ports the rule applies to. \n\t\t Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "smithy.api#xmlName": "portRange" } } }, @@ -88316,80 +88932,24 @@ "com.amazonaws.ec2#ReplaceRouteRequest": { "type": "structure", "members": { - "DestinationCidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationCidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", - "smithy.api#xmlName": "destinationCidrBlock" - } - }, - "DestinationIpv6CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", - "smithy.api#documentation": "

The IPv6 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", - "smithy.api#xmlName": "destinationIpv6CidrBlock" - } - }, "DestinationPrefixListId": { "target": "com.amazonaws.ec2#PrefixListResourceId", "traits": { "smithy.api#documentation": "

The ID of the prefix list for the route.

" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "VpcEndpointId": { "target": "com.amazonaws.ec2#VpcEndpointId", "traits": { "smithy.api#documentation": "

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

" } }, - "EgressOnlyInternetGatewayId": { - "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", - "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", - "smithy.api#xmlName": "egressOnlyInternetGatewayId" - } - }, - "GatewayId": { - "target": "com.amazonaws.ec2#RouteGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "GatewayId", - "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway.

", - "smithy.api#xmlName": "gatewayId" - } - }, - "InstanceId": { - "target": "com.amazonaws.ec2#InstanceId", - "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", - "smithy.api#xmlName": "instanceId" - } - }, "LocalTarget": { "target": "com.amazonaws.ec2#Boolean", "traits": { "smithy.api#documentation": "

Specifies whether to reset the local route to its default target (local).

" } }, - "NatGatewayId": { - "target": "com.amazonaws.ec2#NatGatewayId", - "traits": { - "aws.protocols#ec2QueryName": "NatGatewayId", - "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", - "smithy.api#xmlName": "natGatewayId" - } - }, "TransitGatewayId": { "target": "com.amazonaws.ec2#TransitGatewayId", "traits": { @@ -88408,12 +88968,18 @@ "smithy.api#documentation": "

[IPv4 traffic only] The ID of a carrier gateway.

" } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.ec2#NetworkInterfaceId", + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", "traits": { - "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "

The ID of a network interface.

", - "smithy.api#xmlName": "networkInterfaceId" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" } }, "RouteTableId": { @@ -88426,6 +88992,54 @@ "smithy.api#xmlName": "routeTableId" } }, + "DestinationCidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationCidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", + "smithy.api#xmlName": "destinationCidrBlock" + } + }, + "GatewayId": { + "target": "com.amazonaws.ec2#RouteGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "GatewayId", + "smithy.api#documentation": "

The ID of an internet gateway or virtual private gateway.

", + "smithy.api#xmlName": "gatewayId" + } + }, + "DestinationIpv6CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DestinationIpv6CidrBlock", + "smithy.api#documentation": "

The IPv6 CIDR address block used for the destination match. The value that you\n\t\t\tprovide must match the CIDR of an existing route in the table.

", + "smithy.api#xmlName": "destinationIpv6CidrBlock" + } + }, + "EgressOnlyInternetGatewayId": { + "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", + "traits": { + "aws.protocols#ec2QueryName": "EgressOnlyInternetGatewayId", + "smithy.api#documentation": "

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "smithy.api#xmlName": "egressOnlyInternetGatewayId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#InstanceId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of a NAT instance in your VPC.

", + "smithy.api#xmlName": "instanceId" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceId", + "smithy.api#documentation": "

The ID of a network interface.

", + "smithy.api#xmlName": "networkInterfaceId" + } + }, "VpcPeeringConnectionId": { "target": "com.amazonaws.ec2#VpcPeeringConnectionId", "traits": { @@ -88434,10 +89048,12 @@ "smithy.api#xmlName": "vpcPeeringConnectionId" } }, - "CoreNetworkArn": { - "target": "com.amazonaws.ec2#CoreNetworkArn", + "NatGatewayId": { + "target": "com.amazonaws.ec2#NatGatewayId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the core network.

" + "aws.protocols#ec2QueryName": "NatGatewayId", + "smithy.api#documentation": "

[IPv4 traffic only] The ID of a NAT gateway.

", + "smithy.api#xmlName": "natGatewayId" } } }, @@ -88473,6 +89089,14 @@ "com.amazonaws.ec2#ReplaceRouteTableAssociationRequest": { "type": "structure", "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "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.

", + "smithy.api#xmlName": "dryRun" + } + }, "AssociationId": { "target": "com.amazonaws.ec2#RouteTableAssociationId", "traits": { @@ -88483,14 +89107,6 @@ "smithy.api#xmlName": "associationId" } }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, "RouteTableId": { "target": "com.amazonaws.ec2#RouteTableId", "traits": { @@ -88755,30 +89371,14 @@ "com.amazonaws.ec2#ReportInstanceStatusRequest": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

Descriptive text about the health state of your instance.

", - "smithy.api#xmlName": "description" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, - "EndTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "EndTime", - "smithy.api#documentation": "

The time at which the reported instance health state ended.

", - "smithy.api#xmlName": "endTime" - } - }, "Instances": { "target": "com.amazonaws.ec2#InstanceIdStringList", "traits": { @@ -88789,14 +89389,14 @@ "smithy.api#xmlName": "instanceId" } }, - "ReasonCodes": { - "target": "com.amazonaws.ec2#ReasonCodesList", + "Status": { + "target": "com.amazonaws.ec2#ReportStatusType", "traits": { - "aws.protocols#ec2QueryName": "ReasonCode", + "aws.protocols#ec2QueryName": "Status", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The reason codes that describe the health state of your instance.

\n
    \n
  • \n

    \n instance-stuck-in-state: My instance is stuck in a state.

    \n
    • \n
  • \n

    \n unresponsive: My instance is unresponsive.

    \n
    • \n
  • \n

    \n not-accepting-credentials: My instance is not accepting my\n credentials.

    \n
    • \n
  • \n

    \n password-not-available: A password is not available for my\n instance.

    \n
    • \n
  • \n

    \n performance-network: My instance is experiencing performance\n problems that I believe are network related.

    \n
    • \n
  • \n

    \n performance-instance-store: My instance is experiencing performance\n problems that I believe are related to the instance stores.

    \n
    • \n
  • \n

    \n performance-ebs-volume: My instance is experiencing performance\n problems that I believe are related to an EBS volume.

    \n
    • \n
  • \n

    \n performance-other: My instance is experiencing performance\n problems.

    \n
    • \n
  • \n

    \n other: [explain using the description parameter]

    \n
    • \n
", + "smithy.api#documentation": "

The status of all instances listed.

", "smithy.api#required": {}, - "smithy.api#xmlName": "reasonCode" + "smithy.api#xmlName": "status" } }, "StartTime": { @@ -88807,14 +89407,33 @@ "smithy.api#xmlName": "startTime" } }, - "Status": { - "target": "com.amazonaws.ec2#ReportStatusType", + "EndTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "Status", + "aws.protocols#ec2QueryName": "EndTime", + "smithy.api#documentation": "

The time at which the reported instance health state ended.

", + "smithy.api#xmlName": "endTime" + } + }, + "ReasonCodes": { + "target": "com.amazonaws.ec2#ReasonCodesList", + "traits": { + "aws.protocols#ec2QueryName": "ReasonCode", "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The status of all instances listed.

", + "smithy.api#documentation": "

The reason codes that describe the health state of your instance.

\n
    \n
  • \n

    \n instance-stuck-in-state: My instance is stuck in a state.

    \n
    • \n
  • \n

    \n unresponsive: My instance is unresponsive.

    \n
    • \n
  • \n

    \n not-accepting-credentials: My instance is not accepting my\n credentials.

    \n
    • \n
  • \n

    \n password-not-available: A password is not available for my\n instance.

    \n
    • \n
  • \n

    \n performance-network: My instance is experiencing performance\n problems that I believe are network related.

    \n
    • \n
  • \n

    \n performance-instance-store: My instance is experiencing performance\n problems that I believe are related to the instance stores.

    \n
    • \n
  • \n

    \n performance-ebs-volume: My instance is experiencing performance\n problems that I believe are related to an EBS volume.

    \n
    • \n
  • \n

    \n performance-other: My instance is experiencing performance\n problems.

    \n
    • \n
  • \n

    \n other: [explain using the description parameter]

    \n
    • \n
", "smithy.api#required": {}, - "smithy.api#xmlName": "status" + "smithy.api#xmlName": "reasonCode" + } + }, + "Description": { + "target": "com.amazonaws.ec2#ReportInstanceStatusRequestDescription", + "traits": { + "aws.protocols#ec2QueryName": "Description", + "smithy.api#deprecated": { + "message": "This member has been deprecated" + }, + "smithy.api#documentation": "

Descriptive text about the health state of your instance.

", + "smithy.api#xmlName": "description" } } }, @@ -88822,6 +89441,12 @@ "smithy.api#input": {} } }, + "com.amazonaws.ec2#ReportInstanceStatusRequestDescription": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.ec2#ReportStatusType": { "type": "enum", "members": { @@ -89017,14 +89642,14 @@ "ElasticGpuSpecifications": { "target": "com.amazonaws.ec2#ElasticGpuSpecificationList", "traits": { - "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n ", + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n ", "smithy.api#xmlName": "ElasticGpuSpecification" } }, "ElasticInferenceAccelerators": { "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorList", "traits": { - "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

\n \n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.

\n ", + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Inference is no longer available.

\n ", "smithy.api#xmlName": "ElasticInferenceAccelerator" } }, @@ -89094,7 +89719,7 @@ "InstanceRequirements": { "target": "com.amazonaws.ec2#InstanceRequirementsRequest", "traits": { - "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n
    \n
  • \n

    \n AllowedInstanceTypes - The instance types to include in the list. All \n other instance types are ignored, even if they match your specified attributes.

    \n
    • \n
  • \n

    \n ExcludedInstanceTypes - The instance types to exclude from the list, \n even if they match your specified attributes.

    \n
    • \n
\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard, or with the RunInstances API or\n AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.

\n \n

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot\n placement score in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with these attributes.

\n

You must specify VCpuCount and MemoryMiB. All other attributes\n are optional. Any unspecified optional attribute is set to its default.

\n

When you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.

\n

To limit the list of instance types from which Amazon EC2 can identify matching instance types, \n you can use one of the following parameters, but not both in the same request:

\n
    \n
  • \n

    \n AllowedInstanceTypes - The instance types to include in the list. All \n other instance types are ignored, even if they match your specified attributes.

    \n
    • \n
  • \n

    \n ExcludedInstanceTypes - The instance types to exclude from the list, \n even if they match your specified attributes.

    \n
    • \n
\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n

Attribute-based instance type selection is only supported when using Auto Scaling\n groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in\n the launch instance\n wizard, or with the RunInstances API or\n AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify InstanceRequirements.

\n \n

For more information, see Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot\n placement score in the Amazon EC2 User Guide.

" } }, "PrivateDnsNameOptions": { @@ -89366,28 +89991,23 @@ "com.amazonaws.ec2#RequestSpotInstancesRequest": { "type": "structure", "members": { - "AvailabilityZoneGroup": { - "target": "com.amazonaws.ec2#String", + "LaunchSpecification": { + "target": "com.amazonaws.ec2#RequestSpotLaunchSpecification", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", - "smithy.api#documentation": "

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.

\n

If there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

", - "smithy.api#xmlName": "availabilityZoneGroup" + "smithy.api#documentation": "

The launch specification.

" } }, - "BlockDurationMinutes": { - "target": "com.amazonaws.ec2#Integer", + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", "traits": { - "aws.protocols#ec2QueryName": "BlockDurationMinutes", - "smithy.api#documentation": "

Deprecated.

", - "smithy.api#xmlName": "blockDurationMinutes" + "smithy.api#documentation": "

The key-value pair for tagging the Spot Instance request on creation. The value for\n ResourceType must be spot-instances-request, otherwise the\n Spot Instance request fails. To tag the Spot Instance request after it has been created,\n see CreateTags.

", + "smithy.api#xmlName": "TagSpecification" } }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", + "InstanceInterruptionBehavior": { + "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency in\n Amazon EC2 API requests in the Amazon EC2 User Guide.

", - "smithy.api#xmlName": "clientToken" + "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" } }, "DryRun": { @@ -89398,34 +90018,28 @@ "smithy.api#xmlName": "dryRun" } }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#documentation": "

The maximum number of Spot Instances to launch.

\n

Default: 1

", - "smithy.api#xmlName": "instanceCount" - } - }, - "LaunchGroup": { + "SpotPrice": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "LaunchGroup", - "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.

\n

Default: Instances are launched and terminated individually

", - "smithy.api#xmlName": "launchGroup" + "aws.protocols#ec2QueryName": "SpotPrice", + "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", + "smithy.api#xmlName": "spotPrice" } }, - "LaunchSpecification": { - "target": "com.amazonaws.ec2#RequestSpotLaunchSpecification", + "ClientToken": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The launch specification.

" + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see Ensuring idempotency in\n Amazon EC2 API requests in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "clientToken" } }, - "SpotPrice": { - "target": "com.amazonaws.ec2#String", + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "SpotPrice", - "smithy.api#documentation": "

The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend \n using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

\n \n

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

\n ", - "smithy.api#xmlName": "spotPrice" + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The maximum number of Spot Instances to launch.

\n

Default: 1

", + "smithy.api#xmlName": "instanceCount" } }, "Type": { @@ -89452,17 +90066,28 @@ "smithy.api#xmlName": "validUntil" } }, - "TagSpecifications": { - "target": "com.amazonaws.ec2#TagSpecificationList", + "LaunchGroup": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The key-value pair for tagging the Spot Instance request on creation. The value for\n ResourceType must be spot-instances-request, otherwise the\n Spot Instance request fails. To tag the Spot Instance request after it has been created,\n see CreateTags.

", - "smithy.api#xmlName": "TagSpecification" + "aws.protocols#ec2QueryName": "LaunchGroup", + "smithy.api#documentation": "

The instance launch group. Launch groups are Spot Instances that launch together and\n terminate together.

\n

Default: Instances are launched and terminated individually

", + "smithy.api#xmlName": "launchGroup" } }, - "InstanceInterruptionBehavior": { - "target": "com.amazonaws.ec2#InstanceInterruptionBehavior", + "AvailabilityZoneGroup": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The behavior when a Spot Instance is interrupted. The default is terminate.

" + "aws.protocols#ec2QueryName": "AvailabilityZoneGroup", + "smithy.api#documentation": "

The user-specified name for a logical grouping of requests.

\n

When you specify an Availability Zone group in a Spot Instance request, all Spot\n Instances in the request are launched in the same Availability Zone. Instance proximity\n is maintained with this parameter, but the choice of Availability Zone is not. The group\n applies only to requests for Spot Instances of the same instance type. Any additional\n Spot Instance requests that are specified with the same Availability Zone group name are\n launched in that same Availability Zone, as long as at least one instance from the group\n is still active.

\n

If there is no active instance running in the Availability Zone group that you specify\n for a new Spot Instance request (all instances are terminated, the request is expired,\n or the maximum price you specified falls below current Spot price), then Amazon EC2 launches\n the instance in any Availability Zone where the constraint can be met. Consequently, the\n subsequent set of Spot Instances could be placed in a different zone from the original\n request, even if you specified the same Availability Zone group.

\n

Default: Instances are launched in any available Availability Zone.

", + "smithy.api#xmlName": "availabilityZoneGroup" + } + }, + "BlockDurationMinutes": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "BlockDurationMinutes", + "smithy.api#documentation": "

Deprecated.

", + "smithy.api#xmlName": "blockDurationMinutes" } } }, @@ -89562,7 +90187,7 @@ } }, "KeyName": { - "target": "com.amazonaws.ec2#KeyPairName", + "target": "com.amazonaws.ec2#KeyPairNameWithResolver", "traits": { "aws.protocols#ec2QueryName": "KeyName", "smithy.api#documentation": "

The name of the key pair.

", @@ -89642,20 +90267,12 @@ "com.amazonaws.ec2#Reservation": { "type": "structure", "members": { - "Groups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

Not supported.

", - "smithy.api#xmlName": "groupSet" - } - }, - "Instances": { - "target": "com.amazonaws.ec2#InstanceList", + "ReservationId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstancesSet", - "smithy.api#documentation": "

The instances.

", - "smithy.api#xmlName": "instancesSet" + "aws.protocols#ec2QueryName": "ReservationId", + "smithy.api#documentation": "

The ID of the reservation.

", + "smithy.api#xmlName": "reservationId" } }, "OwnerId": { @@ -89674,12 +90291,20 @@ "smithy.api#xmlName": "requesterId" } }, - "ReservationId": { - "target": "com.amazonaws.ec2#String", + "Groups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", "traits": { - "aws.protocols#ec2QueryName": "ReservationId", - "smithy.api#documentation": "

The ID of the reservation.

", - "smithy.api#xmlName": "reservationId" + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

Not supported.

", + "smithy.api#xmlName": "groupSet" + } + }, + "Instances": { + "target": "com.amazonaws.ec2#InstanceList", + "traits": { + "aws.protocols#ec2QueryName": "InstancesSet", + "smithy.api#documentation": "

The instances.

", + "smithy.api#xmlName": "instancesSet" } } }, @@ -89926,60 +90551,60 @@ "com.amazonaws.ec2#ReservedInstances": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "CurrencyCode": { + "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "CurrencyCode", + "smithy.api#documentation": "

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.

", + "smithy.api#xmlName": "currencyCode" } }, - "Duration": { - "target": "com.amazonaws.ec2#Long", + "InstanceTenancy": { + "target": "com.amazonaws.ec2#Tenancy", "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", - "smithy.api#xmlName": "duration" + "aws.protocols#ec2QueryName": "InstanceTenancy", + "smithy.api#documentation": "

The tenancy of the instance.

", + "smithy.api#xmlName": "instanceTenancy" } }, - "End": { - "target": "com.amazonaws.ec2#DateTime", + "OfferingClass": { + "target": "com.amazonaws.ec2#OfferingClassType", "traits": { - "aws.protocols#ec2QueryName": "End", - "smithy.api#documentation": "

The time when the Reserved Instance expires.

", - "smithy.api#xmlName": "end" + "aws.protocols#ec2QueryName": "OfferingClass", + "smithy.api#documentation": "

The offering class of the Reserved Instance.

", + "smithy.api#xmlName": "offeringClass" } }, - "FixedPrice": { - "target": "com.amazonaws.ec2#Float", + "OfferingType": { + "target": "com.amazonaws.ec2#OfferingTypeValues", "traits": { - "aws.protocols#ec2QueryName": "FixedPrice", - "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", - "smithy.api#xmlName": "fixedPrice" + "aws.protocols#ec2QueryName": "OfferingType", + "smithy.api#documentation": "

The Reserved Instance offering type.

", + "smithy.api#xmlName": "offeringType" } }, - "InstanceCount": { - "target": "com.amazonaws.ec2#Integer", + "RecurringCharges": { + "target": "com.amazonaws.ec2#RecurringChargesList", "traits": { - "aws.protocols#ec2QueryName": "InstanceCount", - "smithy.api#documentation": "

The number of reservations purchased.

", - "smithy.api#xmlName": "instanceCount" + "aws.protocols#ec2QueryName": "RecurringCharges", + "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", + "smithy.api#xmlName": "recurringCharges" } }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", + "Scope": { + "target": "com.amazonaws.ec2#scope", "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", - "smithy.api#xmlName": "instanceType" + "aws.protocols#ec2QueryName": "Scope", + "smithy.api#documentation": "

The scope of the Reserved Instance.

", + "smithy.api#xmlName": "scope" } }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "ProductDescription", - "smithy.api#documentation": "

The Reserved Instance product platform description.

", - "smithy.api#xmlName": "productDescription" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the resource.

", + "smithy.api#xmlName": "tagSet" } }, "ReservedInstancesId": { @@ -89990,6 +90615,22 @@ "smithy.api#xmlName": "reservedInstancesId" } }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", + "smithy.api#xmlName": "instanceType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", + "smithy.api#xmlName": "availabilityZone" + } + }, "Start": { "target": "com.amazonaws.ec2#DateTime", "traits": { @@ -89998,12 +90639,20 @@ "smithy.api#xmlName": "start" } }, - "State": { - "target": "com.amazonaws.ec2#ReservedInstanceState", + "End": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The state of the Reserved Instance purchase.

", - "smithy.api#xmlName": "state" + "aws.protocols#ec2QueryName": "End", + "smithy.api#documentation": "

The time when the Reserved Instance expires.

", + "smithy.api#xmlName": "end" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", + "smithy.api#xmlName": "duration" } }, "UsagePrice": { @@ -90014,60 +90663,36 @@ "smithy.api#xmlName": "usagePrice" } }, - "CurrencyCode": { - "target": "com.amazonaws.ec2#CurrencyCodeValues", - "traits": { - "aws.protocols#ec2QueryName": "CurrencyCode", - "smithy.api#documentation": "

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.

", - "smithy.api#xmlName": "currencyCode" - } - }, - "InstanceTenancy": { - "target": "com.amazonaws.ec2#Tenancy", - "traits": { - "aws.protocols#ec2QueryName": "InstanceTenancy", - "smithy.api#documentation": "

The tenancy of the instance.

", - "smithy.api#xmlName": "instanceTenancy" - } - }, - "OfferingClass": { - "target": "com.amazonaws.ec2#OfferingClassType", - "traits": { - "aws.protocols#ec2QueryName": "OfferingClass", - "smithy.api#documentation": "

The offering class of the Reserved Instance.

", - "smithy.api#xmlName": "offeringClass" - } - }, - "OfferingType": { - "target": "com.amazonaws.ec2#OfferingTypeValues", + "FixedPrice": { + "target": "com.amazonaws.ec2#Float", "traits": { - "aws.protocols#ec2QueryName": "OfferingType", - "smithy.api#documentation": "

The Reserved Instance offering type.

", - "smithy.api#xmlName": "offeringType" + "aws.protocols#ec2QueryName": "FixedPrice", + "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", + "smithy.api#xmlName": "fixedPrice" } }, - "RecurringCharges": { - "target": "com.amazonaws.ec2#RecurringChargesList", + "InstanceCount": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "RecurringCharges", - "smithy.api#documentation": "

The recurring charge tag assigned to the resource.

", - "smithy.api#xmlName": "recurringCharges" + "aws.protocols#ec2QueryName": "InstanceCount", + "smithy.api#documentation": "

The number of reservations purchased.

", + "smithy.api#xmlName": "instanceCount" } }, - "Scope": { - "target": "com.amazonaws.ec2#scope", + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", "traits": { - "aws.protocols#ec2QueryName": "Scope", - "smithy.api#documentation": "

The scope of the Reserved Instance.

", - "smithy.api#xmlName": "scope" + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The Reserved Instance product platform description.

", + "smithy.api#xmlName": "productDescription" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "State": { + "target": "com.amazonaws.ec2#ReservedInstanceState", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the resource.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The state of the Reserved Instance purchase.

", + "smithy.api#xmlName": "state" } } }, @@ -90403,62 +91028,6 @@ "com.amazonaws.ec2#ReservedInstancesOffering": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "Duration": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "Duration", - "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", - "smithy.api#xmlName": "duration" - } - }, - "FixedPrice": { - "target": "com.amazonaws.ec2#Float", - "traits": { - "aws.protocols#ec2QueryName": "FixedPrice", - "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", - "smithy.api#xmlName": "fixedPrice" - } - }, - "InstanceType": { - "target": "com.amazonaws.ec2#InstanceType", - "traits": { - "aws.protocols#ec2QueryName": "InstanceType", - "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", - "smithy.api#xmlName": "instanceType" - } - }, - "ProductDescription": { - "target": "com.amazonaws.ec2#RIProductDescription", - "traits": { - "aws.protocols#ec2QueryName": "ProductDescription", - "smithy.api#documentation": "

The Reserved Instance product platform description.

", - "smithy.api#xmlName": "productDescription" - } - }, - "ReservedInstancesOfferingId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ReservedInstancesOfferingId", - "smithy.api#documentation": "

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote \n to confirm that an exchange can be made.

", - "smithy.api#xmlName": "reservedInstancesOfferingId" - } - }, - "UsagePrice": { - "target": "com.amazonaws.ec2#Float", - "traits": { - "aws.protocols#ec2QueryName": "UsagePrice", - "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", - "smithy.api#xmlName": "usagePrice" - } - }, "CurrencyCode": { "target": "com.amazonaws.ec2#CurrencyCodeValues", "traits": { @@ -90522,6 +91091,62 @@ "smithy.api#documentation": "

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

", "smithy.api#xmlName": "scope" } + }, + "ReservedInstancesOfferingId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ReservedInstancesOfferingId", + "smithy.api#documentation": "

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote \n to confirm that an exchange can be made.

", + "smithy.api#xmlName": "reservedInstancesOfferingId" + } + }, + "InstanceType": { + "target": "com.amazonaws.ec2#InstanceType", + "traits": { + "aws.protocols#ec2QueryName": "InstanceType", + "smithy.api#documentation": "

The instance type on which the Reserved Instance can be used.

", + "smithy.api#xmlName": "instanceType" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone in which the Reserved Instance can be used.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "Duration": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "Duration", + "smithy.api#documentation": "

The duration of the Reserved Instance, in seconds.

", + "smithy.api#xmlName": "duration" + } + }, + "UsagePrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "UsagePrice", + "smithy.api#documentation": "

The usage price of the Reserved Instance, per hour.

", + "smithy.api#xmlName": "usagePrice" + } + }, + "FixedPrice": { + "target": "com.amazonaws.ec2#Float", + "traits": { + "aws.protocols#ec2QueryName": "FixedPrice", + "smithy.api#documentation": "

The purchase price of the Reserved Instance.

", + "smithy.api#xmlName": "fixedPrice" + } + }, + "ProductDescription": { + "target": "com.amazonaws.ec2#RIProductDescription", + "traits": { + "aws.protocols#ec2QueryName": "ProductDescription", + "smithy.api#documentation": "

The Reserved Instance product platform description.

", + "smithy.api#xmlName": "productDescription" + } } }, "traits": { @@ -90815,21 +91440,11 @@ "com.amazonaws.ec2#ResetInstanceAttributeRequest": { "type": "structure", "members": { - "Attribute": { - "target": "com.amazonaws.ec2#InstanceAttributeName", - "traits": { - "aws.protocols#ec2QueryName": "Attribute", - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The attribute to reset.

\n \n

You can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.

\n ", - "smithy.api#required": {}, - "smithy.api#xmlName": "attribute" - } - }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, @@ -90842,6 +91457,16 @@ "smithy.api#required": {}, "smithy.api#xmlName": "instanceId" } + }, + "Attribute": { + "target": "com.amazonaws.ec2#InstanceAttributeName", + "traits": { + "aws.protocols#ec2QueryName": "Attribute", + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The attribute to reset.

\n \n

You can only reset the following attributes: kernel |\n ramdisk | sourceDestCheck.

\n ", + "smithy.api#required": {}, + "smithy.api#xmlName": "attribute" + } } }, "traits": { @@ -91716,7 +92341,7 @@ "target": "com.amazonaws.ec2#ElasticGpuSpecificationResponseList", "traits": { "aws.protocols#ec2QueryName": "ElasticGpuSpecificationSet", - "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024. For \n workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, \n G4dn, or G5 instances.

\n ", + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Graphics reached end of life on January 8, 2024.

\n ", "smithy.api#xmlName": "elasticGpuSpecificationSet" } }, @@ -91724,7 +92349,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateElasticInferenceAcceleratorResponseList", "traits": { "aws.protocols#ec2QueryName": "ElasticInferenceAcceleratorSet", - "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance. Elastic inference\n accelerators are a resource you can attach to your Amazon EC2 instances to accelerate\n your Deep Learning (DL) inference workloads.

\n

You cannot specify accelerators from different generations in the same request.

\n \n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon\n Elastic Inference (EI), and will help current customers migrate their workloads to\n options that offer better price and performance. After April 15, 2023, new customers\n will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker,\n Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during\n the past 30-day period are considered current customers and will be able to continue\n using the service.

\n ", + "smithy.api#documentation": "

Deprecated.

\n \n

Amazon Elastic Inference is no longer available.

\n ", "smithy.api#xmlName": "elasticInferenceAcceleratorSet" } }, @@ -92354,6 +92979,13 @@ "com.amazonaws.ec2#RevokeSecurityGroupEgressRequest": { "type": "structure", "members": { + "SecurityGroupRuleIds": { + "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security group rules.

", + "smithy.api#xmlName": "SecurityGroupRuleId" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -92372,27 +93004,28 @@ "smithy.api#xmlName": "groupId" } }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", + "SourceSecurityGroupName": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "IpPermissions", - "smithy.api#documentation": "

The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.

", - "smithy.api#xmlName": "ipPermissions" + "aws.protocols#ec2QueryName": "SourceSecurityGroupName", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", + "smithy.api#xmlName": "sourceSecurityGroupName" } }, - "SecurityGroupRuleIds": { - "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "SourceSecurityGroupOwnerId": { + "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IDs of the security group rules.

", - "smithy.api#xmlName": "SecurityGroupRuleId" + "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a destination security\n group.

", + "smithy.api#xmlName": "sourceSecurityGroupOwnerId" } }, - "CidrIp": { + "IpProtocol": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "CidrIp", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", - "smithy.api#xmlName": "cidrIp" + "aws.protocols#ec2QueryName": "IpProtocol", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", + "smithy.api#xmlName": "ipProtocol" } }, "FromPort": { @@ -92403,14 +93036,6 @@ "smithy.api#xmlName": "fromPort" } }, - "IpProtocol": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "IpProtocol", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the protocol name or\n number.

", - "smithy.api#xmlName": "ipProtocol" - } - }, "ToPort": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -92419,20 +93044,20 @@ "smithy.api#xmlName": "toPort" } }, - "SourceSecurityGroupName": { + "CidrIp": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupName", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a\n destination security group.

", - "smithy.api#xmlName": "sourceSecurityGroupName" + "aws.protocols#ec2QueryName": "CidrIp", + "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify the CIDR.

", + "smithy.api#xmlName": "cidrIp" } }, - "SourceSecurityGroupOwnerId": { - "target": "com.amazonaws.ec2#String", + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", "traits": { - "aws.protocols#ec2QueryName": "SourceSecurityGroupOwnerId", - "smithy.api#documentation": "

Not supported. Use a set of IP permissions to specify a destination security\n group.

", - "smithy.api#xmlName": "sourceSecurityGroupOwnerId" + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.

", + "smithy.api#xmlName": "ipPermissions" } } }, @@ -92533,6 +93158,13 @@ "smithy.api#documentation": "

If the protocol is TCP or UDP, this is the end of the port range.\n If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes).

" } }, + "SecurityGroupRuleIds": { + "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", + "traits": { + "smithy.api#documentation": "

The IDs of the security group rules.

", + "smithy.api#xmlName": "SecurityGroupRuleId" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -92540,13 +93172,6 @@ "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.

", "smithy.api#xmlName": "dryRun" } - }, - "SecurityGroupRuleIds": { - "target": "com.amazonaws.ec2#SecurityGroupRuleIdList", - "traits": { - "smithy.api#documentation": "

The IDs of the security group rules.

", - "smithy.api#xmlName": "SecurityGroupRuleId" - } } }, "traits": { @@ -93296,79 +93921,6 @@ "smithy.api#documentation": "

The user data to make available to the instance. User data must be base64-encoded.\n Depending on the tool or SDK that you're using, the base64-encoding might be performed for you.\n For more information, see Work with instance user data.

" } }, - "AdditionalInfo": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AdditionalInfo", - "smithy.api#documentation": "

Reserved.

", - "smithy.api#xmlName": "additionalInfo" - } - }, - "ClientToken": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "ClientToken", - "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.

\n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", - "smithy.api#idempotencyToken": {}, - "smithy.api#xmlName": "clientToken" - } - }, - "DisableApiTermination": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DisableApiTermination", - "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

\n

Default: false\n

", - "smithy.api#xmlName": "disableApiTermination" - } - }, - "DryRun": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DryRun", - "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.

", - "smithy.api#xmlName": "dryRun" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "EbsOptimized", - "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", - "smithy.api#xmlName": "ebsOptimized" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", - "traits": { - "aws.protocols#ec2QueryName": "IamInstanceProfile", - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of an IAM instance\n profile.

", - "smithy.api#xmlName": "iamInstanceProfile" - } - }, - "InstanceInitiatedShutdownBehavior": { - "target": "com.amazonaws.ec2#ShutdownBehavior", - "traits": { - "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", - "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", - "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", - "traits": { - "aws.protocols#ec2QueryName": "NetworkInterface", - "smithy.api#documentation": "

The network interfaces to associate with the instance.

", - "smithy.api#xmlName": "networkInterface" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "

The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", - "smithy.api#xmlName": "privateIpAddress" - } - }, "ElasticGpuSpecification": { "target": "com.amazonaws.ec2#ElasticGpuSpecifications", "traits": { @@ -93378,7 +93930,7 @@ "ElasticInferenceAccelerators": { "target": "com.amazonaws.ec2#ElasticInferenceAccelerators", "traits": { - "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance.

\n \n

Amazon Elastic Inference (EI) is no longer available to new customers. For more\n information, see Amazon Elastic Inference FAQs.

\n ", + "smithy.api#documentation": "

An elastic inference accelerator to associate with the instance.

\n \n

Amazon Elastic Inference is no longer available.

\n ", "smithy.api#xmlName": "ElasticInferenceAccelerator" } }, @@ -93467,6 +94019,79 @@ "traits": { "smithy.api#documentation": "

If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable\n assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address\n associated with an ENI that you have enabled to use a primary IPv6 address. Use this\n option if an instance relies on its IPv6 address not changing. When you launch the\n instance, Amazon Web Services will automatically assign an IPv6 address associated with\n the ENI attached to your instance to be the primary IPv6 address. Once you enable an\n IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6\n GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6\n address until the instance is terminated or the network interface is detached. If you\n have multiple IPv6 addresses associated with an ENI attached to your instance and you\n enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI\n becomes the primary IPv6 address.

" } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DryRun", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "smithy.api#xmlName": "dryRun" + } + }, + "DisableApiTermination": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DisableApiTermination", + "smithy.api#documentation": "

If you set this parameter to true, you can't terminate the instance using\n the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after\n launch, use ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate, you can\n terminate the instance by running the shutdown command from the instance.

\n

Default: false\n

", + "smithy.api#xmlName": "disableApiTermination" + } + }, + "InstanceInitiatedShutdownBehavior": { + "target": "com.amazonaws.ec2#ShutdownBehavior", + "traits": { + "aws.protocols#ec2QueryName": "InstanceInitiatedShutdownBehavior", + "smithy.api#documentation": "

Indicates whether an instance stops or terminates when you initiate shutdown from the\n instance (using the operating system command for system shutdown).

\n

Default: stop\n

", + "smithy.api#xmlName": "instanceInitiatedShutdownBehavior" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PrivateIpAddress", + "smithy.api#documentation": "

The primary IPv4 address. You must specify a value from the IPv4 address\n range of the subnet.

\n

Only one private IP address can be designated as primary. You can't specify this\n option if you've specified the option to designate a private IP address as the primary\n IP address in a network interface specification. You cannot specify this option if\n you're launching more than one instance in the request.

\n

You cannot specify this option and the network interfaces option in the same\n request.

", + "smithy.api#xmlName": "privateIpAddress" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "

Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you do not specify a client token, a randomly generated token is used for\n the request to ensure idempotency.

\n

For more information, see Ensuring\n Idempotency.

\n

Constraints: Maximum 64 ASCII characters

", + "smithy.api#idempotencyToken": {}, + "smithy.api#xmlName": "clientToken" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AdditionalInfo", + "smithy.api#documentation": "

Reserved.

", + "smithy.api#xmlName": "additionalInfo" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.ec2#InstanceNetworkInterfaceSpecificationList", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterface", + "smithy.api#documentation": "

The network interfaces to associate with the instance.

", + "smithy.api#xmlName": "networkInterface" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.ec2#IamInstanceProfileSpecification", + "traits": { + "aws.protocols#ec2QueryName": "IamInstanceProfile", + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of an IAM instance\n profile.

", + "smithy.api#xmlName": "iamInstanceProfile" + } + }, + "EbsOptimized": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EbsOptimized", + "smithy.api#documentation": "

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized configuration stack to\n provide optimal Amazon EBS I/O performance. This optimization isn't available with all\n instance types. Additional usage charges apply when using an EBS-optimized\n instance.

\n

Default: false\n

", + "smithy.api#xmlName": "ebsOptimized" + } } }, "traits": { @@ -94636,38 +95261,6 @@ "com.amazonaws.ec2#SecurityGroup": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupDescription", - "smithy.api#documentation": "

A description of the security group.

", - "smithy.api#xmlName": "groupDescription" - } - }, - "GroupName": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "GroupName", - "smithy.api#documentation": "

The name of the security group.

", - "smithy.api#xmlName": "groupName" - } - }, - "IpPermissions": { - "target": "com.amazonaws.ec2#IpPermissionList", - "traits": { - "aws.protocols#ec2QueryName": "IpPermissions", - "smithy.api#documentation": "

The inbound rules associated with the security group.

", - "smithy.api#xmlName": "ipPermissions" - } - }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the security group.

", - "smithy.api#xmlName": "ownerId" - } - }, "GroupId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -94699,6 +95292,38 @@ "smithy.api#documentation": "

The ID of the VPC for the security group.

", "smithy.api#xmlName": "vpcId" } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The Amazon Web Services account ID of the owner of the security group.

", + "smithy.api#xmlName": "ownerId" + } + }, + "GroupName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupName", + "smithy.api#documentation": "

The name of the security group.

", + "smithy.api#xmlName": "groupName" + } + }, + "Description": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupDescription", + "smithy.api#documentation": "

A description of the security group.

", + "smithy.api#xmlName": "groupDescription" + } + }, + "IpPermissions": { + "target": "com.amazonaws.ec2#IpPermissionList", + "traits": { + "aws.protocols#ec2QueryName": "IpPermissions", + "smithy.api#documentation": "

The inbound rules associated with the security group.

", + "smithy.api#xmlName": "ipPermissions" + } } }, "traits": { @@ -95218,7 +95843,7 @@ "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.

" + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } } }, @@ -95676,52 +96301,52 @@ "com.amazonaws.ec2#Snapshot": { "type": "structure", "members": { - "DataEncryptionKeyId": { + "OwnerAlias": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "DataEncryptionKeyId", - "smithy.api#documentation": "

The data encryption key identifier for the snapshot. This value is a unique identifier\n that corresponds to the data encryption key that was used to encrypt the original volume or\n snapshot copy. Because data encryption keys are inherited by volumes created from snapshots,\n and vice versa, if snapshots share the same data encryption key identifier, then they belong\n to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

", - "smithy.api#xmlName": "dataEncryptionKeyId" + "aws.protocols#ec2QueryName": "OwnerAlias", + "smithy.api#documentation": "

The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not \n the user-configured Amazon Web Services account alias set using the IAM console.

", + "smithy.api#xmlName": "ownerAlias" } }, - "Description": { + "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Description", - "smithy.api#documentation": "

The description for the snapshot.

", - "smithy.api#xmlName": "description" + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon EBS User Guide.

", + "smithy.api#xmlName": "outpostArn" } }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", + "Tags": { + "target": "com.amazonaws.ec2#TagList", "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", - "smithy.api#xmlName": "encrypted" + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the snapshot.

", + "smithy.api#xmlName": "tagSet" } }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", + "StorageTier": { + "target": "com.amazonaws.ec2#StorageTier", "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that was used to protect the\n volume encryption key for the parent volume.

", - "smithy.api#xmlName": "kmsKeyId" + "aws.protocols#ec2QueryName": "StorageTier", + "smithy.api#documentation": "

The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.

", + "smithy.api#xmlName": "storageTier" } }, - "OwnerId": { - "target": "com.amazonaws.ec2#String", + "RestoreExpiryTime": { + "target": "com.amazonaws.ec2#MillisecondDateTime", "traits": { - "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the EBS snapshot.

", - "smithy.api#xmlName": "ownerId" + "aws.protocols#ec2QueryName": "RestoreExpiryTime", + "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", + "smithy.api#xmlName": "restoreExpiryTime" } }, - "Progress": { - "target": "com.amazonaws.ec2#String", + "SseType": { + "target": "com.amazonaws.ec2#SSEType", "traits": { - "aws.protocols#ec2QueryName": "Progress", - "smithy.api#documentation": "

The progress of the snapshot, as a percentage.

", - "smithy.api#xmlName": "progress" + "aws.protocols#ec2QueryName": "SseType", + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#xmlName": "sseType" } }, "SnapshotId": { @@ -95732,12 +96357,12 @@ "smithy.api#xmlName": "snapshotId" } }, - "StartTime": { - "target": "com.amazonaws.ec2#DateTime", + "VolumeId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "StartTime", - "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", - "smithy.api#xmlName": "startTime" + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any\n purpose.

", + "smithy.api#xmlName": "volumeId" } }, "State": { @@ -95756,68 +96381,68 @@ "smithy.api#xmlName": "statusMessage" } }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", + "StartTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any\n purpose.

", - "smithy.api#xmlName": "volumeId" + "aws.protocols#ec2QueryName": "StartTime", + "smithy.api#documentation": "

The time stamp when the snapshot was initiated.

", + "smithy.api#xmlName": "startTime" } }, - "VolumeSize": { - "target": "com.amazonaws.ec2#Integer", + "Progress": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "VolumeSize", - "smithy.api#documentation": "

The size of the volume, in GiB.

", - "smithy.api#xmlName": "volumeSize" + "aws.protocols#ec2QueryName": "Progress", + "smithy.api#documentation": "

The progress of the snapshot, as a percentage.

", + "smithy.api#xmlName": "progress" } }, - "OwnerAlias": { + "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OwnerAlias", - "smithy.api#documentation": "

The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not \n the user-configured Amazon Web Services account alias set using the IAM console.

", - "smithy.api#xmlName": "ownerAlias" + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the EBS snapshot.

", + "smithy.api#xmlName": "ownerId" } }, - "OutpostArn": { + "Description": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "OutpostArn", - "smithy.api#documentation": "

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the \n \t\tAmazon EBS User Guide.

", - "smithy.api#xmlName": "outpostArn" + "aws.protocols#ec2QueryName": "Description", + "smithy.api#documentation": "

The description for the snapshot.

", + "smithy.api#xmlName": "description" } }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", + "VolumeSize": { + "target": "com.amazonaws.ec2#Integer", "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the snapshot.

", - "smithy.api#xmlName": "tagSet" + "aws.protocols#ec2QueryName": "VolumeSize", + "smithy.api#documentation": "

The size of the volume, in GiB.

", + "smithy.api#xmlName": "volumeSize" } }, - "StorageTier": { - "target": "com.amazonaws.ec2#StorageTier", + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", "traits": { - "aws.protocols#ec2QueryName": "StorageTier", - "smithy.api#documentation": "

The storage tier in which the snapshot is stored. standard indicates \n that the snapshot is stored in the standard snapshot storage tier and that it is ready \n for use. archive indicates that the snapshot is currently archived and that \n it must be restored before it can be used.

", - "smithy.api#xmlName": "storageTier" + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the snapshot is encrypted.

", + "smithy.api#xmlName": "encrypted" } }, - "RestoreExpiryTime": { - "target": "com.amazonaws.ec2#MillisecondDateTime", + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "RestoreExpiryTime", - "smithy.api#documentation": "

Only for archived snapshots that are temporarily restored. Indicates the date and \n time when a temporarily restored snapshot will be automatically re-archived.

", - "smithy.api#xmlName": "restoreExpiryTime" + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that was used to protect the\n volume encryption key for the parent volume.

", + "smithy.api#xmlName": "kmsKeyId" } }, - "SseType": { - "target": "com.amazonaws.ec2#SSEType", + "DataEncryptionKeyId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "SseType", - "smithy.api#documentation": "

Reserved for future use.

", - "smithy.api#xmlName": "sseType" + "aws.protocols#ec2QueryName": "DataEncryptionKeyId", + "smithy.api#documentation": "

The data encryption key identifier for the snapshot. This value is a unique identifier\n that corresponds to the data encryption key that was used to encrypt the original volume or\n snapshot copy. Because data encryption keys are inherited by volumes created from snapshots,\n and vice versa, if snapshots share the same data encryption key identifier, then they belong\n to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

", + "smithy.api#xmlName": "dataEncryptionKeyId" } } }, @@ -96530,14 +97155,6 @@ "com.amazonaws.ec2#SpotFleetLaunchSpecification": { "type": "structure", "members": { - "SecurityGroups": { - "target": "com.amazonaws.ec2#GroupIdentifierList", - "traits": { - "aws.protocols#ec2QueryName": "GroupSet", - "smithy.api#documentation": "

The security groups.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.

", - "smithy.api#xmlName": "groupSet" - } - }, "AddressingType": { "target": "com.amazonaws.ec2#String", "traits": { @@ -96681,6 +97298,14 @@ "smithy.api#documentation": "

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will\n identify instance types with those attributes.

\n \n

If you specify InstanceRequirements, you can't specify\n InstanceType.

\n ", "smithy.api#xmlName": "instanceRequirements" } + }, + "SecurityGroups": { + "target": "com.amazonaws.ec2#GroupIdentifierList", + "traits": { + "aws.protocols#ec2QueryName": "GroupSet", + "smithy.api#documentation": "

The security groups.

\n

If you specify a network interface, you must specify any security groups as part of\n the network interface instead of using this parameter.

", + "smithy.api#xmlName": "groupSet" + } } }, "traits": { @@ -97889,7 +98514,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } } @@ -98338,7 +98963,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } }, @@ -98520,14 +99145,6 @@ "com.amazonaws.ec2#Subnet": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone of the subnet.

", - "smithy.api#xmlName": "availabilityZone" - } - }, "AvailabilityZoneId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -98536,30 +99153,6 @@ "smithy.api#xmlName": "availabilityZoneId" } }, - "AvailableIpAddressCount": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "AvailableIpAddressCount", - "smithy.api#documentation": "

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any\n\t\t\tstopped instances are considered unavailable.

", - "smithy.api#xmlName": "availableIpAddressCount" - } - }, - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The IPv4 CIDR block assigned to the subnet.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "DefaultForAz": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "DefaultForAz", - "smithy.api#documentation": "

Indicates whether this is the default subnet for the Availability Zone.

", - "smithy.api#xmlName": "defaultForAz" - } - }, "EnableLniAtDeviceIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -98568,14 +99161,6 @@ "smithy.api#xmlName": "enableLniAtDeviceIndex" } }, - "MapPublicIpOnLaunch": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "MapPublicIpOnLaunch", - "smithy.api#documentation": "

Indicates whether instances launched in this subnet receive a public IPv4 address.

\n

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

", - "smithy.api#xmlName": "mapPublicIpOnLaunch" - } - }, "MapCustomerOwnedIpOnLaunch": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -98592,30 +99177,6 @@ "smithy.api#xmlName": "customerOwnedIpv4Pool" } }, - "State": { - "target": "com.amazonaws.ec2#SubnetState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the subnet.

", - "smithy.api#xmlName": "state" - } - }, - "SubnetId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SubnetId", - "smithy.api#documentation": "

The ID of the subnet.

", - "smithy.api#xmlName": "subnetId" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC the subnet is in.

", - "smithy.api#xmlName": "vpcId" - } - }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -98687,6 +99248,70 @@ "smithy.api#documentation": "

The type of hostnames to assign to instances in the subnet at launch. An instance hostname\n is based on the IPv4 address or ID of the instance.

", "smithy.api#xmlName": "privateDnsNameOptionsOnLaunch" } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "

The ID of the subnet.

", + "smithy.api#xmlName": "subnetId" + } + }, + "State": { + "target": "com.amazonaws.ec2#SubnetState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the subnet.

", + "smithy.api#xmlName": "state" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC the subnet is in.

", + "smithy.api#xmlName": "vpcId" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The IPv4 CIDR block assigned to the subnet.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "AvailableIpAddressCount": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "AvailableIpAddressCount", + "smithy.api#documentation": "

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any\n\t\t\tstopped instances are considered unavailable.

", + "smithy.api#xmlName": "availableIpAddressCount" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone of the subnet.

", + "smithy.api#xmlName": "availabilityZone" + } + }, + "DefaultForAz": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "DefaultForAz", + "smithy.api#documentation": "

Indicates whether this is the default subnet for the Availability Zone.

", + "smithy.api#xmlName": "defaultForAz" + } + }, + "MapPublicIpOnLaunch": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "MapPublicIpOnLaunch", + "smithy.api#documentation": "

Indicates whether instances launched in this subnet receive a public IPv4 address.

\n

Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses \nassociated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.

", + "smithy.api#xmlName": "mapPublicIpOnLaunch" + } } }, "traits": { @@ -99852,7 +100477,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } } @@ -102131,7 +102756,7 @@ "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", "traits": { "aws.protocols#ec2QueryName": "SecurityGroupReferencingSupport", - "smithy.api#documentation": "\n

This parameter is in preview and may not be available for your account.

\n \n

Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

", + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.\n\n

\n

This option is disabled by default.

", "smithy.api#xmlName": "securityGroupReferencingSupport" } }, @@ -102782,7 +103407,7 @@ "SecurityGroupReferencingSupport": { "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", "traits": { - "smithy.api#documentation": "\n

This parameter is in preview and may not be available for your account.

\n \n

Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

" + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.\n\n

\n

This option is disabled by default.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

" } }, "MulticastSupport": { @@ -103567,7 +104192,7 @@ "target": "com.amazonaws.ec2#SecurityGroupReferencingSupportValue", "traits": { "aws.protocols#ec2QueryName": "SecurityGroupReferencingSupport", - "smithy.api#documentation": "\n

This parameter is in preview and may not be available for your account.

\n \n

Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

", + "smithy.api#documentation": "

Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.

\n

This option is enabled by default.

\n

For more information about security group referencing, see Security group referencing in the Amazon Web Services Transit Gateways Guide.

", "smithy.api#xmlName": "securityGroupReferencingSupport" } }, @@ -103928,14 +104553,6 @@ "com.amazonaws.ec2#UnassignIpv6AddressesRequest": { "type": "structure", "members": { - "Ipv6Addresses": { - "target": "com.amazonaws.ec2#Ipv6AddressList", - "traits": { - "aws.protocols#ec2QueryName": "Ipv6Addresses", - "smithy.api#documentation": "

The IPv6 addresses to unassign from the network interface.

", - "smithy.api#xmlName": "ipv6Addresses" - } - }, "Ipv6Prefixes": { "target": "com.amazonaws.ec2#IpPrefixList", "traits": { @@ -103952,6 +104569,14 @@ "smithy.api#required": {}, "smithy.api#xmlName": "networkInterfaceId" } + }, + "Ipv6Addresses": { + "target": "com.amazonaws.ec2#Ipv6AddressList", + "traits": { + "aws.protocols#ec2QueryName": "Ipv6Addresses", + "smithy.api#documentation": "

The IPv6 addresses to unassign from the network interface.

", + "smithy.api#xmlName": "ipv6Addresses" + } } }, "traits": { @@ -104017,6 +104642,13 @@ "com.amazonaws.ec2#UnassignPrivateIpAddressesRequest": { "type": "structure", "members": { + "Ipv4Prefixes": { + "target": "com.amazonaws.ec2#IpPrefixList", + "traits": { + "smithy.api#documentation": "

The IPv4 prefixes to unassign from the network interface.

", + "smithy.api#xmlName": "Ipv4Prefix" + } + }, "NetworkInterfaceId": { "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { @@ -104034,13 +104666,6 @@ "smithy.api#documentation": "

The secondary private IP addresses to unassign from the network interface. You can specify this \n \toption multiple times to unassign more than one IP address.

", "smithy.api#xmlName": "privateIpAddress" } - }, - "Ipv4Prefixes": { - "target": "com.amazonaws.ec2#IpPrefixList", - "traits": { - "smithy.api#documentation": "

The IPv4 prefixes to unassign from the network interface.

", - "smithy.api#xmlName": "Ipv4Prefix" - } } }, "traits": { @@ -104057,7 +104682,7 @@ "target": "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressResult" }, "traits": { - "smithy.api#documentation": "

Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide.

\n

While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

A private IP address will only be released at the end of MaxDrainDurationSeconds. The\n private IP addresses stay associated and support the existing connections, but do not\n support any new connections (new connections are distributed across the remaining\n assigned private IP address). After the existing connections drain out, the private IP\n addresses are released.

\n

\n

" + "smithy.api#documentation": "

Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, \n see Edit secondary IP address associations \n in the Amazon VPC User Guide.

\n

While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.

\n

A private IP address will only be released at the end of MaxDrainDurationSeconds. The\n private IP addresses stay associated and support the existing connections, but do not\n support any new connections (new connections are distributed across the remaining\n assigned private IP address). After the existing connections drain out, the private IP\n addresses are released.

\n

\n

" } }, "com.amazonaws.ec2#UnassignPrivateNatGatewayAddressRequest": { @@ -104228,7 +104853,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "DryRun", - "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.

", + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "smithy.api#xmlName": "dryRun" } } @@ -104698,12 +105323,12 @@ "smithy.api#xmlName": "description" } }, - "GroupId": { + "UserId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "GroupId", - "smithy.api#documentation": "

The ID of the security group.

", - "smithy.api#xmlName": "groupId" + "aws.protocols#ec2QueryName": "UserId", + "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

", + "smithy.api#xmlName": "userId" } }, "GroupName": { @@ -104714,20 +105339,12 @@ "smithy.api#xmlName": "groupName" } }, - "PeeringStatus": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "PeeringStatus", - "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", - "smithy.api#xmlName": "peeringStatus" - } - }, - "UserId": { + "GroupId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "UserId", - "smithy.api#documentation": "

The ID of an Amazon Web Services account.

\n

For a referenced security group in another VPC, the account ID of the referenced\n security group is returned in the response. If the referenced security group is deleted,\n this value is not returned.

", - "smithy.api#xmlName": "userId" + "aws.protocols#ec2QueryName": "GroupId", + "smithy.api#documentation": "

The ID of the security group.

", + "smithy.api#xmlName": "groupId" } }, "VpcId": { @@ -104745,6 +105362,14 @@ "smithy.api#documentation": "

The ID of the VPC peering connection, if applicable.

", "smithy.api#xmlName": "vpcPeeringConnectionId" } + }, + "PeeringStatus": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeeringStatus", + "smithy.api#documentation": "

The status of a VPC peering connection, if applicable.

", + "smithy.api#xmlName": "peeringStatus" + } } }, "traits": { @@ -106230,46 +106855,6 @@ "com.amazonaws.ec2#Volume": { "type": "structure", "members": { - "Attachments": { - "target": "com.amazonaws.ec2#VolumeAttachmentList", - "traits": { - "aws.protocols#ec2QueryName": "AttachmentSet", - "smithy.api#documentation": "\n

This parameter is not returned by CreateVolume.

\n \n

Information about the volume attachments.

", - "smithy.api#xmlName": "attachmentSet" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone for the volume.

", - "smithy.api#xmlName": "availabilityZone" - } - }, - "CreateTime": { - "target": "com.amazonaws.ec2#DateTime", - "traits": { - "aws.protocols#ec2QueryName": "CreateTime", - "smithy.api#documentation": "

The time stamp when volume creation was initiated.

", - "smithy.api#xmlName": "createTime" - } - }, - "Encrypted": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "Encrypted", - "smithy.api#documentation": "

Indicates whether the volume is encrypted.

", - "smithy.api#xmlName": "encrypted" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that was used to protect the\n volume encryption key for the volume.

", - "smithy.api#xmlName": "kmsKeyId" - } - }, "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { @@ -106278,38 +106863,6 @@ "smithy.api#xmlName": "outpostArn" } }, - "Size": { - "target": "com.amazonaws.ec2#Integer", - "traits": { - "aws.protocols#ec2QueryName": "Size", - "smithy.api#documentation": "

The size of the volume, in GiBs.

", - "smithy.api#xmlName": "size" - } - }, - "SnapshotId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "SnapshotId", - "smithy.api#documentation": "

The snapshot from which the volume was created, if applicable.

", - "smithy.api#xmlName": "snapshotId" - } - }, - "State": { - "target": "com.amazonaws.ec2#VolumeState", - "traits": { - "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The volume state.

", - "smithy.api#xmlName": "status" - } - }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#xmlName": "volumeId" - } - }, "Iops": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -106365,55 +106918,87 @@ "smithy.api#documentation": "\n

This parameter is not returned by CreateVolume.

\n \n

Reserved for future use.

", "smithy.api#xmlName": "sseType" } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a volume.

" - } - }, - "com.amazonaws.ec2#VolumeAttachment": { - "type": "structure", - "members": { - "AttachTime": { - "target": "com.amazonaws.ec2#DateTime", + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AttachTime", - "smithy.api#documentation": "

The time stamp when the attachment initiated.

", - "smithy.api#xmlName": "attachTime" + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" } }, - "Device": { + "Size": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Size", + "smithy.api#documentation": "

The size of the volume, in GiBs.

", + "smithy.api#xmlName": "size" + } + }, + "SnapshotId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "Device", - "smithy.api#documentation": "

The device name.

\n

If the volume is attached to a Fargate task, this parameter \n returns null.

", - "smithy.api#xmlName": "device" + "aws.protocols#ec2QueryName": "SnapshotId", + "smithy.api#documentation": "

The snapshot from which the volume was created, if applicable.

", + "smithy.api#xmlName": "snapshotId" } }, - "InstanceId": { + "AvailabilityZone": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "InstanceId", - "smithy.api#documentation": "

The ID of the instance.

\n

If the volume is attached to a Fargate task, this parameter \n returns null.

", - "smithy.api#xmlName": "instanceId" + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone for the volume.

", + "smithy.api#xmlName": "availabilityZone" } }, "State": { - "target": "com.amazonaws.ec2#VolumeAttachmentState", + "target": "com.amazonaws.ec2#VolumeState", "traits": { "aws.protocols#ec2QueryName": "Status", - "smithy.api#documentation": "

The attachment state of the volume.

", + "smithy.api#documentation": "

The volume state.

", "smithy.api#xmlName": "status" } }, - "VolumeId": { - "target": "com.amazonaws.ec2#String", + "CreateTime": { + "target": "com.amazonaws.ec2#DateTime", "traits": { - "aws.protocols#ec2QueryName": "VolumeId", - "smithy.api#documentation": "

The ID of the volume.

", - "smithy.api#xmlName": "volumeId" + "aws.protocols#ec2QueryName": "CreateTime", + "smithy.api#documentation": "

The time stamp when volume creation was initiated.

", + "smithy.api#xmlName": "createTime" + } + }, + "Attachments": { + "target": "com.amazonaws.ec2#VolumeAttachmentList", + "traits": { + "aws.protocols#ec2QueryName": "AttachmentSet", + "smithy.api#documentation": "\n

This parameter is not returned by CreateVolume.

\n \n

Information about the volume attachments.

", + "smithy.api#xmlName": "attachmentSet" + } + }, + "Encrypted": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Encrypted", + "smithy.api#documentation": "

Indicates whether the volume is encrypted.

", + "smithy.api#xmlName": "encrypted" } }, + "KmsKeyId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "KmsKeyId", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key that was used to protect the\n volume encryption key for the volume.

", + "smithy.api#xmlName": "kmsKeyId" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a volume.

" + } + }, + "com.amazonaws.ec2#VolumeAttachment": { + "type": "structure", + "members": { "DeleteOnTermination": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -106437,6 +107022,46 @@ "smithy.api#documentation": "

The service principal of Amazon Web Services service that owns the underlying \n instance to which the volume is attached.

\n

This parameter is returned only for volumes that are attached to \n Fargate tasks.

", "smithy.api#xmlName": "instanceOwningService" } + }, + "VolumeId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VolumeId", + "smithy.api#documentation": "

The ID of the volume.

", + "smithy.api#xmlName": "volumeId" + } + }, + "InstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "InstanceId", + "smithy.api#documentation": "

The ID of the instance.

\n

If the volume is attached to a Fargate task, this parameter \n returns null.

", + "smithy.api#xmlName": "instanceId" + } + }, + "Device": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "Device", + "smithy.api#documentation": "

The device name.

\n

If the volume is attached to a Fargate task, this parameter \n returns null.

", + "smithy.api#xmlName": "device" + } + }, + "State": { + "target": "com.amazonaws.ec2#VolumeAttachmentState", + "traits": { + "aws.protocols#ec2QueryName": "Status", + "smithy.api#documentation": "

The attachment state of the volume.

", + "smithy.api#xmlName": "status" + } + }, + "AttachTime": { + "target": "com.amazonaws.ec2#DateTime", + "traits": { + "aws.protocols#ec2QueryName": "AttachTime", + "smithy.api#documentation": "

The time stamp when the attachment initiated.

", + "smithy.api#xmlName": "attachTime" + } } }, "traits": { @@ -107128,38 +107753,6 @@ "com.amazonaws.ec2#Vpc": { "type": "structure", "members": { - "CidrBlock": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CidrBlock", - "smithy.api#documentation": "

The primary IPv4 CIDR block for the VPC.

", - "smithy.api#xmlName": "cidrBlock" - } - }, - "DhcpOptionsId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "DhcpOptionsId", - "smithy.api#documentation": "

The ID of the set of DHCP options you've associated with the VPC.

", - "smithy.api#xmlName": "dhcpOptionsId" - } - }, - "State": { - "target": "com.amazonaws.ec2#VpcState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the VPC.

", - "smithy.api#xmlName": "state" - } - }, - "VpcId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpcId", - "smithy.api#documentation": "

The ID of the VPC.

", - "smithy.api#xmlName": "vpcId" - } - }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -107207,6 +107800,38 @@ "smithy.api#documentation": "

Any tags assigned to the VPC.

", "smithy.api#xmlName": "tagSet" } + }, + "VpcId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "

The ID of the VPC.

", + "smithy.api#xmlName": "vpcId" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpcState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the VPC.

", + "smithy.api#xmlName": "state" + } + }, + "CidrBlock": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CidrBlock", + "smithy.api#documentation": "

The primary IPv4 CIDR block for the VPC.

", + "smithy.api#xmlName": "cidrBlock" + } + }, + "DhcpOptionsId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DhcpOptionsId", + "smithy.api#documentation": "

The ID of the set of DHCP options you've associated with the VPC.

", + "smithy.api#xmlName": "dhcpOptionsId" + } } }, "traits": { @@ -107216,14 +107841,6 @@ "com.amazonaws.ec2#VpcAttachment": { "type": "structure", "members": { - "State": { - "target": "com.amazonaws.ec2#AttachmentStatus", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the attachment.

", - "smithy.api#xmlName": "state" - } - }, "VpcId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -107231,6 +107848,14 @@ "smithy.api#documentation": "

The ID of the VPC.

", "smithy.api#xmlName": "vpcId" } + }, + "State": { + "target": "com.amazonaws.ec2#AttachmentStatus", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the attachment.

", + "smithy.api#xmlName": "state" + } } }, "traits": { @@ -108163,22 +108788,6 @@ "com.amazonaws.ec2#VpnConnection": { "type": "structure", "members": { - "CustomerGatewayConfiguration": { - "target": "com.amazonaws.ec2#customerGatewayConfiguration", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewayConfiguration", - "smithy.api#documentation": "

The configuration information for the VPN connection's customer gateway (in the native\n XML format). This element is always present in the CreateVpnConnection\n response; however, it's present in the DescribeVpnConnections response\n only if the VPN connection is in the pending or available\n state.

", - "smithy.api#xmlName": "customerGatewayConfiguration" - } - }, - "CustomerGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "CustomerGatewayId", - "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

", - "smithy.api#xmlName": "customerGatewayId" - } - }, "Category": { "target": "com.amazonaws.ec2#String", "traits": { @@ -108187,38 +108796,6 @@ "smithy.api#xmlName": "category" } }, - "State": { - "target": "com.amazonaws.ec2#VpnState", - "traits": { - "aws.protocols#ec2QueryName": "State", - "smithy.api#documentation": "

The current state of the VPN connection.

", - "smithy.api#xmlName": "state" - } - }, - "Type": { - "target": "com.amazonaws.ec2#GatewayType", - "traits": { - "aws.protocols#ec2QueryName": "Type", - "smithy.api#documentation": "

The type of VPN connection.

", - "smithy.api#xmlName": "type" - } - }, - "VpnConnectionId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpnConnectionId", - "smithy.api#documentation": "

The ID of the VPN connection.

", - "smithy.api#xmlName": "vpnConnectionId" - } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpnGatewayId", - "smithy.api#documentation": "

The ID of the virtual private gateway at the Amazon Web Services side of the VPN\n connection.

", - "smithy.api#xmlName": "vpnGatewayId" - } - }, "TransitGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -108282,6 +108859,54 @@ "smithy.api#documentation": "

Information about the VPN tunnel.

", "smithy.api#xmlName": "vgwTelemetry" } + }, + "VpnConnectionId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnConnectionId", + "smithy.api#documentation": "

The ID of the VPN connection.

", + "smithy.api#xmlName": "vpnConnectionId" + } + }, + "State": { + "target": "com.amazonaws.ec2#VpnState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "

The current state of the VPN connection.

", + "smithy.api#xmlName": "state" + } + }, + "CustomerGatewayConfiguration": { + "target": "com.amazonaws.ec2#customerGatewayConfiguration", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayConfiguration", + "smithy.api#documentation": "

The configuration information for the VPN connection's customer gateway (in the native\n XML format). This element is always present in the CreateVpnConnection\n response; however, it's present in the DescribeVpnConnections response\n only if the VPN connection is in the pending or available\n state.

", + "smithy.api#xmlName": "customerGatewayConfiguration" + } + }, + "Type": { + "target": "com.amazonaws.ec2#GatewayType", + "traits": { + "aws.protocols#ec2QueryName": "Type", + "smithy.api#documentation": "

The type of VPN connection.

", + "smithy.api#xmlName": "type" + } + }, + "CustomerGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerGatewayId", + "smithy.api#documentation": "

The ID of the customer gateway at your end of the VPN connection.

", + "smithy.api#xmlName": "customerGatewayId" + } + }, + "VpnGatewayId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway at the Amazon Web Services side of the VPN\n connection.

", + "smithy.api#xmlName": "vpnGatewayId" + } } }, "traits": { @@ -108464,14 +109089,6 @@ "smithy.api#documentation": "

Indicate whether to enable acceleration for the VPN connection.

\n

Default: false\n

" } }, - "StaticRoutesOnly": { - "target": "com.amazonaws.ec2#Boolean", - "traits": { - "aws.protocols#ec2QueryName": "StaticRoutesOnly", - "smithy.api#documentation": "

Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.

\n

Default: false\n

", - "smithy.api#xmlName": "staticRoutesOnly" - } - }, "TunnelInsideIpVersion": { "target": "com.amazonaws.ec2#TunnelInsideIpVersion", "traits": { @@ -108519,6 +109136,14 @@ "traits": { "smithy.api#documentation": "

The transit gateway attachment ID to use for the VPN tunnel.

\n

Required if OutsideIpAddressType is set to PrivateIpv4.

" } + }, + "StaticRoutesOnly": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "StaticRoutesOnly", + "smithy.api#documentation": "

Indicate whether the VPN connection uses static routes only. If you are creating a VPN\n connection for a device that does not support BGP, you must specify true.\n Use CreateVpnConnectionRoute to create a static route.

\n

Default: false\n

", + "smithy.api#xmlName": "staticRoutesOnly" + } } }, "traits": { @@ -108545,12 +109170,28 @@ "com.amazonaws.ec2#VpnGateway": { "type": "structure", "members": { - "AvailabilityZone": { + "AmazonSideAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "AmazonSideAsn", + "smithy.api#documentation": "

The private Autonomous System Number (ASN) for the Amazon side of a BGP\n session.

", + "smithy.api#xmlName": "amazonSideAsn" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "

Any tags assigned to the virtual private gateway.

", + "smithy.api#xmlName": "tagSet" + } + }, + "VpnGatewayId": { "target": "com.amazonaws.ec2#String", "traits": { - "aws.protocols#ec2QueryName": "AvailabilityZone", - "smithy.api#documentation": "

The Availability Zone where the virtual private gateway was created, if applicable.\n This field may be empty or not returned.

", - "smithy.api#xmlName": "availabilityZone" + "aws.protocols#ec2QueryName": "VpnGatewayId", + "smithy.api#documentation": "

The ID of the virtual private gateway.

", + "smithy.api#xmlName": "vpnGatewayId" } }, "State": { @@ -108569,6 +109210,14 @@ "smithy.api#xmlName": "type" } }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "

The Availability Zone where the virtual private gateway was created, if applicable.\n This field may be empty or not returned.

", + "smithy.api#xmlName": "availabilityZone" + } + }, "VpcAttachments": { "target": "com.amazonaws.ec2#VpcAttachmentList", "traits": { @@ -108576,30 +109225,6 @@ "smithy.api#documentation": "

Any VPCs attached to the virtual private gateway.

", "smithy.api#xmlName": "attachments" } - }, - "VpnGatewayId": { - "target": "com.amazonaws.ec2#String", - "traits": { - "aws.protocols#ec2QueryName": "VpnGatewayId", - "smithy.api#documentation": "

The ID of the virtual private gateway.

", - "smithy.api#xmlName": "vpnGatewayId" - } - }, - "AmazonSideAsn": { - "target": "com.amazonaws.ec2#Long", - "traits": { - "aws.protocols#ec2QueryName": "AmazonSideAsn", - "smithy.api#documentation": "

The private Autonomous System Number (ASN) for the Amazon side of a BGP\n session.

", - "smithy.api#xmlName": "amazonSideAsn" - } - }, - "Tags": { - "target": "com.amazonaws.ec2#TagList", - "traits": { - "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

Any tags assigned to the virtual private gateway.

", - "smithy.api#xmlName": "tagSet" - } } }, "traits": { diff --git a/codegen/sdk/aws-models/ecs.json b/codegen/sdk/aws-models/ecs.json index 22284c4de10..e74b96748e8 100644 --- a/codegen/sdk/aws-models/ecs.json +++ b/codegen/sdk/aws-models/ecs.json @@ -1681,7 +1681,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTaskor CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateClusterCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.

\n

With FARGATE_SPOT, you can run interruption tolerant tasks at a rate\n\t\t\tthat's discounted compared to the FARGATE price. FARGATE_SPOT\n\t\t\truns tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are\n\t\t\tinterrupted with a two-minute warning. FARGATE_SPOT only supports Linux\n\t\t\ttasks with the X86_64 architecture on platform version 1.3.0 or later.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" + "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTaskor CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateClusterCapacityProvider API operation.

\n

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.

\n

With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's\n\t\t\tdiscounted compared to the FARGATE price. FARGATE_SPOT runs\n\t\t\ttasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are\n\t\t\tinterrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks\n\t\t\twith the X86_64 architecture on platform version 1.3.0 or later.\n\t\t\t\tFARGATE_SPOT supports Linux tasks with the ARM64 architecture on\n\t\t\tplatform version 1.4.0 or later.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "com.amazonaws.ecs#CapacityProviderStrategyItemBase": { @@ -3136,7 +3136,7 @@ } ], "traits": { - "smithy.api#documentation": "

Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, use UpdateService.

\n \n

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

\n \n

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

\n

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. volumeConfigurations is only supported for REPLICA\n\t\t\tservice and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

\n

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.

\n

There are two service scheduler strategies available:

\n
    \n
  • \n

    \n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

    \n
    • \n
  • \n

    \n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

    \n
    • \n
\n

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

\n

When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide\n

\n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

", + "smithy.api#documentation": "

Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, use UpdateService.

\n \n

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

\n \n \n

Amazon Elastic Inference (EI) is no longer available to customers.

\n \n

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

\n

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. volumeConfigurations is only supported for REPLICA\n\t\t\tservice and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

\n

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and are reported as\n\t\t\thealthy by the load balancer.

\n

There are two service scheduler strategies available:

\n
    \n
  • \n

    \n REPLICA - The replica scheduling strategy places and\n\t\t\t\t\tmaintains your desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

    \n
    • \n
  • \n

    \n DAEMON - The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks. It also stops tasks\n\t\t\t\t\tthat don't meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

    \n
    • \n
\n

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

\n

When the service scheduler launches new tasks, it determines task placement. For\n\t\t\tinformation about task placement and task placement strategies, see Amazon ECS\n\t\t\t\ttask placement in the Amazon Elastic Container Service Developer Guide\n

", "smithy.api#examples": [ { "title": "To create a new service", @@ -7809,7 +7809,7 @@ "options": { "target": "com.amazonaws.ecs#LogConfigurationOptionsMap", "traits": { - "smithy.api#documentation": "

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

" + "smithy.api#documentation": "

The configuration options to send to the log driver.

\n

The options you can specify depend on the log driver. Some\n\t\t\t\tof the options you can specify when you use the awslogs log driver to route logs to\n\t\t\t\tAmazon CloudWatch include the following:

\n
\n
awslogs-create-group
\n
\n

Required: No

\n

Specify whether you want the log group to be\n\t\t\t\t\t\t\tcreated automatically. If this option isn't\n\t\t\t\t\t\t\tspecified, it defaults to\n\t\t\t\t\t\t\tfalse.

\n \n

Your IAM policy must include the\n\t\t\t\t\t\t\t\tlogs:CreateLogGroup permission before\n\t\t\t\t\t\t\t\tyou attempt to use\n\t\t\t\t\t\t\t\tawslogs-create-group.

\n \n
\n
awslogs-region
\n
\n

Required: Yes

\n

Specify the Amazon Web Services Region that the\n\t\t\t\t\t\t\tawslogs log driver is to send your\n\t\t\t\t\t\t\tDocker logs to. You can choose to send all of your\n\t\t\t\t\t\t\tlogs from clusters in different Regions to a\n\t\t\t\t\t\t\tsingle region in CloudWatch Logs. This is so that they're\n\t\t\t\t\t\t\tall visible in one location. Otherwise, you can\n\t\t\t\t\t\t\tseparate them by Region for more granularity. Make\n\t\t\t\t\t\t\tsure that the specified log group exists in the\n\t\t\t\t\t\t\tRegion that you specify with this option.

\n
\n
awslogs-group
\n
\n

Required: Yes

\n

Make sure to specify a log group that the\n\t\t\t\t\t\t\tawslogs log driver sends its log\n\t\t\t\t\t\t\tstreams to.

\n
\n
awslogs-stream-prefix
\n
\n

Required: Yes, when\n\t\t\t\t\t\t\tusing the Fargate launch\n\t\t\t\t\t\t\ttype.Optional for\n\t\t\t\t\t\t\t\tthe EC2 launch type, required for\n\t\t\t\t\t\t\t\tthe Fargate launch\n\t\t\t\t\t\t\t\ttype.

\n

Use the awslogs-stream-prefix\n\t\t\t\t\t\t\toption to associate a log stream with the\n\t\t\t\t\t\t\tspecified prefix, the container name, and the ID\n\t\t\t\t\t\t\tof the Amazon ECS task that the container belongs to.\n\t\t\t\t\t\t\tIf you specify a prefix with this option, then the\n\t\t\t\t\t\t\tlog stream takes the format prefix-name/container-name/ecs-task-id.

\n

If you don't specify a prefix\n\t\t\t\t\t\t\twith this option, then the log stream is named\n\t\t\t\t\t\t\tafter the container ID that's assigned by the\n\t\t\t\t\t\t\tDocker daemon on the container instance. Because\n\t\t\t\t\t\t\tit's difficult to trace logs back to the container\n\t\t\t\t\t\t\tthat sent them with just the Docker container ID\n\t\t\t\t\t\t\t(which is only available on the container\n\t\t\t\t\t\t\tinstance), we recommend that you specify a prefix\n\t\t\t\t\t\t\twith this option.

\n

For Amazon ECS services, you can use the service\n\t\t\t\t\t\t\tname as the prefix. Doing so, you can trace log\n\t\t\t\t\t\t\tstreams to the service that the container belongs\n\t\t\t\t\t\t\tto, the name of the container that sent them, and\n\t\t\t\t\t\t\tthe ID of the task that the container belongs\n\t\t\t\t\t\t\tto.

\n

You must specify a\n\t\t\t\t\t\t\tstream-prefix for your logs to have your logs\n\t\t\t\t\t\t\tappear in the Log pane when using the Amazon ECS\n\t\t\t\t\t\t\tconsole.

\n
\n
awslogs-datetime-format
\n
\n

Required: No

\n

This option defines a multiline start pattern\n\t\t\t\t\t\t\tin Python strftime format. A log\n\t\t\t\t\t\t\tmessage consists of a line that matches the\n\t\t\t\t\t\t\tpattern and any following lines that don’t match\n\t\t\t\t\t\t\tthe pattern. The matched line is the delimiter\n\t\t\t\t\t\t\tbetween log messages.

\n

One example of a use case for using this\n\t\t\t\t\t\t\tformat is for parsing output such as a stack dump,\n\t\t\t\t\t\t\twhich might otherwise be logged in multiple\n\t\t\t\t\t\t\tentries. The correct pattern allows it to be\n\t\t\t\t\t\t\tcaptured in a single entry.

\n

For more information, see awslogs-datetime-format.

\n

You cannot configure both the\n\t\t\t\t\t\t\tawslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern\n\t\t\t\t\t\t\toptions.

\n \n

Multiline logging performs regular\n\t\t\t\t\t\t\t\texpression parsing and matching of all log\n\t\t\t\t\t\t\t\tmessages. This might have a negative impact on\n\t\t\t\t\t\t\t\tlogging performance.

\n \n
\n
awslogs-multiline-pattern
\n
\n

Required: No

\n

This option defines a multiline start pattern\n\t\t\t\t\t\t\tthat uses a regular expression. A log message\n\t\t\t\t\t\t\tconsists of a line that matches the pattern and\n\t\t\t\t\t\t\tany following lines that don’t match the pattern.\n\t\t\t\t\t\t\tThe matched line is the delimiter between log\n\t\t\t\t\t\t\tmessages.

\n

For more information, see awslogs-multiline-pattern.

\n

This option is ignored if\n\t\t\t\t\t\t\tawslogs-datetime-format is also\n\t\t\t\t\t\t\tconfigured.

\n

You cannot configure both the\n\t\t\t\t\t\t\tawslogs-datetime-format and\n\t\t\t\t\t\t\tawslogs-multiline-pattern\n\t\t\t\t\t\t\toptions.

\n \n

Multiline logging performs regular\n\t\t\t\t\t\t\t\texpression parsing and matching of all log\n\t\t\t\t\t\t\t\tmessages. This might have a negative impact on\n\t\t\t\t\t\t\t\tlogging performance.

\n \n
\n
mode
\n
\n

Required: No

\n

Valid values: non-blocking |\n\t\t\t\t\t\t\tblocking\n

\n

This option defines the delivery mode of log\n\t\t\t\t\t\t\tmessages from the container to CloudWatch Logs. The delivery\n\t\t\t\t\t\t\tmode you choose affects application availability\n\t\t\t\t\t\t\twhen the flow of logs from container to CloudWatch is\n\t\t\t\t\t\t\tinterrupted.

\n

If you use the blocking\n\t\t\t\t\t\t\tmode and the flow of logs to CloudWatch is interrupted,\n\t\t\t\t\t\t\tcalls from container code to write to the\n\t\t\t\t\t\t\tstdout and stderr\n\t\t\t\t\t\t\tstreams will block. The logging thread of the\n\t\t\t\t\t\t\tapplication will block as a result. This may cause\n\t\t\t\t\t\t\tthe application to become unresponsive and lead to\n\t\t\t\t\t\t\tcontainer healthcheck failure.

\n

If you use the non-blocking mode,\n\t\t\t\t\t\t\tthe container's logs are instead stored in an\n\t\t\t\t\t\t\tin-memory intermediate buffer configured with the\n\t\t\t\t\t\t\tmax-buffer-size option. This prevents\n\t\t\t\t\t\t\tthe application from becoming unresponsive when\n\t\t\t\t\t\t\tlogs cannot be sent to CloudWatch. We recommend using this mode if you want to\n\t\t\t\t\t\t\tensure service availability and are okay with some\n\t\t\t\t\t\t\tlog loss. For more information, see Preventing log loss with non-blocking mode in the awslogs container log driver.

\n
\n
max-buffer-size
\n
\n

Required: No

\n

Default value: 1m\n

\n

When non-blocking mode is used,\n\t\t\t\t\t\t\tthe max-buffer-size log option\n\t\t\t\t\t\t\tcontrols the size of the buffer that's used for\n\t\t\t\t\t\t\tintermediate message storage. Make sure to specify\n\t\t\t\t\t\t\tan adequate buffer size based on your application.\n\t\t\t\t\t\t\tWhen the buffer fills up, further logs cannot be\n\t\t\t\t\t\t\tstored. Logs that cannot be stored are lost.\n\t\t\t\t\t\t

\n
\n
\n

To route logs using the splunk log router, you need to specify a\n\t\t\t\tsplunk-token and a\n\t\t\t\tsplunk-url.

\n

When you use the awsfirelens log router to route logs to an Amazon Web Services Service or\n\t\t\t\tAmazon Web Services Partner Network destination for log storage and analytics, you can\n\t\t\t\tset the log-driver-buffer-limit option to limit\n\t\t\t\tthe number of events that are buffered in memory, before\n\t\t\t\tbeing sent to the log router container. It can help to\n\t\t\t\tresolve potential log loss issue because high throughput\n\t\t\t\tmight result in memory running out for the buffer inside of\n\t\t\t\tDocker.

\n

Other options you can specify when using awsfirelens to route\n\t\t\t\tlogs depend on the destination. When you export logs to\n\t\t\t\tAmazon Data Firehose, you can specify the Amazon Web Services Region with\n\t\t\t\tregion and a name for the log stream with\n\t\t\t\tdelivery_stream.

\n

When you export logs to\n\t\t\t\tAmazon Kinesis Data Streams, you can specify an Amazon Web Services Region with\n\t\t\t\tregion and a data stream name with\n\t\t\t\tstream.

\n

When you export logs to Amazon OpenSearch Service,\n\t\t\t\tyou can specify options like Name,\n\t\t\t\tHost (OpenSearch Service endpoint without protocol), Port,\n\t\t\t\tIndex, Type,\n\t\t\t\tAws_auth, Aws_region, Suppress_Type_Name, and\n\t\t\t\ttls.

\n

When you export logs to Amazon S3, you can\n\t\t\t\t\tspecify the bucket using the bucket option. You can also specify region,\n\t\t\t\t\ttotal_file_size, upload_timeout,\n\t\t\t\t\tand use_put_object as options.

\n

This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

" } }, "secretOptions": { @@ -9518,7 +9518,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new task using the specified task definition.

\n \n

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

\n \n

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

\n

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

\n

The Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.

\n

To manage eventual consistency, you can do the following:

\n
    \n
  • \n

    Confirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.

    \n
    • \n
  • \n

    Add wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.

    \n
    • \n
", + "smithy.api#documentation": "

Starts a new task using the specified task definition.

\n \n

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

\n \n \n

Amazon Elastic Inference (EI) is no longer available to customers.

\n \n

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

\n

The Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.

\n

To manage eventual consistency, you can do the following:

\n
    \n
  • \n

    Confirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.

    \n
    • \n
  • \n

    Add wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.

    \n
    • \n
", "smithy.api#examples": [ { "title": "To run a task on your default cluster", @@ -9643,7 +9643,7 @@ "referenceId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The reference ID to use for the task. The reference ID can have a maximum length of\n\t\t\t1024 characters.

" + "smithy.api#documentation": "

This parameter is only used by Amazon ECS. It is not intended for use by customers.

" } }, "startedBy": { @@ -10632,7 +10632,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.

\n \n

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

\n \n

Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

\n

Alternatively, you can useRunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.

\n \n

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

\n \n \n

Amazon Elastic Inference (EI) is no longer available to customers.

\n \n

Alternatively, you can useRunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

\n

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#StartTaskRequest": { @@ -10692,13 +10692,13 @@ "referenceId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The reference ID to use for the task.

" + "smithy.api#documentation": "

This parameter is only used by Amazon ECS. It is not intended for use by customers.

" } }, "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call with\n\t\t\tthe startedBy value. Up to 36 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.

\n

If a task is started by an Amazon ECS service, the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" + "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically trigger\n\t\t\ta task to run a batch process job, you could apply a unique identifier for that job to\n\t\t\tyour task with the startedBy parameter. You can then identify which tasks\n\t\t\tbelong to that job by filtering the results of a ListTasks call with\n\t\t\tthe startedBy value. Up to 36 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.

\n

If a task is started by an Amazon ECS service, the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" } }, "tags": { diff --git a/codegen/sdk/aws-models/eks.json b/codegen/sdk/aws-models/eks.json index c699f3042d4..dde6bd03465 100644 --- a/codegen/sdk/aws-models/eks.json +++ b/codegen/sdk/aws-models/eks.json @@ -2571,6 +2571,12 @@ "traits": { "smithy.api#documentation": "

This value indicates if extended support is enabled or disabled for the cluster.

\n

\n Learn more about EKS Extended Support in the EKS User Guide.\n

" } + }, + "zonalShiftConfig": { + "target": "com.amazonaws.eks#ZonalShiftConfigResponse", + "traits": { + "smithy.api#documentation": "

The configuration for zonal shift for the cluster.

" + } } }, "traits": { @@ -3277,7 +3283,7 @@ "name": { "target": "com.amazonaws.eks#ClusterName", "traits": { - "smithy.api#documentation": "

The unique name to give to your cluster.

", + "smithy.api#documentation": "

The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive),\nhyphens, and underscores. It must start with an alphanumeric character and can't be longer than\n100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're \ncreating the cluster in.

", "smithy.api#required": {} } }, @@ -3355,6 +3361,12 @@ "traits": { "smithy.api#documentation": "

New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

" } + }, + "zonalShiftConfig": { + "target": "com.amazonaws.eks#ZonalShiftConfigRequest", + "traits": { + "smithy.api#documentation": "

Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services\n configures zonal autoshift for the cluster.

\n

Zonal shift is a feature of\n Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move\n traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel\n it. You can extend the zonal shift if necessary.

\n

You can start a zonal shift for an EKS cluster, or you can allow Amazon Web Services to do it for you\n by enabling zonal autoshift. This shift updates the flow of\n east-to-west network traffic in your cluster to only consider network endpoints for Pods\n running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress\n traffic for applications in your EKS cluster will automatically route traffic to targets in\n the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC)\n Zonal Shift in Amazon EKS in the\n \n Amazon EKS User Guide\n .

" + } } }, "traits": { @@ -9998,7 +10010,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an Amazon EKS cluster configuration. Your cluster continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your cluster update with DescribeUpdate\"/>.

\n

You can use this API operation to enable or disable exporting the Kubernetes control plane\n logs for your cluster to CloudWatch Logs. By default, cluster control plane logs\n aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n \n

You can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

\n

You can also use this API operation to choose different subnets and security groups\n for the cluster. You must specify at least two subnets that are in different\n Availability Zones. You can't change which VPC the subnets are from, the subnets must be\n in the same VPC as the subnets that the cluster was created with. For more information\n about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the \n Amazon EKS User Guide\n .

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

", + "smithy.api#documentation": "

Updates an Amazon EKS cluster configuration. Your cluster continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your cluster update with DescribeUpdate\"/>.

\n

You can use this API operation to enable or disable exporting the Kubernetes control plane\n logs for your cluster to CloudWatch Logs. By default, cluster control plane logs\n aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .

\n \n

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.

\n \n

You can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .

\n

You can also use this API operation to choose different subnets and security groups\n for the cluster. You must specify at least two subnets that are in different\n Availability Zones. You can't change which VPC the subnets are from, the subnets must be\n in the same VPC as the subnets that the cluster was created with. For more information\n about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the \n Amazon EKS User Guide\n .

\n

You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services\n configures zonal autoshift for the cluster.

\n

Cluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{name}/update-config", @@ -10044,6 +10056,12 @@ "traits": { "smithy.api#documentation": "

You can enable or disable extended support for clusters currently on standard support. You cannot disable extended support once it starts. You must enable extended support before your cluster exits standard support.

" } + }, + "zonalShiftConfig": { + "target": "com.amazonaws.eks#ZonalShiftConfigRequest", + "traits": { + "smithy.api#documentation": "

Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services\n configures zonal autoshift for the cluster.

\n

Zonal shift is a feature of\n Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move\n traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel\n it. You can extend the zonal shift if necessary.

\n

You can start a zonal shift for an EKS cluster, or you can allow Amazon Web Services to do it for you\n by enabling zonal autoshift. This shift updates the flow of\n east-to-west network traffic in your cluster to only consider network endpoints for Pods\n running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress\n traffic for applications in your EKS cluster will automatically route traffic to targets in\n the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC)\n Zonal Shift in Amazon EKS in the\n \n Amazon EKS User Guide\n .

" + } } }, "traits": { @@ -10644,6 +10662,12 @@ "traits": { "smithy.api#enumValue": "UpgradePolicy" } + }, + "ZONAL_SHIFT_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZonalShiftConfig" + } } } }, @@ -10852,6 +10876,12 @@ "traits": { "smithy.api#enumValue": "UpgradePolicyUpdate" } + }, + "ZONAL_SHIFT_CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ZonalShiftConfigUpdate" + } } } }, @@ -10981,6 +11011,34 @@ } } }, + "com.amazonaws.eks#ZonalShiftConfigRequest": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for zonal shift for the cluster.

" + } + }, + "com.amazonaws.eks#ZonalShiftConfigResponse": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

Whether the zonal shift is enabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The status of zonal shift configuration for the cluster

" + } + }, "com.amazonaws.eks#configStatus": { "type": "enum", "members": { diff --git a/codegen/sdk/aws-models/elastic-inference.json b/codegen/sdk/aws-models/elastic-inference.json index f63dd5feb64..234a6311006 100644 --- a/codegen/sdk/aws-models/elastic-inference.json +++ b/codegen/sdk/aws-models/elastic-inference.json @@ -200,7 +200,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Describes the locations in which a given accelerator type or set of types is present in a given region.\n

\n

\n February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.\n After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.\n However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.\n

", + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Describes the locations in which a given accelerator type or set of types is present in a given region.\n

", "smithy.api#http": { "method": "POST", "uri": "/describe-accelerator-offerings", @@ -257,7 +257,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.\n

\n

\n February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.\n After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.\n However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.\n

", + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput.\n

", "smithy.api#http": { "method": "GET", "uri": "/describe-accelerator-types", @@ -306,7 +306,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Describes information over a provided set of accelerators belonging to an account.\n

\n

\n February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.\n After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.\n However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.\n

", + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Describes information over a provided set of accelerators belonging to an account.\n

", "smithy.api#http": { "method": "POST", "uri": "/describe-accelerators", @@ -408,7 +408,7 @@ "name": "elastic-inference" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

\n Elastic Inference public APIs.\n

\n

\n February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.\n After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.\n However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.\n

", + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Elastic Inference public APIs.\n

", "smithy.api#title": "Amazon Elastic Inference", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1278,7 +1278,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Returns all tags of an Elastic Inference Accelerator.\n

\n

\n February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.\n After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.\n However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.\n

", + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Returns all tags of an Elastic Inference Accelerator.\n

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -1488,7 +1488,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Adds the specified tags to an Elastic Inference Accelerator.\n

\n

\n February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.\n After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.\n However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.\n

", + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Adds the specified tags to an Elastic Inference Accelerator.\n

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -1571,7 +1571,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Removes the specified tags from an Elastic Inference Accelerator.\n

\n

\n February 15, 2023: Starting April 15, 2023, AWS will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance.\n After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2.\n However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.\n

", + "smithy.api#documentation": "\n

Amazon Elastic Inference is no longer available.

\n \n

\n Removes the specified tags from an Elastic Inference Accelerator.\n

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", diff --git a/codegen/sdk/aws-models/elastic-load-balancing-v2.json b/codegen/sdk/aws-models/elastic-load-balancing-v2.json index 53343909290..6f295674914 100644 --- a/codegen/sdk/aws-models/elastic-load-balancing-v2.json +++ b/codegen/sdk/aws-models/elastic-load-balancing-v2.json @@ -364,6 +364,32 @@ "smithy.api#output": {} } }, + "com.amazonaws.elasticloadbalancingv2#AdministrativeOverride": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetAdministrativeOverrideStateEnum", + "traits": { + "smithy.api#documentation": "

The state of the override.

" + } + }, + "Reason": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetAdministrativeOverrideReasonEnum", + "traits": { + "smithy.api#documentation": "

The reason code for the state.

" + } + }, + "Description": { + "target": "com.amazonaws.elasticloadbalancingv2#Description", + "traits": { + "smithy.api#documentation": "

A description of the override state that provides additional details.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the override status applied to a target.

" + } + }, "com.amazonaws.elasticloadbalancingv2#AllocationId": { "type": "string" }, @@ -5884,7 +5910,7 @@ "Key": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeKey", "traits": { - "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by all load balancers:

\n
    \n
  • \n

    \n deletion_protection.enabled - Indicates whether deletion protection is\n enabled. The value is true or false. The default is\n false.

    \n
    • \n
  • \n

    \n load_balancing.cross_zone.enabled - Indicates whether cross-zone load\n balancing is enabled. The possible values are true and false.\n The default for Network Load Balancers and Gateway Load Balancers is false. \n The default for Application Load Balancers is true, and cannot be changed.

    \n
    • \n
\n

The following attributes are supported by both Application Load Balancers and Network Load\n Balancers:

\n
    \n
  • \n

    \n access_logs.s3.enabled - Indicates whether access logs are enabled. The\n value is true or false. The default is\n false.

    \n
    • \n
  • \n

    \n access_logs.s3.bucket - The name of the S3 bucket for the access logs.\n This attribute is required if access logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.

    \n
    • \n
  • \n

    \n access_logs.s3.prefix - The prefix for the location in the S3 bucket for the\n access logs.

    \n
    • \n
  • \n

    \n ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the\n load balancer. It is set to false for internet-facing load balancers and\n true for internal load balancers, preventing unintended access to your\n internal load balancer through an internet gateway.

    \n
    • \n
\n

The following attributes are supported by only Application Load Balancers:

\n
    \n
  • \n

    \n idle_timeout.timeout_seconds - The idle timeout value, in seconds. The\n valid range is 1-4000 seconds. The default is 60 seconds.

    \n
    • \n
  • \n

    \n client_keep_alive.seconds - The client keep alive value, in seconds. The \n valid range is 60-604800 seconds. The default is 3600 seconds.

    \n
    • \n
  • \n

    \n connection_logs.s3.enabled - Indicates whether connection logs are enabled. The\n value is true or false. The default is false.

    \n
    • \n
  • \n

    \n connection_logs.s3.bucket - The name of the S3 bucket for the connection logs.\n This attribute is required if connection logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.

    \n
    • \n
  • \n

    \n connection_logs.s3.prefix - The prefix for the location in the S3 bucket for the\n connection logs.

    \n
    • \n
  • \n

    \n routing.http.desync_mitigation_mode - Determines how the load balancer\n handles requests that might pose a security risk to your application. The possible values\n are monitor, defensive, and strictest. The default\n is defensive.

    \n
    • \n
  • \n

    \n routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP\n headers with invalid header fields are removed by the load balancer (true) or\n routed to targets (false). The default is false.

    \n
    • \n
  • \n

    \n routing.http.preserve_host_header.enabled - Indicates whether the\n Application Load Balancer should preserve the Host header in the HTTP request\n and send it to the target without any change. The possible values are true\n and false. The default is false.

    \n
    • \n
  • \n

    \n routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates\n whether the two headers (x-amzn-tls-version and\n x-amzn-tls-cipher-suite), which contain information about the negotiated\n TLS version and cipher suite, are added to the client request before sending it to the\n target. The x-amzn-tls-version header has information about the TLS protocol\n version negotiated with the client, and the x-amzn-tls-cipher-suite header\n has information about the cipher suite negotiated with the client. Both headers are in\n OpenSSL format. The possible values for the attribute are true and\n false. The default is false.

    \n
    • \n
  • \n

    \n routing.http.xff_client_port.enabled - Indicates whether the\n X-Forwarded-For header should preserve the source port that the client used\n to connect to the load balancer. The possible values are true and\n false. The default is false.

    \n
    • \n
  • \n

    \n routing.http.xff_header_processing.mode - Enables you to modify,\n preserve, or remove the X-Forwarded-For header in the HTTP request before the\n Application Load Balancer sends the request to the target. The possible values are\n append, preserve, and remove. The default is\n append.

    \n
      \n
    • \n

      If the value is append, the Application Load Balancer adds the client\n IP address (of the last hop) to the X-Forwarded-For header in the HTTP\n request before it sends it to targets.

      \n
      • \n
    • \n

      If the value is preserve the Application Load Balancer preserves the\n X-Forwarded-For header in the HTTP request, and sends it to targets\n without any change.

      \n
      • \n
    • \n

      If the value is remove, the Application Load Balancer removes the\n X-Forwarded-For header in the HTTP request before it sends it to\n targets.

      \n
      • \n
    \n
    • \n
  • \n

    \n routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible\n values are true and false. The default is true.\n Elastic Load Balancing requires that message header names contain only alphanumeric\n characters and hyphens.

    \n
    • \n
  • \n

    \n waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load\n balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The\n default is false.

    \n
    • \n
\n

The following attributes are supported by only Network Load Balancers:

\n
    \n
  • \n

    \n dns_record.client_routing_policy - Indicates how traffic is \n distributed among the load balancer Availability Zones. The possible values are \n availability_zone_affinity with 100 percent zonal affinity, \n partial_availability_zone_affinity with 85 percent zonal affinity, \n and any_availability_zone with 0 percent zonal affinity.

    \n
    • \n
" + "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by all load balancers:

\n
    \n
  • \n

    \n deletion_protection.enabled - Indicates whether deletion protection is\n enabled. The value is true or false. The default is\n false.

    \n
    • \n
  • \n

    \n load_balancing.cross_zone.enabled - Indicates whether cross-zone load\n balancing is enabled. The possible values are true and false.\n The default for Network Load Balancers and Gateway Load Balancers is false. \n The default for Application Load Balancers is true, and cannot be changed.

    \n
    • \n
\n

The following attributes are supported by both Application Load Balancers and Network Load\n Balancers:

\n
    \n
  • \n

    \n access_logs.s3.enabled - Indicates whether access logs are enabled. The\n value is true or false. The default is\n false.

    \n
    • \n
  • \n

    \n access_logs.s3.bucket - The name of the S3 bucket for the access logs.\n This attribute is required if access logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.

    \n
    • \n
  • \n

    \n access_logs.s3.prefix - The prefix for the location in the S3 bucket for the\n access logs.

    \n
    • \n
  • \n

    \n ipv6.deny_all_igw_traffic - Blocks internet gateway (IGW) access to the\n load balancer. It is set to false for internet-facing load balancers and\n true for internal load balancers, preventing unintended access to your\n internal load balancer through an internet gateway.

    \n
    • \n
\n

The following attributes are supported by only Application Load Balancers:

\n
    \n
  • \n

    \n idle_timeout.timeout_seconds - The idle timeout value, in seconds. The\n valid range is 1-4000 seconds. The default is 60 seconds.

    \n
    • \n
  • \n

    \n client_keep_alive.seconds - The client keep alive value, in seconds. The \n valid range is 60-604800 seconds. The default is 3600 seconds.

    \n
    • \n
  • \n

    \n connection_logs.s3.enabled - Indicates whether connection logs are enabled. The\n value is true or false. The default is false.

    \n
    • \n
  • \n

    \n connection_logs.s3.bucket - The name of the S3 bucket for the connection logs.\n This attribute is required if connection logs are enabled. The bucket must exist in the same\n region as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.

    \n
    • \n
  • \n

    \n connection_logs.s3.prefix - The prefix for the location in the S3 bucket for the\n connection logs.

    \n
    • \n
  • \n

    \n routing.http.desync_mitigation_mode - Determines how the load balancer\n handles requests that might pose a security risk to your application. The possible values\n are monitor, defensive, and strictest. The default\n is defensive.

    \n
    • \n
  • \n

    \n routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP\n headers with invalid header fields are removed by the load balancer (true) or\n routed to targets (false). The default is false.

    \n
    • \n
  • \n

    \n routing.http.preserve_host_header.enabled - Indicates whether the\n Application Load Balancer should preserve the Host header in the HTTP request\n and send it to the target without any change. The possible values are true\n and false. The default is false.

    \n
    • \n
  • \n

    \n routing.http.x_amzn_tls_version_and_cipher_suite.enabled - Indicates\n whether the two headers (x-amzn-tls-version and\n x-amzn-tls-cipher-suite), which contain information about the negotiated\n TLS version and cipher suite, are added to the client request before sending it to the\n target. The x-amzn-tls-version header has information about the TLS protocol\n version negotiated with the client, and the x-amzn-tls-cipher-suite header\n has information about the cipher suite negotiated with the client. Both headers are in\n OpenSSL format. The possible values for the attribute are true and\n false. The default is false.

    \n
    • \n
  • \n

    \n routing.http.xff_client_port.enabled - Indicates whether the\n X-Forwarded-For header should preserve the source port that the client used\n to connect to the load balancer. The possible values are true and\n false. The default is false.

    \n
    • \n
  • \n

    \n routing.http.xff_header_processing.mode - Enables you to modify,\n preserve, or remove the X-Forwarded-For header in the HTTP request before the\n Application Load Balancer sends the request to the target. The possible values are\n append, preserve, and remove. The default is\n append.

    \n
      \n
    • \n

      If the value is append, the Application Load Balancer adds the client\n IP address (of the last hop) to the X-Forwarded-For header in the HTTP\n request before it sends it to targets.

      \n
      • \n
    • \n

      If the value is preserve the Application Load Balancer preserves the\n X-Forwarded-For header in the HTTP request, and sends it to targets\n without any change.

      \n
      • \n
    • \n

      If the value is remove, the Application Load Balancer removes the\n X-Forwarded-For header in the HTTP request before it sends it to\n targets.

      \n
      • \n
    \n
    • \n
  • \n

    \n routing.http2.enabled - Indicates whether HTTP/2 is enabled. The possible\n values are true and false. The default is true.\n Elastic Load Balancing requires that message header names contain only alphanumeric\n characters and hyphens.

    \n
    • \n
  • \n

    \n waf.fail_open.enabled - Indicates whether to allow a WAF-enabled load\n balancer to route requests to targets if it is unable to forward the request to Amazon Web Services WAF. The possible values are true and false. The\n default is false.

    \n
    • \n
\n

The following attributes are supported by only Network Load Balancers:

\n
    \n
  • \n

    \n dns_record.client_routing_policy - Indicates how traffic is \n distributed among the load balancer Availability Zones. The possible values are \n availability_zone_affinity with 100 percent zonal affinity, \n partial_availability_zone_affinity with 85 percent zonal affinity, \n and any_availability_zone with 0 percent zonal affinity.

    \n
    • \n
  • \n

    \n zonal_shift.config.enabled - Indicates whether zonal shift is \n enabled. The possible values are true and false. The \n default is false.

    \n
    • \n
" } }, "Value": { @@ -8486,6 +8512,64 @@ "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, + "com.amazonaws.elasticloadbalancingv2#TargetAdministrativeOverrideReasonEnum": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AdministrativeOverride.Unknown" + } + }, + "NO_OVERRIDE_ENGAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AdministrativeOverride.NoOverride" + } + }, + "ZONAL_SHIFT_ENGAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AdministrativeOverride.ZonalShiftActive" + } + }, + "ZONAL_SHIFT_DELEGATED_TO_DNS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AdministrativeOverride.ZonalShiftDelegatedToDns" + } + } + } + }, + "com.amazonaws.elasticloadbalancingv2#TargetAdministrativeOverrideStateEnum": { + "type": "enum", + "members": { + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown" + } + }, + "NO_OVERRIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no_override" + } + }, + "ZONAL_SHIFT_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zonal_shift_active" + } + }, + "ZONAL_SHIFT_DELEGATED_TO_DNS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zonal_shift_delegated_to_dns" + } + } + } + }, "com.amazonaws.elasticloadbalancingv2#TargetDescription": { "type": "structure", "members": { @@ -8857,6 +8941,12 @@ "traits": { "smithy.api#documentation": "

The anomaly detection result for the target.

\n

If no anomalies were detected, the result is normal.

\n

If anomalies were detected, the result is anomalous.

" } + }, + "AdministrativeOverride": { + "target": "com.amazonaws.elasticloadbalancingv2#AdministrativeOverride", + "traits": { + "smithy.api#documentation": "

The administrative override information for the target.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/elasticache.json b/codegen/sdk/aws-models/elasticache.json index c6cea8493a3..cb2b8e9e0c8 100644 --- a/codegen/sdk/aws-models/elasticache.json +++ b/codegen/sdk/aws-models/elasticache.json @@ -203,13 +203,13 @@ "ScaleUpModifications": { "target": "com.amazonaws.elasticache#NodeTypeList", "traits": { - "smithy.api#documentation": "

A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group.

\n

When scaling up a Redis OSS cluster or replication group using\n ModifyCacheCluster or ModifyReplicationGroup, use a value\n from this list for the CacheNodeType parameter.

" + "smithy.api#documentation": "

A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group.

\n

When scaling up a Valkey or Redis OSS cluster or replication group using\n ModifyCacheCluster or ModifyReplicationGroup, use a value\n from this list for the CacheNodeType parameter.

" } }, "ScaleDownModifications": { "target": "com.amazonaws.elasticache#NodeTypeList", "traits": { - "smithy.api#documentation": "

A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group. When scaling down a Redis OSS cluster or\n replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from\n this list for the CacheNodeType parameter.

" + "smithy.api#documentation": "

A string list, each element of which specifies a cache node type which you can use to\n scale your cluster or replication group. When scaling down a Valkey or Redis OSS cluster or\n replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from\n this list for the CacheNodeType parameter.

" } } }, @@ -1886,7 +1886,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the cluster.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "Engine": { @@ -1910,7 +1910,7 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of cache nodes in the cluster.

\n

For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" + "smithy.api#documentation": "

The number of cache nodes in the cluster.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" } }, "PreferredAvailabilityZone": { @@ -1973,7 +1973,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

 If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + "smithy.api#documentation": "

 If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" } }, "SecurityGroups": { @@ -2003,7 +2003,7 @@ "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Redis OSS \n commands.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.

\n

Default: false\n

" } }, "AuthTokenLastModifiedDate": { @@ -2045,13 +2045,13 @@ "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } }, "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "

The network type associated with the cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

The network type associated with the cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } }, "TransitEncryptionMode": { @@ -2262,7 +2262,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis OSS.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

Represents an individual cache node within a cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached, Valkey or Redis OSS.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "com.amazonaws.elasticache#CacheNodeIdsList": { @@ -2342,7 +2342,7 @@ } }, "traits": { - "smithy.api#documentation": "

A parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis OSS cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.

" + "smithy.api#documentation": "

A parameter that has a different value for each cache node type it is applied to. For\n example, in a Valkey or Redis OSS cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.

" } }, "com.amazonaws.elasticache#CacheNodeTypeSpecificParametersList": { @@ -2826,7 +2826,7 @@ "SupportedNetworkTypes": { "target": "com.amazonaws.elasticache#NetworkTypeList", "traits": { - "smithy.api#documentation": "

Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } } }, @@ -3109,7 +3109,7 @@ "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The 4-digit id for the node group you are configuring. For Redis OSS (cluster mode\n disabled) replication groups, the node group id is always 0001. To find a Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's\n Id.

", + "smithy.api#documentation": "

The 4-digit id for the node group you are configuring. For Valkey or Redis OSS (cluster mode\n disabled) replication groups, the node group id is always 0001. To find a Valkey or Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's\n Id.

", "smithy.api#required": {} } }, @@ -3117,14 +3117,14 @@ "target": "com.amazonaws.elasticache#Integer", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The number of replicas you want in this node group at the end of this operation.\n The maximum value for NewReplicaCount is 5. The minimum value depends upon\n the type of Redis OSS replication group you are working with.

\n

The minimum number of replicas in a shard or replication group is:

\n
    \n
  • \n

    Redis OSS (cluster mode disabled)

    \n
      \n
    • \n

      If Multi-AZ: 1

      \n
      • \n
    • \n

      If Multi-AZ: 0

      \n
      • \n
    \n
    • \n
  • \n

    Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)

    \n
    • \n
", + "smithy.api#documentation": "

The number of replicas you want in this node group at the end of this operation.\n The maximum value for NewReplicaCount is 5. The minimum value depends upon\n the type of Valkey or Redis OSS replication group you are working with.

\n

The minimum number of replicas in a shard or replication group is:

\n
    \n
  • \n

    Valkey or Redis OSS (cluster mode disabled)

    \n
      \n
    • \n

      If Multi-AZ: 1

      \n
      • \n
    • \n

      If Multi-AZ: 0

      \n
      • \n
    \n
    • \n
  • \n

    Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)

    \n
    • \n
", "smithy.api#required": {} } }, "PreferredAvailabilityZones": { "target": "com.amazonaws.elasticache#PreferredAvailabilityZoneList", "traits": { - "smithy.api#documentation": "

A list of PreferredAvailabilityZone strings that specify which\n availability zones the replication group's nodes are to be in. The nummber of\n PreferredAvailabilityZone values must equal the value of\n NewReplicaCount plus 1 to account for the primary node. If this member\n of ReplicaConfiguration is omitted, ElastiCache (Redis OSS) selects the\n availability zone for each of the replicas.

" + "smithy.api#documentation": "

A list of PreferredAvailabilityZone strings that specify which\n availability zones the replication group's nodes are to be in. The nummber of\n PreferredAvailabilityZone values must equal the value of\n NewReplicaCount plus 1 to account for the primary node. If this member\n of ReplicaConfiguration is omitted, ElastiCache selects the\n availability zone for each of the replicas.

" } }, "PreferredOutpostArns": { @@ -3173,7 +3173,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "com.amazonaws.elasticache#CopyServerlessCacheSnapshotRequest": { @@ -3183,7 +3183,7 @@ "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier of the existing serverless cache’s snapshot to be copied. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

The identifier of the existing serverless cache’s snapshot to be copied. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#required": {} } }, @@ -3191,20 +3191,20 @@ "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier for the snapshot to be created. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

The identifier for the snapshot to be created. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of the KMS key used to encrypt the target snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The identifier of the KMS key used to encrypt the target snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "

A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Redis OSS and Serverless Memcached only. Default: NULL

" + "smithy.api#documentation": "

A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

" } } }, @@ -3218,7 +3218,7 @@ "ServerlessCacheSnapshot": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { - "smithy.api#documentation": "

The response for the attempt to copy the serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The response for the attempt to copy the serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, @@ -3258,7 +3258,7 @@ } ], "traits": { - "smithy.api#documentation": "

Makes a copy of an existing snapshot.

\n \n

This operation is valid for Redis OSS only.

\n \n \n

Users or groups that have permissions to use the CopySnapshot\n operation can create their own Amazon S3 buckets and copy snapshots to it. To\n control access to your snapshots, use an IAM policy to control who has the ability\n to use the CopySnapshot operation. For more information about using IAM\n to control the use of ElastiCache operations, see Exporting\n Snapshots and Authentication & Access\n Control.

\n \n

You could receive the following error messages.

\n

\n Error Messages\n

\n
    \n
  • \n

    \n Error Message: The S3 bucket %s is outside of\n the region.

    \n

    \n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.

    \n
    • \n
  • \n

    \n Error Message: The S3 bucket %s does not\n exist.

    \n

    \n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.

    \n
    • \n
  • \n

    \n Error Message: The S3 bucket %s is not owned\n by the authenticated user.

    \n

    \n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.

    \n
    • \n
  • \n

    \n Error Message: The authenticated user does\n not have sufficient permissions to perform the desired activity.

    \n

    \n Solution: Contact your system administrator\n to get the needed permissions.

    \n
    • \n
  • \n

    \n Error Message: The S3 bucket %s already\n contains an object with key %s.

    \n

    \n Solution: Give the\n TargetSnapshotName a new and unique value. If exporting a\n snapshot, you could alternatively create a new Amazon S3 bucket and use this\n same value for TargetSnapshotName.

    \n
    • \n
  • \n

    \n Error Message: ElastiCache has not been\n granted READ permissions %s on the S3 Bucket.

    \n

    \n Solution: Add List and Read permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.

    \n
    • \n
  • \n

    \n Error Message: ElastiCache has not been\n granted WRITE permissions %s on the S3 Bucket.

    \n

    \n Solution: Add Upload/Delete permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.

    \n
    • \n
  • \n

    \n Error Message: ElastiCache has not been\n granted READ_ACP permissions %s on the S3 Bucket.

    \n

    \n Solution: Add View Permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.

    \n
    • \n
", + "smithy.api#documentation": "

Makes a copy of an existing snapshot.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n \n \n

Users or groups that have permissions to use the CopySnapshot\n operation can create their own Amazon S3 buckets and copy snapshots to it. To\n control access to your snapshots, use an IAM policy to control who has the ability\n to use the CopySnapshot operation. For more information about using IAM\n to control the use of ElastiCache operations, see Exporting\n Snapshots and Authentication & Access\n Control.

\n \n

You could receive the following error messages.

\n

\n Error Messages\n

\n
    \n
  • \n

    \n Error Message: The S3 bucket %s is outside of\n the region.

    \n

    \n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.

    \n
    • \n
  • \n

    \n Error Message: The S3 bucket %s does not\n exist.

    \n

    \n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.

    \n
    • \n
  • \n

    \n Error Message: The S3 bucket %s is not owned\n by the authenticated user.

    \n

    \n Solution: Create an Amazon S3 bucket in the\n same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User\n Guide.

    \n
    • \n
  • \n

    \n Error Message: The authenticated user does\n not have sufficient permissions to perform the desired activity.

    \n

    \n Solution: Contact your system administrator\n to get the needed permissions.

    \n
    • \n
  • \n

    \n Error Message: The S3 bucket %s already\n contains an object with key %s.

    \n

    \n Solution: Give the\n TargetSnapshotName a new and unique value. If exporting a\n snapshot, you could alternatively create a new Amazon S3 bucket and use this\n same value for TargetSnapshotName.

    \n
    • \n
  • \n

    \n Error Message: ElastiCache has not been\n granted READ permissions %s on the S3 Bucket.

    \n

    \n Solution: Add List and Read permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.

    \n
    • \n
  • \n

    \n Error Message: ElastiCache has not been\n granted WRITE permissions %s on the S3 Bucket.

    \n

    \n Solution: Add Upload/Delete permissions on\n the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.

    \n
    • \n
  • \n

    \n Error Message: ElastiCache has not been\n granted READ_ACP permissions %s on the S3 Bucket.

    \n

    \n Solution: Add View Permissions on the bucket.\n For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the\n ElastiCache User Guide.

    \n
    • \n
", "smithy.api#examples": [ { "title": "CopySnapshot", @@ -3409,7 +3409,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache\n engine software, either Memcached or Redis OSS.

\n

This operation is not supported for Redis OSS (cluster mode enabled) clusters.

", + "smithy.api#documentation": "

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache\n engine software, either Memcached, Valkey or Redis OSS.

\n

This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

", "smithy.api#examples": [ { "title": "CreateCacheCluster", @@ -3528,13 +3528,13 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The initial number of cache nodes that the cluster has.

\n

For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

\n

If you need more than 40 nodes for your Memcached cluster, please fill out the\n ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

" + "smithy.api#documentation": "

The initial number of cache nodes that the cluster has.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

\n

If you need more than 40 nodes for your Memcached cluster, please fill out the\n ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "Engine": { @@ -3582,13 +3582,13 @@ "SnapshotArns": { "target": "com.amazonaws.elasticache#SnapshotArnsList", "traits": { - "smithy.api#documentation": "

A single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to\n populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any\n commas.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n \n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" + "smithy.api#documentation": "

A single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to\n populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any\n commas.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n \n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" } }, "SnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of a Redis OSS snapshot from which to restore data into the new node group\n (shard). The snapshot status changes to restoring while the new node group\n (shard) is being created.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " + "smithy.api#documentation": "

The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group\n (shard). The snapshot status changes to restoring while the new node group\n (shard) is being created.

\n \n

This parameter is only valid if the Engine parameter is\n redis.

\n " } }, "PreferredMaintenanceWindow": { @@ -3612,7 +3612,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

 If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + "smithy.api#documentation": "

 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" } }, "SnapshotRetentionLimit": { @@ -3666,13 +3666,13 @@ "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } }, "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } } }, @@ -4023,7 +4023,7 @@ } ], "traits": { - "smithy.api#documentation": "

Global Datastore for Redis OSS offers fully managed, fast, reliable and secure\n cross-region replication. Using Global Datastore for Redis OSS, you can create cross-region\n read replica clusters for ElastiCache (Redis OSS) to enable low-latency reads and disaster\n recovery across regions. For more information, see Replication\n Across Regions Using Global Datastore.

\n
    \n
  • \n

    The GlobalReplicationGroupIdSuffix is the\n name of the Global datastore.

    \n
    • \n
  • \n

    The PrimaryReplicationGroupId represents the\n name of the primary cluster that accepts writes and will replicate updates to\n the secondary cluster.

    \n
    • \n
" + "smithy.api#documentation": "

Global Datastore offers fully managed, fast, reliable and secure\n cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region\n read replica clusters for ElastiCache to enable low-latency reads and disaster\n recovery across regions. For more information, see Replication\n Across Regions Using Global Datastore.

\n
    \n
  • \n

    The GlobalReplicationGroupIdSuffix is the\n name of the Global datastore.

    \n
    • \n
  • \n

    The PrimaryReplicationGroupId represents the\n name of the primary cluster that accepts writes and will replicate updates to\n the secondary cluster.

    \n
    • \n
" } }, "com.amazonaws.elasticache#CreateGlobalReplicationGroupMessage": { @@ -4135,7 +4135,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication\n group.

\n

This API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.

\n

A Redis OSS (cluster mode disabled) replication group is a collection of nodes, where\n one of the nodes is a read/write primary and the others are read-only replicas.\n Writes to the primary are asynchronously propagated to the replicas.

\n

A Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:\n node groups). Each shard has a primary node and up to 5 read-only replica nodes. The\n configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which\n is the maximum number or replicas allowed.

\n

The node or shard limit can be increased to a maximum of 500 per cluster if the Redis OSS \n engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node\n cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500\n shards (single primary and no replicas). Make sure there are enough available IP\n addresses to accommodate the increase. Common pitfalls include the subnets in the subnet\n group have too small a CIDR range or the subnets are shared and heavily used by other\n clusters. For more information, see Creating a Subnet\n Group. For versions below 5.0.6, the limit is 250 per cluster.

\n

To request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.

\n

When a Redis OSS (cluster mode disabled) replication group has been successfully created,\n you can add one or more read replicas to it, up to a total of 5 read replicas. If you\n need to increase or decrease the number of node groups (console: shards), you can use ElastiCache (Redis OSS) scaling. \n For more information, see Scaling\n ElastiCache (Redis OSS) Clusters in the ElastiCache User\n Guide.

\n \n

This operation is valid for Redis OSS only.

\n ", + "smithy.api#documentation": "

Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication\n group.

\n

This API can be used to create a standalone regional replication group or a secondary\n replication group associated with a Global datastore.

\n

A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where\n one of the nodes is a read/write primary and the others are read-only replicas.\n Writes to the primary are asynchronously propagated to the replicas.

\n

A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI:\n node groups). Each shard has a primary node and up to 5 read-only replica nodes. The\n configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which\n is the maximum number or replicas allowed.

\n

The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS \n engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node\n cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500\n shards (single primary and no replicas). Make sure there are enough available IP\n addresses to accommodate the increase. Common pitfalls include the subnets in the subnet\n group have too small a CIDR range or the subnets are shared and heavily used by other\n clusters. For more information, see Creating a Subnet\n Group. For versions below 5.0.6, the limit is 250 per cluster.

\n

To request a limit increase, see Amazon Service Limits and\n choose the limit type Nodes per cluster per instance\n type.

\n

When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created,\n you can add one or more read replicas to it, up to a total of 5 read replicas. If you\n need to increase or decrease the number of node groups (console: shards), you can use scaling. \n For more information, see Scaling self-designed clusters in the ElastiCache User\n Guide.

\n \n

This operation is valid for Valkey and Redis OSS only.

\n ", "smithy.api#examples": [ { "title": "CreateCacheReplicationGroup", @@ -4255,7 +4255,7 @@ "AutomaticFailoverEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether a read-only replica is automatically promoted to read/write primary\n if the existing primary fails.

\n

\n AutomaticFailoverEnabled must be enabled for Redis OSS (cluster mode enabled)\n replication groups.

\n

Default: false

" + "smithy.api#documentation": "

Specifies whether a read-only replica is automatically promoted to read/write primary\n if the existing primary fails.

\n

\n AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled)\n replication groups.

\n

Default: false

" } }, "MultiAZEnabled": { @@ -4279,7 +4279,7 @@ "NumNodeGroups": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

An optional parameter that specifies the number of node groups (shards) for this Redis OSS (cluster mode enabled) replication group. For Redis OSS (cluster mode disabled) either omit\n this parameter or set it to 1.

\n

Default: 1

" + "smithy.api#documentation": "

An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. For Valkey or Redis OSS (cluster mode disabled) either omit\n this parameter or set it to 1.

\n

Default: 1

" } }, "ReplicasPerNodeGroup": { @@ -4291,13 +4291,13 @@ "NodeGroupConfiguration": { "target": "com.amazonaws.elasticache#NodeGroupConfigurationList", "traits": { - "smithy.api#documentation": "

A list of node group (shard) configuration options. Each node group (shard)\n configuration has the following members: PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount, and\n Slots.

\n

If you're creating a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled)\n replication group, you can use this parameter to individually configure each node group\n (shard), or you can omit this parameter. However, it is required when seeding a Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group\n (shard) using this parameter because you must specify the slots for each node\n group.

" + "smithy.api#documentation": "

A list of node group (shard) configuration options. Each node group (shard)\n configuration has the following members: PrimaryAvailabilityZone,\n ReplicaAvailabilityZones, ReplicaCount, and\n Slots.

\n

If you're creating a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled)\n replication group, you can use this parameter to individually configure each node group\n (shard), or you can omit this parameter. However, it is required when seeding a Valkey or Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group\n (shard) using this parameter because you must specify the slots for each node\n group.

" } }, "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the node group (shard).

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "Engine": { @@ -4315,7 +4315,7 @@ "CacheParameterGroupName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the parameter group to associate with this replication group. If this\n argument is omitted, the default cache parameter group for the specified engine is\n used.

\n

If you are running Redis OSS version 3.2.4 or later, only one node group (shard), and want\n to use a default parameter group, we recommend that you specify the parameter group by\n name.

\n
    \n
  • \n

    To create a Redis OSS (cluster mode disabled) replication group, use\n CacheParameterGroupName=default.redis3.2.

    \n
    • \n
  • \n

    To create a Redis OSS (cluster mode enabled) replication group, use\n CacheParameterGroupName=default.redis3.2.cluster.on.

    \n
    • \n
" + "smithy.api#documentation": "

The name of the parameter group to associate with this replication group. If this\n argument is omitted, the default cache parameter group for the specified engine is\n used.

\n

If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want\n to use a default parameter group, we recommend that you specify the parameter group by\n name.

\n
    \n
  • \n

    To create a Valkey or Redis OSS (cluster mode disabled) replication group, use\n CacheParameterGroupName=default.redis3.2.

    \n
    • \n
  • \n

    To create a Valkey or Redis OSS (cluster mode enabled) replication group, use\n CacheParameterGroupName=default.redis3.2.cluster.on.

    \n
    • \n
" } }, "CacheSubnetGroupName": { @@ -4345,7 +4345,7 @@ "SnapshotArns": { "target": "com.amazonaws.elasticache#SnapshotArnsList", "traits": { - "smithy.api#documentation": "

A list of Amazon Resource Names (ARN) that uniquely identify the Redis OSS RDB snapshot\n files stored in Amazon S3. The snapshot files are used to populate the new replication\n group. The Amazon S3 object name in the ARN cannot contain any commas. The new\n replication group will have the number of node groups (console: shards) specified by the\n parameter NumNodeGroups or the number of node groups configured by\n NodeGroupConfiguration regardless of the number of ARNs\n specified here.

\n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" + "smithy.api#documentation": "

A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot\n files stored in Amazon S3. The snapshot files are used to populate the new replication\n group. The Amazon S3 object name in the ARN cannot contain any commas. The new\n replication group will have the number of node groups (console: shards) specified by the\n parameter NumNodeGroups or the number of node groups configured by\n NodeGroupConfiguration regardless of the number of ARNs\n specified here.

\n

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\n

" } }, "SnapshotName": { @@ -4375,7 +4375,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

 If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + "smithy.api#documentation": "

 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" } }, "SnapshotRetentionLimit": { @@ -4435,31 +4435,31 @@ "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } }, "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "

The network type you choose when creating a replication group, either\n ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS\n engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on\n the Nitro system.

" + "smithy.api#documentation": "

The network type you choose when creating a replication group, either\n ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on\n the Nitro system.

" } }, "TransitEncryptionMode": { "target": "com.amazonaws.elasticache#TransitEncryptionMode", "traits": { - "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

\n

When setting TransitEncryptionEnabled to true, you can set\n your TransitEncryptionMode to preferred in the same request,\n to allow both encrypted and unencrypted connections at the same time. Once you migrate\n all your Redis OSS clients to use encrypted connections you can modify the value to\n required to allow encrypted connections only.

\n

Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.

\n

This process will not trigger the replacement of the replication group.

" + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

\n

When setting TransitEncryptionEnabled to true, you can set\n your TransitEncryptionMode to preferred in the same request,\n to allow both encrypted and unencrypted connections at the same time. Once you migrate\n all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to\n required to allow encrypted connections only.

\n

Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.

\n

This process will not trigger the replacement of the replication group.

" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS \n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS \n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" } }, "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the snapshot used to create a replication group. Available for Redis OSS only.

" + "smithy.api#documentation": "

The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.

" } } }, @@ -4578,7 +4578,7 @@ "SnapshotArnsToRestore": { "target": "com.amazonaws.elasticache#SnapshotArnsList", "traits": { - "smithy.api#documentation": "

The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "Tags": { @@ -4590,7 +4590,7 @@ "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of the UserGroup to be associated with the serverless cache. Available for Redis OSS only. Default is NULL.

" + "smithy.api#documentation": "

The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

" } }, "SubnetIds": { @@ -4602,13 +4602,13 @@ "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of snapshots that will be retained for the serverless cache that is being created. \n As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The number of snapshots that will be retained for the serverless cache that is being created. \n As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "DailySnapshotTime": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The daily time that snapshots will be created from the new serverless cache. By default this number is populated with \n 0, i.e. no snapshots will be created on an automatic daily basis. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The daily time that snapshots will be created from the new serverless cache. By default this number is populated with \n 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, @@ -4665,7 +4665,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "com.amazonaws.elasticache#CreateServerlessCacheSnapshotRequest": { @@ -4675,7 +4675,7 @@ "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name for the snapshot being created. Must be unique for the customer account. Available for Redis OSS and Serverless Memcached only.\n Must be between 1 and 255 characters.

", + "smithy.api#documentation": "

The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only.\n Must be between 1 and 255 characters.

", "smithy.api#required": {} } }, @@ -4683,20 +4683,20 @@ "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of an existing serverless cache. The snapshot is created from this cache. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot. Available for Redis OSS and Serverless Memcached only. Default: NULL

" + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

" } }, "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "

A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, @@ -4710,7 +4710,7 @@ "ServerlessCacheSnapshot": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { - "smithy.api#documentation": "

The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, @@ -4759,7 +4759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a copy of an entire cluster or replication group at a specific moment in\n time.

\n \n

This operation is valid for Redis OSS only.

\n ", + "smithy.api#documentation": "

Creates a copy of an entire cluster or replication group at a specific moment in\n time.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n ", "smithy.api#examples": [ { "title": "CreateSnapshot - NonClustered Redis, 2 read-replicas", @@ -4962,7 +4962,7 @@ } ], "traits": { - "smithy.api#documentation": "

For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user. For more information, see\n Using Role Based Access Control (RBAC).

" + "smithy.api#documentation": "

For Valkey engine version 7.2 onwards and Redis OSS 6.0 and onwards: Creates a user. For more information, see\n Using Role Based Access Control (RBAC).

" } }, "com.amazonaws.elasticache#CreateUserGroup": { @@ -5000,7 +5000,7 @@ } ], "traits": { - "smithy.api#documentation": "

For Redis OSS engine version 6.0 onwards: Creates a Redis OSS user group. For more\n information, see Using Role Based Access Control (RBAC)\n

" + "smithy.api#documentation": "

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Creates a user group. For more\n information, see Using Role Based Access Control (RBAC)\n

" } }, "com.amazonaws.elasticache#CreateUserGroupMessage": { @@ -5031,7 +5031,7 @@ "Tags": { "target": "com.amazonaws.elasticache#TagList", "traits": { - "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted. Available for Redis OSS only.

" + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must\n be accompanied by a tag value, although null is accepted. Available for Valkey and Redis OSS only.

" } } }, @@ -5233,13 +5233,13 @@ "GlobalNodeGroupsToRemove": { "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", "traits": { - "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n ElastiCache (Redis OSS) will attempt to remove all node groups listed by\n GlobalNodeGroupsToRemove from the cluster.

" + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.\n ElastiCache will attempt to remove all node groups listed by\n GlobalNodeGroupsToRemove from the cluster.

" } }, "GlobalNodeGroupsToRetain": { "target": "com.amazonaws.elasticache#GlobalNodeGroupIdList", "traits": { - "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster.\n ElastiCache (Redis OSS) will attempt to retain all node groups listed by\n GlobalNodeGroupsToRetain from the cluster.

" + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node groups\n (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required.\n GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster.\n ElastiCache will attempt to retain all node groups listed by\n GlobalNodeGroupsToRetain from the cluster.

" } }, "ApplyImmediately": { @@ -5313,7 +5313,7 @@ } ], "traits": { - "smithy.api#documentation": "

Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Redis OSS (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.

" + "smithy.api#documentation": "

Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.

" } }, "com.amazonaws.elasticache#DecreaseReplicaCountMessage": { @@ -5330,13 +5330,13 @@ "NewReplicaCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Redis OSS (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.

\n

The minimum number of replicas in a shard or replication group is:

\n
    \n
  • \n

    Redis OSS (cluster mode disabled)

    \n
      \n
    • \n

      If Multi-AZ is enabled: 1

      \n
      • \n
    • \n

      If Multi-AZ is not enabled: 0

      \n
      • \n
    \n
    • \n
  • \n

    Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)

    \n
    • \n
" + "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.

\n

The minimum number of replicas in a shard or replication group is:

\n
    \n
  • \n

    Valkey or Redis OSS (cluster mode disabled)

    \n
      \n
    • \n

      If Multi-AZ is enabled: 1

      \n
      • \n
    • \n

      If Multi-AZ is not enabled: 0

      \n
      • \n
    \n
    • \n
  • \n

    Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to\n a replica if your primary node fails)

    \n
    • \n
" } }, "ReplicaConfiguration": { "target": "com.amazonaws.elasticache#ReplicaConfigurationList", "traits": { - "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each\n shard in a Redis OSS (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.

" + "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each\n shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.

" } }, "ReplicasToRemove": { @@ -5435,7 +5435,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all\n associated cache nodes, node endpoints and the cluster itself. When you receive a\n successful response from this operation, Amazon ElastiCache immediately begins deleting\n the cluster; you cannot cancel or revert this operation.

\n

This operation is not valid for:

\n
    \n
  • \n

    Redis OSS (cluster mode enabled) clusters

    \n
    • \n
  • \n

    Redis OSS (cluster mode disabled) clusters

    \n
    • \n
  • \n

    A cluster that is the last read replica of a replication group

    \n
    • \n
  • \n

    A cluster that is the primary node of a replication group

    \n
    • \n
  • \n

    A node group (shard) that has Multi-AZ mode enabled

    \n
    • \n
  • \n

    A cluster from a Redis OSS (cluster mode enabled) replication group

    \n
    • \n
  • \n

    A cluster that is not in the available state

    \n
    • \n
", + "smithy.api#documentation": "

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all\n associated cache nodes, node endpoints and the cluster itself. When you receive a\n successful response from this operation, Amazon ElastiCache immediately begins deleting\n the cluster; you cannot cancel or revert this operation.

\n

This operation is not valid for:

\n
    \n
  • \n

    Valkey or Redis OSS (cluster mode enabled) clusters

    \n
    • \n
  • \n

    Valkey or Redis OSS (cluster mode disabled) clusters

    \n
    • \n
  • \n

    A cluster that is the last read replica of a replication group

    \n
    • \n
  • \n

    A cluster that is the primary node of a replication group

    \n
    • \n
  • \n

    A node group (shard) that has Multi-AZ mode enabled

    \n
    • \n
  • \n

    A cluster from a Valkey or Redis OSS (cluster mode enabled) replication group

    \n
    • \n
  • \n

    A cluster that is not in the available state

    \n
    • \n
", "smithy.api#examples": [ { "title": "DeleteCacheCluster", @@ -5859,7 +5859,7 @@ "FinalSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

Name of the final snapshot to be taken before the serverless cache is deleted. Available for Redis OSS and Serverless Memcached only.\n Default: NULL, i.e. a final snapshot is not taken.

" + "smithy.api#documentation": "

Name of the final snapshot to be taken before the serverless cache is deleted. Available for Valkey, Redis OSS and Serverless Memcached only.\n Default: NULL, i.e. a final snapshot is not taken.

" } } }, @@ -5904,7 +5904,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "com.amazonaws.elasticache#DeleteServerlessCacheSnapshotRequest": { @@ -5914,7 +5914,7 @@ "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Idenfitier of the snapshot to be deleted. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

Idenfitier of the snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#required": {} } } @@ -5929,7 +5929,7 @@ "ServerlessCacheSnapshot": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { - "smithy.api#documentation": "

The snapshot to be deleted. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, @@ -5960,7 +5960,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing snapshot. When you receive a successful response from this\n operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or\n revert this operation.

\n \n

This operation is valid for Redis OSS only.

\n ", + "smithy.api#documentation": "

Deletes an existing snapshot. When you receive a successful response from this\n operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or\n revert this operation.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n ", "smithy.api#examples": [ { "title": "DeleteSnapshot", @@ -6056,7 +6056,7 @@ } ], "traits": { - "smithy.api#documentation": "

For Redis OSS engine version 6.0 onwards: Deletes a user. The user will be removed from\n all user groups and in turn removed from all replication groups. For more information,\n see Using Role Based Access Control (RBAC).

" + "smithy.api#documentation": "

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from\n all user groups and in turn removed from all replication groups. For more information,\n see Using Role Based Access Control (RBAC).

" } }, "com.amazonaws.elasticache#DeleteUserGroup": { @@ -6082,7 +6082,7 @@ } ], "traits": { - "smithy.api#documentation": "

For Redis OSS engine version 6.0 onwards: Deletes a user group. The user group must first\n be disassociated from the replication group before it can be deleted. For more\n information, see Using Role Based Access Control (RBAC).

" + "smithy.api#documentation": "

For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first\n be disassociated from the replication group before it can be deleted. For more\n information, see Using Role Based Access Control (RBAC).

" } }, "com.amazonaws.elasticache#DeleteUserGroupMessage": { @@ -6418,7 +6418,7 @@ "ShowCacheClustersNotInReplicationGroups": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request\n to show only nodes (API/CLI: clusters) that are not members of a replication group. In\n practice, this mean Memcached and single node Redis OSS clusters.

" + "smithy.api#documentation": "

An optional flag that can be included in the DescribeCacheCluster request\n to show only nodes (API/CLI: clusters) that are not members of a replication group. In\n practice, this means Memcached and single node Valkey or Redis OSS clusters.

" } } }, @@ -6627,7 +6627,7 @@ "CacheParameterGroupFamily": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of a specific cache parameter group family to return details for.

\n

Valid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis6.2 | redis7\n

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 alphanumeric characters

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" + "smithy.api#documentation": "

The name of a specific cache parameter group family to return details for.

\n

Valid values are: memcached1.4 | memcached1.5 |\n memcached1.6 | redis2.6 | redis2.8 |\n redis3.2 | redis4.0 | redis5.0 |\n redis6.x | redis6.2 | redis7 | valkey7\n

\n

Constraints:

\n
    \n
  • \n

    Must be 1 to 255 alphanumeric characters

    \n
    • \n
  • \n

    First character must be a letter

    \n
    • \n
  • \n

    Cannot end with a hyphen or contain two consecutive hyphens

    \n
    • \n
" } }, "MaxRecords": { @@ -8311,7 +8311,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a particular replication group. If no identifier is\n specified, DescribeReplicationGroups returns information about all\n replication groups.

\n \n

This operation is valid for Redis OSS only.

\n ", + "smithy.api#documentation": "

Returns information about a particular replication group. If no identifier is\n specified, DescribeReplicationGroups returns information about all\n replication groups.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n ", "smithy.api#examples": [ { "title": "DescribeReplicationGroups", @@ -8521,7 +8521,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "Duration": { @@ -8902,7 +8902,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type filter value. Use this parameter to show only the available\n offerings matching the specified cache node type.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

The cache node type filter value. Use this parameter to show only the available\n offerings matching the specified cache node type.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "Duration": { @@ -8964,7 +8964,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about serverless cache snapshots. \n By default, this API lists all of the customer’s serverless cache snapshots. \n It can also describe a single serverless cache snapshot, or the snapshots associated with \n a particular serverless cache. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

Returns information about serverless cache snapshots. \n By default, this API lists all of the customer’s serverless cache snapshots. \n It can also describe a single serverless cache snapshot, or the snapshots associated with \n a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8979,31 +8979,31 @@ "ServerlessCacheName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of serverless cache. If this parameter is specified, \n only snapshots associated with that specific serverless cache are described. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The identifier of serverless cache. If this parameter is specified, \n only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of the serverless cache’s snapshot.\n If this parameter is specified, only this snapshot is described. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The identifier of the serverless cache’s snapshot.\n If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "SnapshotType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The type of snapshot that is being described. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "NextToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by max-results. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "MaxResults": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than \n the specified max-results value, a market is included in the response so that remaining results \n can be retrieved. Available for Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.

" + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than \n the specified max-results value, a market is included in the response so that remaining results \n can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.

" } } }, @@ -9017,13 +9017,13 @@ "NextToken": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by max-results. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

An optional marker returned from a prior request to support pagination of results from this operation. \n If this parameter is specified, the response includes only records beyond the marker, \n up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "ServerlessCacheSnapshots": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshotList", "traits": { - "smithy.api#documentation": "

The serverless caches snapshots associated with a given description request. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, @@ -9190,7 +9190,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about cluster or replication group snapshots. By default,\n DescribeSnapshots lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.

\n \n

This operation is valid for Redis OSS only.

\n ", + "smithy.api#documentation": "

Returns information about cluster or replication group snapshots. By default,\n DescribeSnapshots lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.

\n \n

This operation is valid for Valkey or Redis OSS only.

\n ", "smithy.api#examples": [ { "title": "DescribeSnapshots", @@ -9363,7 +9363,7 @@ "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Redis OSS or Memcached.

" + "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

" } }, "ServiceUpdateStatus": { @@ -9517,7 +9517,7 @@ "Engine": { "target": "com.amazonaws.elasticache#EngineType", "traits": { - "smithy.api#documentation": "

The Redis OSS engine.

" + "smithy.api#documentation": "

The engine.

" } }, "UserId": { @@ -9896,7 +9896,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS only.

" + "smithy.api#documentation": "

Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.

" } }, "com.amazonaws.elasticache#ExportServerlessCacheSnapshotRequest": { @@ -9906,7 +9906,7 @@ "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The identifier of the serverless cache snapshot to be exported to S3. Available for Redis OSS only.

", + "smithy.api#documentation": "

The identifier of the serverless cache snapshot to be exported to S3. Available for Valkey and Redis OSS only.

", "smithy.api#required": {} } }, @@ -9914,7 +9914,7 @@ "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region \n as the snapshot. Available for Redis OSS only.

", + "smithy.api#documentation": "

Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region \n as the snapshot. Available for Valkey and Redis OSS only.

", "smithy.api#required": {} } } @@ -9929,7 +9929,7 @@ "ServerlessCacheSnapshot": { "target": "com.amazonaws.elasticache#ServerlessCacheSnapshot", "traits": { - "smithy.api#documentation": "

The state of a serverless cache at a specific point in time, to the millisecond. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The state of a serverless cache at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, @@ -10127,13 +10127,13 @@ "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Elasticache engine. For Redis OSS only.

" + "smithy.api#documentation": "

The ElastiCache engine. For Valkey or Redis OSS only.

" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Elasticache (Redis OSS) engine version.

" + "smithy.api#documentation": "

The ElastiCache engine version.

" } }, "Members": { @@ -10157,7 +10157,7 @@ "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Redis OSS \n commands.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.

\n

Default: false\n

" } }, "TransitEncryptionEnabled": { @@ -10412,7 +10412,7 @@ } ], "traits": { - "smithy.api#documentation": "

Dynamically increases the number of replicas in a Redis OSS (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Redis OSS (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.

" + "smithy.api#documentation": "

Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled)\n replication group or the number of replica nodes in one or more node groups (shards) of\n a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no\n cluster down time.

" } }, "com.amazonaws.elasticache#IncreaseReplicaCountMessage": { @@ -10429,13 +10429,13 @@ "NewReplicaCount": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation. For Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Redis OSS (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.

" + "smithy.api#documentation": "

The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in\n the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the\n number of replica nodes in each of the replication group's node groups.

" } }, "ReplicaConfiguration": { "target": "com.amazonaws.elasticache#ReplicaConfigurationList", "traits": { - "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each\n shard in a Redis OSS (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.

" + "smithy.api#documentation": "

A list of ConfigureShard objects that can be used to configure each\n shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The\n ConfigureShard has three members: NewReplicaCount,\n NodeGroupId, and PreferredAvailabilityZones.

" } }, "ApplyImmediately": { @@ -10696,7 +10696,7 @@ "code": "InvalidServerlessCacheSnapshotStateFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The state of the serverless cache snapshot was not received. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -10863,7 +10863,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all available node types that you can scale your Redis OSS cluster's or replication\n group's current node type.

\n

When you use the ModifyCacheCluster or\n ModifyReplicationGroup operations to scale your cluster or replication\n group, the value of the CacheNodeType parameter must be one of the node\n types returned by this operation.

", + "smithy.api#documentation": "

Lists all available node types that you can scale with your cluster's replication\n group's current node type.

\n

When you use the ModifyCacheCluster or\n ModifyReplicationGroup operations to scale your cluster or replication\n group, the value of the CacheNodeType parameter must be one of the node\n types returned by this operation.

", "smithy.api#examples": [ { "title": "ListAllowedNodeTypeModifications", @@ -11281,7 +11281,7 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of cache nodes that the cluster should have. If the value for\n NumCacheNodes is greater than the sum of the number of current cache\n nodes and the number of cache nodes pending creation (which may be zero), more nodes are\n added. If the value is less than the number of existing cache nodes, nodes are removed.\n If the value is equal to the number of current cache nodes, any pending add or remove\n requests are canceled.

\n

If you are removing cache nodes, you must use the CacheNodeIdsToRemove\n parameter to provide the IDs of the specific cache nodes to remove.

\n

For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

\n \n

Adding or removing Memcached cache nodes can be applied immediately or as a\n pending operation (see ApplyImmediately).

\n

A pending operation to modify the number of cache nodes in a cluster during its\n maintenance window, whether by adding or removing nodes in accordance with the scale\n out architecture, is not queued. The customer's latest request to add or remove\n nodes to the cluster overrides any previous pending operations to modify the number\n of cache nodes in the cluster. For example, a request to remove 2 nodes would\n override a previous pending operation to remove 3 nodes. Similarly, a request to add\n 2 nodes would override a previous pending operation to remove 3 nodes and vice\n versa. As Memcached cache nodes may now be provisioned in different Availability\n Zones with flexible cache node placement, a request to add nodes does not\n automatically override a previous pending operation to add nodes. The customer can\n modify the previous pending operation to add more nodes or explicitly cancel the\n pending request and retry the new request. To cancel pending operations to modify\n the number of cache nodes in a cluster, use the ModifyCacheCluster\n request and set NumCacheNodes equal to the number of cache nodes\n currently in the cluster.

\n " + "smithy.api#documentation": "

The number of cache nodes that the cluster should have. If the value for\n NumCacheNodes is greater than the sum of the number of current cache\n nodes and the number of cache nodes pending creation (which may be zero), more nodes are\n added. If the value is less than the number of existing cache nodes, nodes are removed.\n If the value is equal to the number of current cache nodes, any pending add or remove\n requests are canceled.

\n

If you are removing cache nodes, you must use the CacheNodeIdsToRemove\n parameter to provide the IDs of the specific cache nodes to remove.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

\n \n

Adding or removing Memcached cache nodes can be applied immediately or as a\n pending operation (see ApplyImmediately).

\n

A pending operation to modify the number of cache nodes in a cluster during its\n maintenance window, whether by adding or removing nodes in accordance with the scale\n out architecture, is not queued. The customer's latest request to add or remove\n nodes to the cluster overrides any previous pending operations to modify the number\n of cache nodes in the cluster. For example, a request to remove 2 nodes would\n override a previous pending operation to remove 3 nodes. Similarly, a request to add\n 2 nodes would override a previous pending operation to remove 3 nodes and vice\n versa. As Memcached cache nodes may now be provisioned in different Availability\n Zones with flexible cache node placement, a request to add nodes does not\n automatically override a previous pending operation to add nodes. The customer can\n modify the previous pending operation to add more nodes or explicitly cancel the\n pending request and retry the new request. To cancel pending operations to modify\n the number of cache nodes in a cluster, use the ModifyCacheCluster\n request and set NumCacheNodes equal to the number of cache nodes\n currently in the cluster.

\n " } }, "CacheNodeIdsToRemove": { @@ -11344,6 +11344,12 @@ "smithy.api#documentation": "

If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cluster.

\n

If false, changes to the cluster are applied on the next maintenance\n reboot, or the next failure reboot, whichever occurs first.

\n \n

If you perform a ModifyCacheCluster before a pending modification is\n applied, the pending modification is replaced by the newer modification.

\n \n

Valid values: true | false\n

\n

Default: false\n

" } }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine listed in a cluster message. The options are redis, memcached or valkey.

" + } + }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -11353,7 +11359,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

 If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + "smithy.api#documentation": "

 If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes \n to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" } }, "SnapshotRetentionLimit": { @@ -11383,7 +11389,7 @@ "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    ROTATE - default, if no update strategy is provided

    \n
    • \n
  • \n

    SET - allowed only after ROTATE

    \n
    • \n
  • \n

    DELETE - allowed only when transitioning to RBAC

    \n
    • \n
\n

For more information, see Authenticating Users with Redis OSS AUTH\n

" + "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    ROTATE - default, if no update strategy is provided

    \n
    • \n
  • \n

    SET - allowed only after ROTATE

    \n
    • \n
  • \n

    DELETE - allowed only when transitioning to RBAC

    \n
    • \n
\n

For more information, see Authenticating Users with AUTH\n

" } }, "LogDeliveryConfigurations": { @@ -11395,7 +11401,7 @@ "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } } }, @@ -11659,6 +11665,12 @@ "smithy.api#documentation": "

A valid cache node type that you want to scale this Global datastore to.

" } }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.

" + } + }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -11758,7 +11770,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies the settings for a replication group. This is limited to Redis OSS 7 and newer.

\n \n \n

This operation is valid for Redis OSS only.

\n ", + "smithy.api#documentation": "

Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.

\n \n \n

This operation is valid for Valkey or Redis OSS only.

\n ", "smithy.api#examples": [ { "title": "ModifyReplicationGroup", @@ -11857,7 +11869,7 @@ "SnapshottingClusterId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cluster ID that is used as the daily snapshot source for the replication group.\n This parameter cannot be set for Redis OSS (cluster mode enabled) replication groups.

" + "smithy.api#documentation": "

The cluster ID that is used as the daily snapshot source for the replication group.\n This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.

" } }, "AutomaticFailoverEnabled": { @@ -11921,6 +11933,12 @@ "smithy.api#documentation": "

If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the replication group.

\n

If false, changes to the nodes in the replication group are applied on\n the next maintenance reboot, or the next failure reboot, whichever occurs first.

\n

Valid values: true | false\n

\n

Default: false\n

" } }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine listed in a replication group message. The options are redis, memcached or valkey.

" + } + }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { @@ -11930,7 +11948,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

 If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + "smithy.api#documentation": "

 If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" } }, "SnapshotRetentionLimit": { @@ -11960,7 +11978,7 @@ "AuthTokenUpdateStrategy": { "target": "com.amazonaws.elasticache#AuthTokenUpdateStrategyType", "traits": { - "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    ROTATE - default, if no update strategy is provided

    \n
    • \n
  • \n

    SET - allowed only after ROTATE

    \n
    • \n
  • \n

    DELETE - allowed only when transitioning to RBAC

    \n
    • \n
\n

For more information, see Authenticating Users with Redis OSS AUTH\n

" + "smithy.api#documentation": "

Specifies the strategy to use to update the AUTH token. This parameter must be\n specified with the auth-token parameter. Possible values:

\n
    \n
  • \n

    ROTATE - default, if no update strategy is provided

    \n
    • \n
  • \n

    SET - allowed only after ROTATE

    \n
    • \n
  • \n

    DELETE - allowed only when transitioning to RBAC

    \n
    • \n
\n

For more information, see Authenticating Users with AUTH\n

" } }, "UserGroupIdsToAdd": { @@ -11990,7 +12008,7 @@ "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } }, "TransitEncryptionEnabled": { @@ -12002,13 +12020,13 @@ "TransitEncryptionMode": { "target": "com.amazonaws.elasticache#TransitEncryptionMode", "traits": { - "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

\n

You must set TransitEncryptionEnabled to true, for your\n existing cluster, and set TransitEncryptionMode to preferred\n in the same request to allow both encrypted and unencrypted connections at the same\n time. Once you migrate all your Redis OSS clients to use encrypted connections you can set\n the value to required to allow encrypted connections only.

\n

Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.

" + "smithy.api#documentation": "

A setting that allows you to migrate your clients to use in-transit encryption, with\n no downtime.

\n

You must set TransitEncryptionEnabled to true, for your\n existing cluster, and set TransitEncryptionMode to preferred\n in the same request to allow both encrypted and unencrypted connections at the same\n time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set\n the value to required to allow encrypted connections only.

\n

Setting TransitEncryptionMode to required is a two-step\n process that requires you to first set the TransitEncryptionMode to\n preferred, after that you can set TransitEncryptionMode to\n required.

" } }, "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" } } }, @@ -12079,7 +12097,7 @@ "target": "com.amazonaws.elasticache#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The name of the Redis OSS (cluster mode enabled) cluster (replication group) on which the\n shards are to be configured.

", + "smithy.api#documentation": "

The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the\n shards are to be configured.

", "smithy.api#required": {} } }, @@ -12108,13 +12126,13 @@ "NodeGroupsToRemove": { "target": "com.amazonaws.elasticache#NodeGroupsToRemoveList", "traits": { - "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRemove is a\n list of NodeGroupIds to remove from the cluster.

\n

ElastiCache (Redis OSS) will attempt to remove all node groups listed by\n NodeGroupsToRemove from the cluster.

" + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRemove is a\n list of NodeGroupIds to remove from the cluster.

\n

ElastiCache will attempt to remove all node groups listed by\n NodeGroupsToRemove from the cluster.

" } }, "NodeGroupsToRetain": { "target": "com.amazonaws.elasticache#NodeGroupsToRetainList", "traits": { - "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRetain is a\n list of NodeGroupIds to retain in the cluster.

\n

ElastiCache (Redis OSS) will attempt to remove all node groups except those listed by\n NodeGroupsToRetain from the cluster.

" + "smithy.api#documentation": "

If the value of NodeGroupCount is less than the current number of node\n groups (shards), then either NodeGroupsToRemove or\n NodeGroupsToRetain is required. NodeGroupsToRetain is a\n list of NodeGroupIds to retain in the cluster.

\n

ElastiCache will attempt to remove all node groups except those listed by\n NodeGroupsToRetain from the cluster.

" } } }, @@ -12198,13 +12216,13 @@ "RemoveUserGroup": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

The identifier of the UserGroup to be removed from association with the Redis OSS serverless cache. Available for Redis OSS only. Default is NULL.

" + "smithy.api#documentation": "

The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

" } }, "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of the UserGroup to be associated with the serverless cache. Available for Redis OSS only. \n Default is NULL - the existing UserGroup is not removed.

" + "smithy.api#documentation": "

The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. \n Default is NULL - the existing UserGroup is not removed.

" } }, "SecurityGroupIds": { @@ -12216,13 +12234,25 @@ "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of days for which Elasticache retains automatic snapshots before deleting them. \n Available for Redis OSS and Serverless Memcached only.\n Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. \n The maximum value allowed is 35 days.

" + "smithy.api#documentation": "

The number of days for which Elasticache retains automatic snapshots before deleting them. \n Available for Valkey, Redis OSS and Serverless Memcached only.\n Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. \n The maximum value allowed is 35 days.

" } }, "DailySnapshotTime": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis OSS and Serverless Memcached only.\n The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

" + "smithy.api#documentation": "

The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.\n The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine listed in a serverless cache request. The options are redis, memcached or valkey.

" + } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

Modifies the engine vesion listed in a serverless cache request.

" } } }, @@ -12454,7 +12484,7 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier for the node group (shard). A Redis OSS (cluster mode disabled) replication\n group contains only 1 node group; therefore, the node group ID is 0001. A Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090.\n Optionally, the user can provide the id for a node group.

" + "smithy.api#documentation": "

The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication\n group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090.\n Optionally, the user can provide the id for a node group.

" } }, "Status": { @@ -12498,7 +12528,7 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "

Either the ElastiCache (Redis OSS) supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.

" + "smithy.api#documentation": "

Either the ElastiCache supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.

" } }, "Slots": { @@ -12578,7 +12608,7 @@ "ReadEndpoint": { "target": "com.amazonaws.elasticache#Endpoint", "traits": { - "smithy.api#documentation": "

The information required for client programs to connect to a node for read operations.\n The read endpoint is only applicable on Redis OSS (cluster mode disabled) clusters.

" + "smithy.api#documentation": "

The information required for client programs to connect to a node for read operations.\n The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.

" } }, "PreferredAvailabilityZone": { @@ -12596,7 +12626,7 @@ "CurrentRole": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The role that is currently assigned to the node - primary or\n replica. This member is only applicable for Redis OSS (cluster mode\n disabled) replication groups.

" + "smithy.api#documentation": "

The role that is currently assigned to the node - primary or\n replica. This member is only applicable for Valkey or Redis OSS (cluster mode\n disabled) replication groups.

" } } }, @@ -13140,7 +13170,7 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The new number of cache nodes for the cluster.

\n

For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" + "smithy.api#documentation": "

The new number of cache nodes for the cluster.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" } }, "CacheNodeIdsToRemove": { @@ -13232,7 +13262,7 @@ "UpdateActionStatus": { "target": "com.amazonaws.elasticache#UpdateActionStatus", "traits": { - "smithy.api#documentation": "

The status of the update action on the Redis OSS cluster

" + "smithy.api#documentation": "

The status of the update action on the Valkey or Redis OSS cluster

" } } }, @@ -13278,7 +13308,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible\n for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis OSS or Managing Costs with\n Reserved Nodes for Memcached.

", + "smithy.api#documentation": "

Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible\n for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.

", "smithy.api#examples": [ { "title": "PurchaseReservedCacheNodesOfferings", @@ -13411,7 +13441,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation\n applies any modified cache parameter groups to the cluster. The reboot operation takes\n place as soon as possible, and results in a momentary outage to the cluster. During the\n reboot, the cluster status is set to REBOOTING.

\n

The reboot causes the contents of the cache (for each cache node being rebooted) to be\n lost.

\n

When the reboot is complete, a cluster event is created.

\n

Rebooting a cluster is currently supported on Memcached and Redis OSS (cluster mode\n disabled) clusters. Rebooting is not supported on Redis OSS (cluster mode enabled)\n clusters.

\n

If you make changes to parameters that require a Redis OSS (cluster mode enabled) cluster\n reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

", + "smithy.api#documentation": "

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation\n applies any modified cache parameter groups to the cluster. The reboot operation takes\n place as soon as possible, and results in a momentary outage to the cluster. During the\n reboot, the cluster status is set to REBOOTING.

\n

The reboot causes the contents of the cache (for each cache node being rebooted) to be\n lost.

\n

When the reboot is complete, a cluster event is created.

\n

Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode\n disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled)\n clusters.

\n

If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster\n reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

", "smithy.api#examples": [ { "title": "RebootCacheCluster", @@ -13742,7 +13772,7 @@ "NodeGroups": { "target": "com.amazonaws.elasticache#NodeGroupList", "traits": { - "smithy.api#documentation": "

A list of node groups in this replication group. For Redis OSS (cluster mode disabled)\n replication groups, this is a single-element list. For Redis OSS (cluster mode enabled)\n replication groups, the list contains an entry for each node group (shard).

" + "smithy.api#documentation": "

A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled)\n replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled)\n replication groups, the list contains an entry for each node group (shard).

" } }, "SnapshottingClusterId": { @@ -13754,7 +13784,7 @@ "AutomaticFailover": { "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { - "smithy.api#documentation": "

Indicates the status of automatic failover for this Redis OSS replication group.

" + "smithy.api#documentation": "

Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

" } }, "MultiAZ": { @@ -13796,7 +13826,7 @@ "AuthTokenEnabled": { "target": "com.amazonaws.elasticache#BooleanOptional", "traits": { - "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Redis OSS \n commands.

\n

Default: false\n

" + "smithy.api#documentation": "

A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS \n commands.

\n

Default: false\n

" } }, "AuthTokenLastModifiedDate": { @@ -13862,19 +13892,19 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if you\n want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.

" + "smithy.api#documentation": "

If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you\n want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions.

" } }, "NetworkType": { "target": "com.amazonaws.elasticache#NetworkType", "traits": { - "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

Must be either ipv4 | ipv6 | dual_stack. IPv6\n is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } }, "IpDiscovery": { "target": "com.amazonaws.elasticache#IpDiscovery", "traits": { - "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2\n onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

The network type you choose when modifying a cluster, either ipv4 |\n ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } }, "TransitEncryptionMode": { @@ -13886,12 +13916,18 @@ "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS \n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS \n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + } + }, + "Engine": { + "target": "com.amazonaws.elasticache#String", + "traits": { + "smithy.api#documentation": "

The engine used in a replication group. The options are redis, memcached or valkey.

" } } }, "traits": { - "smithy.api#documentation": "

Contains all of the attributes of a specific Redis OSS replication group.

" + "smithy.api#documentation": "

Contains all of the attributes of a specific Valkey or Redis OSS replication group.

" } }, "com.amazonaws.elasticache#ReplicationGroupAlreadyExistsFault": { @@ -14025,7 +14061,7 @@ "AutomaticFailoverStatus": { "target": "com.amazonaws.elasticache#PendingAutomaticFailoverStatus", "traits": { - "smithy.api#documentation": "

Indicates the status of automatic failover for this Redis OSS replication group.

" + "smithy.api#documentation": "

Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

" } }, "Resharding": { @@ -14067,12 +14103,12 @@ "ClusterMode": { "target": "com.amazonaws.elasticache#ClusterMode", "traits": { - "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" + "smithy.api#documentation": "

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first\n set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect\n using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS\n clients to use cluster mode enabled, you can then complete cluster mode configuration\n and set the cluster mode to Enabled.

" } } }, "traits": { - "smithy.api#documentation": "

The settings to be applied to the Redis OSS replication group, either immediately or\n during the next maintenance window.

" + "smithy.api#documentation": "

The settings to be applied to the Valkey or Redis OSS replication group, either immediately or\n during the next maintenance window.

" } }, "com.amazonaws.elasticache#ReservedCacheNode": { @@ -14093,7 +14129,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

The cache node type for the reserved cache nodes.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "StartTime": { @@ -14254,7 +14290,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

The cache node type for the reserved cache node.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "Duration": { @@ -14422,7 +14458,7 @@ "NodeGroupId": { "target": "com.amazonaws.elasticache#AllowedNodeGroupId", "traits": { - "smithy.api#documentation": "

Either the ElastiCache (Redis OSS) supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.

" + "smithy.api#documentation": "

Either the ElastiCache supplied 4-digit id or a user supplied id for the\n node group these configuration values apply to.

" } }, "PreferredAvailabilityZones": { @@ -14656,7 +14692,7 @@ "UserGroupId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of the user group associated with the serverless cache. Available for Redis OSS only. Default is NULL.

" + "smithy.api#documentation": "

The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

" } }, "SubnetIds": { @@ -14668,13 +14704,13 @@ "SnapshotRetentionLimit": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The current setting for the number of serverless cache snapshots the system will retain. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The current setting for the number of serverless cache snapshots the system will retain. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "DailySnapshotTime": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a\n specific time on a daily basis. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a\n specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, @@ -14771,60 +14807,60 @@ "ServerlessCacheSnapshotName": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The identifier of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The identifier of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "ARN": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "KmsKeyId": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "SnapshotType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The type of snapshot of serverless cache. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The type of snapshot of serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "Status": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The current status of the serverless cache. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The current status of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "CreateTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The date and time that the source serverless cache's metadata and cache data set was obtained for\n the snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The date and time that the source serverless cache's metadata and cache data set was obtained for\n the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "ExpiryTime": { "target": "com.amazonaws.elasticache#TStamp", "traits": { - "smithy.api#documentation": "

The time that the serverless cache snapshot will expire. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The time that the serverless cache snapshot will expire. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "BytesUsedForCache": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The total size of a serverless cache snapshot, in bytes. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The total size of a serverless cache snapshot, in bytes. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "ServerlessCacheConfiguration": { "target": "com.amazonaws.elasticache#ServerlessCacheConfiguration", "traits": { - "smithy.api#documentation": "

The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The configuration of the serverless cache, at the time the snapshot was taken. Available for Valkey, Redis OSS and Serverless Memcached only.

" } } }, "traits": { - "smithy.api#documentation": "

The resource representing a serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

The resource representing a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "com.amazonaws.elasticache#ServerlessCacheSnapshotAlreadyExistsFault": { @@ -14839,7 +14875,7 @@ "code": "ServerlessCacheSnapshotAlreadyExistsFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "

A serverless cache snapshot with this name already exists. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14865,7 +14901,7 @@ "code": "ServerlessCacheSnapshotNotFoundFault", "httpResponseCode": 404 }, - "smithy.api#documentation": "

This serverless cache snapshot could not be found or does not exist. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -14882,7 +14918,7 @@ "code": "ServerlessCacheSnapshotQuotaExceededFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "

The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis OSS and Serverless Memcached only.

", + "smithy.api#documentation": "

The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -14958,13 +14994,13 @@ "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Redis OSS or Memcached.

" + "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

" } }, "EngineVersion": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Elasticache engine version to which the update applies. Either Redis OSS or Memcached\n engine version.

" + "smithy.api#documentation": "

The Elasticache engine version to which the update applies. Either Valkey, Redis OSS or Memcached\n engine version.

" } }, "AutoUpdateAfterRecommendedApplyByDate": { @@ -14981,7 +15017,7 @@ } }, "traits": { - "smithy.api#documentation": "

An update that you can apply to your Redis OSS clusters.

" + "smithy.api#documentation": "

An update that you can apply to your Valkey or Redis OSS clusters.

" } }, "com.amazonaws.elasticache#ServiceUpdateList": { @@ -15184,7 +15220,7 @@ "CacheNodeType": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    Redis OSS configuration variables appendonly and\n appendfsync are not supported on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" + "smithy.api#documentation": "

The name of the compute and memory capacity node type for the source cluster.

\n

The following node types are supported by ElastiCache. Generally speaking, the current\n generation types provide more memory and computational power at lower cost when compared\n to their equivalent previous generation counterparts.

\n
    \n
  • \n

    General purpose:

    \n
      \n
    • \n

      Current generation:

      \n

      \n M7g node types:\n \t\t\t\t\tcache.m7g.large,\n \t\t\t\t\tcache.m7g.xlarge,\n \t\t\t\t\tcache.m7g.2xlarge,\n \t\t\t\t\tcache.m7g.4xlarge,\n \t\t\t\t\tcache.m7g.8xlarge,\n \t\t\t\t\tcache.m7g.12xlarge,\n \t\t\t\t\tcache.m7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t \n\t\t\t\t\t \tcache.m6g.large,\n\t\t\t\t\t\t\tcache.m6g.xlarge,\n\t\t\t\t\t\t\tcache.m6g.2xlarge,\n\t\t\t\t\t\t\tcache.m6g.4xlarge,\n\t\t\t\t\t\t\tcache.m6g.8xlarge,\n\t\t\t\t\t\t\tcache.m6g.12xlarge,\n\t\t\t\t\t\t\tcache.m6g.16xlarge\n

      \n

      \n M5 node types:\n cache.m5.large,\n \t\t\t\t\t\tcache.m5.xlarge,\n \t\t\t\t\t\tcache.m5.2xlarge,\n \t\t\t\t\t\tcache.m5.4xlarge,\n \t\t\t\t\t\tcache.m5.12xlarge,\n \t\t\t\t\t\tcache.m5.24xlarge\n

      \n

      \n M4 node types:\n cache.m4.large,\n \t\t\t\t\t\tcache.m4.xlarge,\n \t\t\t\t\t\tcache.m4.2xlarge,\n \t\t\t\t\t\tcache.m4.4xlarge,\n \t\t\t\t\t\tcache.m4.10xlarge\n

      \n

      \n T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):\n\t\t\t\t\t cache.t4g.micro,\n\t\t\t\t\t cache.t4g.small,\n\t\t\t\t\t cache.t4g.medium\n

      \n

      \n T3 node types:\n cache.t3.micro, \n \t\t\t\t\t\tcache.t3.small,\n \t\t\t\t\t\tcache.t3.medium\n

      \n

      \n T2 node types:\n cache.t2.micro, \n \t\t\t\t\t\tcache.t2.small,\n \t\t\t\t\t\tcache.t2.medium\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n T1 node types:\n cache.t1.micro\n

      \n

      \n M1 node types:\n cache.m1.small, \n\t\t\t\t\t\t cache.m1.medium, \n\t\t\t\t\t\t cache.m1.large,\n\t\t\t\t\t\t cache.m1.xlarge\n

      \n

      \n M3 node types:\n cache.m3.medium,\n \t\t\t\t\t\tcache.m3.large, \n \t\t\t\t\t\tcache.m3.xlarge,\n \t\t\t\t\t\tcache.m3.2xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Compute optimized:

    \n
      \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n C1 node types:\n cache.c1.xlarge\n

      \n
      • \n
    \n
    • \n
  • \n

    Memory optimized:

    \n
      \n
    • \n

      Current generation:

      \n

      \n R7g node types:\t\n\t\t\t\t\t\t\tcache.r7g.large,\n\t\t\t\t\t\t\tcache.r7g.xlarge,\n\t\t\t\t\t\t\tcache.r7g.2xlarge,\n\t\t\t\t\t\t\tcache.r7g.4xlarge,\n\t\t\t\t\t\t\tcache.r7g.8xlarge,\n\t\t\t\t\t\t\tcache.r7g.12xlarge,\n\t\t\t\t\t\t\tcache.r7g.16xlarge\n

      \n \n

      For region availability, see Supported Node Types\n

      \n       \n

      \n R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):\n\t\t\t\t\t\t\tcache.r6g.large,\n\t\t\t\t\t\t\tcache.r6g.xlarge,\n\t\t\t\t\t\t\tcache.r6g.2xlarge,\n\t\t\t\t\t\t\tcache.r6g.4xlarge,\n\t\t\t\t\t\t\tcache.r6g.8xlarge,\n\t\t\t\t\t\t\tcache.r6g.12xlarge,\n\t\t\t\t\t\t\tcache.r6g.16xlarge\n

      \n

      \n R5 node types:\n cache.r5.large,\n \t\t\t\t\t cache.r5.xlarge,\n \t\t\t\t\t cache.r5.2xlarge,\n \t\t\t\t\t cache.r5.4xlarge,\n \t\t\t\t\t cache.r5.12xlarge,\n \t\t\t\t\t cache.r5.24xlarge\n

      \n

      \n R4 node types:\n cache.r4.large,\n \t\t\t\t\t cache.r4.xlarge,\n \t\t\t\t\t cache.r4.2xlarge,\n \t\t\t\t\t cache.r4.4xlarge,\n \t\t\t\t\t cache.r4.8xlarge,\n \t\t\t\t\t cache.r4.16xlarge\n

      \n
      • \n
    • \n

      Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

      \n

      \n M2 node types:\n cache.m2.xlarge, \n \t\t\t\t\t\tcache.m2.2xlarge,\n \t\t\t\t\t\tcache.m2.4xlarge\n

      \n

      \n R3 node types:\n cache.r3.large, \n \t\t\t\t\t\tcache.r3.xlarge,\n \t\t\t\t\t\tcache.r3.2xlarge, \n \t\t\t\t\t\tcache.r3.4xlarge,\n \t\t\t\t\t\tcache.r3.8xlarge\n

      \n
      • \n
    \n
    • \n
\n

\n Additional node type info\n

\n
    \n
  • \n

    All current generation instance types are created in Amazon VPC by\n default.

    \n
    • \n
  • \n

    Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

    \n
    • \n
  • \n

    Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1\n instances.

    \n
    • \n
  • \n

    The configuration variables appendonly and\n appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and\n later.

    \n
    • \n
" } }, "Engine": { @@ -15202,7 +15238,7 @@ "NumCacheNodes": { "target": "com.amazonaws.elasticache#IntegerOptional", "traits": { - "smithy.api#documentation": "

The number of cache nodes in the source cluster.

\n

For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" + "smithy.api#documentation": "

The number of cache nodes in the source cluster.

\n

For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this\n value must be between 1 and 40.

" } }, "PreferredAvailabilityZone": { @@ -15262,7 +15298,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.elasticache#Boolean", "traits": { - "smithy.api#documentation": "

 If you are running Redis OSS engine version 6.0 or later, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" + "smithy.api#documentation": "

 If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if\n you want to opt-in to the next auto minor version upgrade campaign. This parameter is\n disabled for previous versions. 

" } }, "SnapshotRetentionLimit": { @@ -15286,7 +15322,7 @@ "AutomaticFailover": { "target": "com.amazonaws.elasticache#AutomaticFailoverStatus", "traits": { - "smithy.api#documentation": "

Indicates the status of automatic failover for the source Redis OSS replication\n group.

" + "smithy.api#documentation": "

Indicates the status of automatic failover for the source Valkey or Redis OSS replication\n group.

" } }, "NodeSnapshots": { @@ -15315,7 +15351,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a copy of an entire Redis OSS cluster as of the time when the snapshot was\n taken.

" + "smithy.api#documentation": "

Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was\n taken.

" } }, "com.amazonaws.elasticache#SnapshotAlreadyExistsFault": { @@ -15356,7 +15392,7 @@ "code": "SnapshotFeatureNotSupportedFault", "httpResponseCode": 400 }, - "smithy.api#documentation": "

You attempted one of the following operations:

\n
    \n
  • \n

    Creating a snapshot of a Redis OSS cluster running on a\n cache.t1.micro cache node.

    \n
    • \n
  • \n

    Creating a snapshot of a cluster that is running Memcached rather than\n Redis OSS.

    \n
    • \n
\n

Neither of these are supported by ElastiCache.

", + "smithy.api#documentation": "

You attempted one of the following operations:

\n
    \n
  • \n

    Creating a snapshot of a Valkey or Redis OSS cluster running on a\n cache.t1.micro cache node.

    \n
    • \n
  • \n

    Creating a snapshot of a cluster that is running Memcached rather than\n Valkey or Redis OSS.

    \n
    • \n
\n

Neither of these are supported by ElastiCache.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -15504,7 +15540,7 @@ "target": "com.amazonaws.elasticache#CustomerNodeEndpointList", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

List of endpoints from which data should be migrated. For Redis OSS (cluster mode\n disabled), list should have only one element.

", + "smithy.api#documentation": "

List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode\n disabled), the list should have only one element.

", "smithy.api#required": {} } } @@ -15551,7 +15587,7 @@ "SupportedNetworkTypes": { "target": "com.amazonaws.elasticache#NetworkTypeList", "traits": { - "smithy.api#documentation": "

Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine\n version 1.6.6 on all instances built on the Nitro system.

" + "smithy.api#documentation": "

Either ipv4 | ipv6 | dual_stack. IPv6 is\n supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2\n and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

" } } }, @@ -15752,7 +15788,7 @@ } ], "traits": { - "smithy.api#documentation": "

Represents the input of a TestFailover operation which tests automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).

\n

This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API.

\n

\n Note the following\n

\n
    \n
  • \n

    A customer can use this operation to test automatic failover on up to 15 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.

    \n
    • \n
  • \n

    If calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.

    \n

    \n
    • \n
  • \n

    If calling this operation multiple times on different shards in the same Redis OSS (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.

    \n
    • \n
  • \n

    To determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node\n group \n

      \n
      2. \n
    2. \n

      Cache cluster message: Failover from primary node\n to replica node \n completed\n

      \n
      3. \n
    3. \n

      Replication group message: Failover from primary node\n to replica node \n completed\n

      \n
      4. \n
    4. \n

      Cache cluster message: Recovering cache nodes\n \n

      \n
      5. \n
    5. \n

      Cache cluster message: Finished recovery for cache nodes\n \n

      \n
      6. \n
    \n

    For more information see:

    \n \n
    • \n
\n

Also see, Testing\n Multi-AZ in the ElastiCache User Guide.

" + "smithy.api#documentation": "

Represents the input of a TestFailover operation which tests automatic\n failover on a specified node group (called shard in the console) in a replication group\n (called cluster in the console).

\n

This API is designed for testing the behavior of your application in case of\n ElastiCache failover. It is not designed to be an operational tool for initiating a\n failover to overcome a problem you may have with the cluster. Moreover, in certain\n conditions such as large-scale operational events, Amazon may block this API.

\n

\n Note the following\n

\n
    \n
  • \n

    A customer can use this operation to test automatic failover on up to 15 shards\n (called node groups in the ElastiCache API and Amazon CLI) in any rolling\n 24-hour period.

    \n
    • \n
  • \n

    If calling this operation on shards in different clusters (called replication\n groups in the API and CLI), the calls can be made concurrently.

    \n

    \n
    • \n
  • \n

    If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must\n complete before a subsequent call can be made.

    \n
    • \n
  • \n

    To determine whether the node replacement is complete you can check Events\n using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API.\n Look for the following automatic failover related events, listed here in order\n of occurrance:

    \n
      \n
    1. \n

      Replication group message: Test Failover API called for node\n group \n

      \n
      2. \n
    2. \n

      Cache cluster message: Failover from primary node\n to replica node \n completed\n

      \n
      3. \n
    3. \n

      Replication group message: Failover from primary node\n to replica node \n completed\n

      \n
      4. \n
    4. \n

      Cache cluster message: Recovering cache nodes\n \n

      \n
      5. \n
    5. \n

      Cache cluster message: Finished recovery for cache nodes\n \n

      \n
      6. \n
    \n

    For more information see:

    \n \n
    • \n
\n

Also see, Testing\n Multi-AZ in the ElastiCache User Guide.

" } }, "com.amazonaws.elasticache#TestFailoverMessage": { @@ -16066,7 +16102,7 @@ "Engine": { "target": "com.amazonaws.elasticache#String", "traits": { - "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Redis OSS or Memcached.

" + "smithy.api#documentation": "

The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

" } } }, @@ -16315,7 +16351,7 @@ "ServerlessCaches": { "target": "com.amazonaws.elasticache#UGServerlessCacheIdList", "traits": { - "smithy.api#documentation": "

Indicates which serverless caches the specified user group is associated with. Available for Redis OSS and Serverless Memcached only.

" + "smithy.api#documentation": "

Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.

" } }, "ARN": { diff --git a/codegen/sdk/aws-models/emr.json b/codegen/sdk/aws-models/emr.json index 670c426e41f..1dd27524426 100644 --- a/codegen/sdk/aws-models/emr.json +++ b/codegen/sdk/aws-models/emr.json @@ -4568,6 +4568,12 @@ "traits": { "smithy.api#documentation": "

The resize specification for the instance fleet.

" } + }, + "Context": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } }, "traits": { @@ -4620,6 +4626,12 @@ "traits": { "smithy.api#documentation": "

The resize specification for the instance fleet.

" } + }, + "Context": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } }, "traits": { @@ -4675,6 +4687,12 @@ "traits": { "smithy.api#documentation": "

An array of InstanceTypeConfig objects that specify how Amazon EMR provisions Amazon EC2 instances\n when it fulfills On-Demand and Spot capacities. For more information, see InstanceTypeConfig.

" } + }, + "Context": { + "target": "com.amazonaws.emr#XmlStringMaxLen256", + "traits": { + "smithy.api#documentation": "

Reserved.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/fms.json b/codegen/sdk/aws-models/fms.json index 2ed2d7eeab8..2cb7332f6c5 100644 --- a/codegen/sdk/aws-models/fms.json +++ b/codegen/sdk/aws-models/fms.json @@ -4044,7 +4044,7 @@ "PolicyId": { "target": "com.amazonaws.fms#PolicyId", "traits": { - "smithy.api#documentation": "

The ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:

\n
    \n
  • \n

    DNS Firewall

    \n
    • \n
  • \n

    Imported Network Firewall

    \n
    • \n
  • \n

    Network Firewall

    \n
    • \n
  • \n

    Security group content audit

    \n
    • \n
  • \n

    Network ACL

    \n
    • \n
  • \n

    Third-party firewall

    \n
    • \n
", + "smithy.api#documentation": "

The ID of the Firewall Manager policy that you want the details for. You can get violation details for the following policy types:

\n
    \n
  • \n

    WAF

    \n
    • \n
  • \n

    DNS Firewall

    \n
    • \n
  • \n

    Imported Network Firewall

    \n
    • \n
  • \n

    Network Firewall

    \n
    • \n
  • \n

    Security group content audit

    \n
    • \n
  • \n

    Network ACL

    \n
    • \n
  • \n

    Third-party firewall

    \n
    • \n
", "smithy.api#required": {} } }, @@ -4065,7 +4065,7 @@ "ResourceType": { "target": "com.amazonaws.fms#ResourceType", "traits": { - "smithy.api#documentation": "

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference.\n Supported resource types are:\n AWS::EC2::Instance,\n AWS::EC2::NetworkInterface,\n AWS::EC2::SecurityGroup,\n AWS::NetworkFirewall::FirewallPolicy, and\n AWS::EC2::Subnet.\n

", + "smithy.api#documentation": "

The resource type. This is in the format shown in the Amazon Web Services Resource Types Reference.\n Supported resource types are:\n AWS::WAFv2::WebACL,\n AWS::EC2::Instance,\n AWS::EC2::NetworkInterface,\n AWS::EC2::SecurityGroup,\n AWS::NetworkFirewall::FirewallPolicy, and\n AWS::EC2::Subnet.\n

", "smithy.api#required": {} } } @@ -7201,6 +7201,12 @@ "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, + "com.amazonaws.fms#ResourceArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.fms#ResourceArn" + } + }, "com.amazonaws.fms#ResourceCount": { "type": "long", "traits": { @@ -7595,6 +7601,18 @@ "traits": { "smithy.api#documentation": "

A list of possible remediation action lists. Each individual possible remediation action is a list of individual remediation actions.

" } + }, + "WebACLHasIncompatibleConfigurationViolation": { + "target": "com.amazonaws.fms#WebACLHasIncompatibleConfigurationViolation", + "traits": { + "smithy.api#documentation": "

The violation details for a web ACL whose configuration is incompatible with the Firewall Manager policy.

" + } + }, + "WebACLHasOutOfScopeResourcesViolation": { + "target": "com.amazonaws.fms#WebACLHasOutOfScopeResourcesViolation", + "traits": { + "smithy.api#documentation": "

The violation details for a web ACL that's associated with at least one resource that's out of scope of the Firewall Manager policy.

" + } } }, "traits": { @@ -7838,7 +7856,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.

\n
    \n
  • \n

    Example: DNS_FIREWALL\n

    \n

    \n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n

    \n \n

    Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.

    \n     \n
    • \n
  • \n

    Example: IMPORT_NETWORK_FIREWALL\n

    \n

    \n \"{\\\"type\\\":\\\"IMPORT_NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-2:000000000000:stateless-rulegroup\\/rg1\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:drop\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:pass\\\"],\\\"networkFirewallStatelessCustomActions\\\":[],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-2:aws-managed:stateful-rulegroup\\/ThreatSignaturesEmergingEventsStrictOrder\\\",\\\"priority\\\":8}],\\\"networkFirewallStatefulEngineOptions\\\":{\\\"ruleOrder\\\":\\\"STRICT_ORDER\\\"},\\\"networkFirewallStatefulDefaultActions\\\":[\\\"aws:drop_strict\\\"]}}\"\n

    \n

    \n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n

    \n \n

    Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.

    \n     \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Centralized deployment\n model

    \n

    \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

    \n

    To use the centralized deployment model, you must set PolicyOption to\n CENTRALIZED.

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration

    \n

    \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

    \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.

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration and route management

    \n

    \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

    \n

    To use the distributed deployment model, you must set PolicyOption to\n NULL.

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n custom 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\\\",\\\"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

    \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

    \n

    To use the distributed deployment model, you must set PolicyOption to\n NULL.

    \n
    • \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}],\\\"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

    \n

    To use the distributed deployment model, you must set PolicyOption to\n NULL.

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_COMMON\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\n \\\"applyToAllEC2InstanceENIs\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\"\n sg-000e55995d61a06bd\\\"}]}\"\n

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_COMMON - Security group tag distribution\n

    \n

    \n \"\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"revertManualSecurityGroupChanges\\\":true,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":false,\\\"enableTagDistribution\\\":true}\"\"\n

    \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

    \n Firewall Manager won't distribute system tags added by Amazon Web Services services into the replica security groups. System tags begin with the aws: prefix.\n

    \n
    • \n
  • \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

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_CONTENT_AUDIT\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n

    \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.

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_USAGE_AUDIT\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"\n

    \n
    • \n
  • \n

    Example: SHIELD_ADVANCED with web ACL management

    \n

    \n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"optimizeUnassociatedWebACL\\\":true}\"\n

    \n

    If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.

    \n

    Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager doesn't disassociate the resource from the web ACL. If you want Firewall Manager to clean up the web ACL, you must first manually disassociate the resources from the web ACL, and then enable the manage unused web ACLs option in your policy.

    \n

    If you set optimizeUnassociatedWebACL to false, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.

    \n
    • \n
  • \n

    Specification for SHIELD_ADVANCED for Amazon CloudFront distributions

    \n

    \n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false, \\\"optimizeUnassociatedWebACL\\\":true|false}\"\n

    \n

    For example:\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"\n

    \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.

    \n

    For other resource types that you can protect with a Shield Advanced policy, this\n ManagedServiceData configuration is an empty string.

    \n
    • \n
  • \n

    Example: THIRD_PARTY_FIREWALL\n

    \n

    Replace THIRD_PARTY_FIREWALL_NAME with the name of the third-party firewall.

    \n

    \n \"{\n \"type\":\"THIRD_PARTY_FIREWALL\",\n \"thirdPartyFirewall\":\"THIRD_PARTY_FIREWALL_NAME\",\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

    \n
    • \n
  • \n

    Example: WAFV2 - Account takeover prevention, Bot Control managed rule groups, optimize unassociated web ACL, and rule action override\n

    \n

    \n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesATPRuleSet\\\",\\\"managedRuleGroupConfigs\\\":[{\\\"awsmanagedRulesATPRuleSet\\\":{\\\"loginPath\\\":\\\"/loginpath\\\",\\\"requestInspection\\\":{\\\"payloadType\\\":\\\"FORM_ENCODED|JSON\\\",\\\"usernameField\\\":{\\\"identifier\\\":\\\"/form/username\\\"},\\\"passwordField\\\":{\\\"identifier\\\":\\\"/form/password\\\"}}}}]},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true},{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesBotControlRuleSet\\\",\\\"managedRuleGroupConfigs\\\":[{\\\"awsmanagedRulesBotControlRuleSet\\\":{\\\"inspectionLevel\\\":\\\"TARGETED|COMMON\\\"}}]},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true,\\\"ruleActionOverrides\\\":[{\\\"name\\\":\\\"Rule1\\\",\\\"actionToUse\\\":{\\\"allow|block|count|captcha|challenge\\\":{}}},{\\\"name\\\":\\\"Rule2\\\",\\\"actionToUse\\\":{\\\"allow|block|count|captcha|challenge\\\":{}}}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":null,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"optimizeUnassociatedWebACL\\\":true}\"\n

    \n
      \n
    • \n

      Bot Control - For information about AWSManagedRulesBotControlRuleSet managed rule groups, see AWSManagedRulesBotControlRuleSet in the WAF API Reference.

      \n
      • \n
    • \n

      Fraud Control account takeover prevention (ATP) - For information about the properties available for AWSManagedRulesATPRuleSet managed rule groups, see AWSManagedRulesATPRuleSet in the WAF API Reference.

      \n
      • \n
    • \n

      Optimize unassociated web ACL - If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.

      \n

      Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager disassociates the resource from the web ACL, but won't clean up the unused web ACL. Firewall Manager only cleans up unused web ACLs when you first enable management of unused web ACLs in a policy.

      \n

      If you set optimizeUnassociatedWebACL to false Firewall Manager doesn't manage unused web ACLs, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.

      \n
      • \n
    • \n

      Rule action overrides - Firewall Manager supports rule action overrides only for managed rule groups. To configure a RuleActionOverrides add the Name of the rule to override, and ActionToUse, which is the new action to use for the rule. For information about using rule action override, see RuleActionOverride in the WAF API Reference.

      \n
      • \n
    \n
    • \n
  • \n

    Example: WAFV2 - CAPTCHA and Challenge configs\n

    \n

    \n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":null,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"captchaConfig\\\":{\\\"immunityTimeProperty\\\":{\\\"immunityTime\\\":500}},\\\"challengeConfig\\\":{\\\"immunityTimeProperty\\\":{\\\"immunityTime\\\":800}},\\\"tokenDomains\\\":[\\\"google.com\\\",\\\"amazon.com\\\"],\\\"associationConfig\\\":{\\\"requestBody\\\":{\\\"CLOUDFRONT\\\":{\\\"defaultSizeInspectionLimit\\\":\\\"KB_16\\\"}}}}\"\n

    \n
      \n
    • \n

      \n CAPTCHA and Challenge configs - If you update the policy's values for associationConfig, captchaConfig, challengeConfig, or tokenDomains, Firewall Manager will overwrite your local web ACLs to contain the new value(s). However, if you don't update the policy's associationConfig, captchaConfig, challengeConfig, or tokenDomains values, the values in your local web ACLs will remain unchanged. For information about association configs, see AssociationConfig. For information about CAPTCHA and Challenge configs, see CaptchaConfig and ChallengeConfig in the WAF API Reference.

      \n
      • \n
    • \n

      \n defaultSizeInspectionLimit - Specifies the maximum size of the web request body component that an associated Amazon CloudFront distribution should send to WAF for inspection. For more information, see DefaultSizeInspectionLimit in the WAF API Reference.

      \n
      • \n
    \n
    • \n
  • \n

    Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning\n

    \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

    \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

    \n
    • \n
  • \n

    Example: WAFV2 - Logging configurations\n

    \n

    \n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null, \\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\": {\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\", \\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\"} ,\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[], \\\"sampledRequestsEnabled\\\":true}],\\\"postProcessRuleGroups\\\":[], \\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\" :null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\" :false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\": [\\\"arn:aws:s3:::aws-waf-logs-example-bucket\\\"] ,\\\"redactedFields\\\":[],\\\"loggingFilterConfigs\\\":{\\\"defaultBehavior\\\":\\\"KEEP\\\", \\\"filters\\\":[{\\\"behavior\\\":\\\"KEEP\\\",\\\"requirement\\\":\\\"MEETS_ALL\\\", \\\"conditions\\\":[{\\\"actionCondition\\\":\\\"CAPTCHA\\\"},{\\\"actionCondition\\\": \\\"CHALLENGE\\\"}, {\\\"actionCondition\\\":\\\"EXCLUDED_AS_COUNT\\\"}]}]}},\\\"sampledRequestsEnabledForDefaultActions\\\":true}\"\n

    \n

    Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the logDestinationConfigs in your loggingConfiguration. For information about WAF logging configurations, see LoggingConfiguration in the WAF API Reference\n

    \n

    In the loggingConfiguration, you can specify one\n logDestinationConfigs. Optionally provide as many as 20\n redactedFields. The RedactedFieldType must be one of\n URI, QUERY_STRING, HEADER, or\n METHOD.

    \n
    • \n
  • \n

    Example: WAF Classic\n

    \n

    \n \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\":\n [{\\\"id\\\":\\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\":\n \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}\"\n

    \n
    • \n
" + "smithy.api#documentation": "

Details about the service that are specific to the service type, in JSON format.

\n
    \n
  • \n

    Example: DNS_FIREWALL\n

    \n

    \n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n

    \n \n

    Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.

    \n     \n
    • \n
  • \n

    Example: IMPORT_NETWORK_FIREWALL\n

    \n

    \n \"{\\\"type\\\":\\\"IMPORT_NETWORK_FIREWALL\\\",\\\"awsNetworkFirewallConfig\\\":{\\\"networkFirewallStatelessRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-2:000000000000:stateless-rulegroup\\/rg1\\\",\\\"priority\\\":1}],\\\"networkFirewallStatelessDefaultActions\\\":[\\\"aws:drop\\\"],\\\"networkFirewallStatelessFragmentDefaultActions\\\":[\\\"aws:pass\\\"],\\\"networkFirewallStatelessCustomActions\\\":[],\\\"networkFirewallStatefulRuleGroupReferences\\\":[{\\\"resourceARN\\\":\\\"arn:aws:network-firewall:us-west-2:aws-managed:stateful-rulegroup\\/ThreatSignaturesEmergingEventsStrictOrder\\\",\\\"priority\\\":8}],\\\"networkFirewallStatefulEngineOptions\\\":{\\\"ruleOrder\\\":\\\"STRICT_ORDER\\\"},\\\"networkFirewallStatefulDefaultActions\\\":[\\\"aws:drop_strict\\\"]}}\"\n

    \n

    \n \"{\\\"type\\\":\\\"DNS_FIREWALL\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-1\\\",\\\"priority\\\":10}],\\\"postProcessRuleGroups\\\":[{\\\"ruleGroupId\\\":\\\"rslvr-frg-2\\\",\\\"priority\\\":9911}]}\"\n

    \n \n

    Valid values for preProcessRuleGroups are between 1 and 99. Valid\n values for postProcessRuleGroups are between 9901 and 10000.

    \n     \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Centralized deployment\n model

    \n

    \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

    \n

    To use the centralized deployment model, you must set PolicyOption to\n CENTRALIZED.

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration

    \n

    \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

    \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.

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n automatic Availability Zone configuration and route management

    \n

    \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

    \n

    To use the distributed deployment model, you must set PolicyOption to\n NULL.

    \n
    • \n
  • \n

    Example: NETWORK_FIREWALL - Distributed deployment model with\n custom 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\\\",\\\"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

    \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

    \n

    To use the distributed deployment model, you must set PolicyOption to\n NULL.

    \n
    • \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}],\\\"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

    \n

    To use the distributed deployment model, you must set PolicyOption to\n NULL.

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_COMMON\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-03b1f67d69ed00197\\\"}],\\\"revertManualSecurityGroupChanges\\\":true,\\\"exclusiveResourceSecurityGroupManagement\\\":true,\\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":true,\\\"enableSecurityGroupReferencesDistribution\\\":true}\"\n

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_COMMON - Security group tag distribution\n

    \n

    \n \"\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-000e55995d61a06bd\\\"}],\\\"revertManualSecurityGroupChanges\\\":true,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\\\"applyToAllEC2InstanceENIs\\\":false,\\\"includeSharedVPC\\\":false,\\\"enableTagDistribution\\\":true}\"\"\n

    \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

    \n Firewall Manager won't distribute system tags added by Amazon Web Services services into the replica security groups. System tags begin with the aws: prefix.\n

    \n
    • \n
  • \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

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_CONTENT_AUDIT\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"preManagedOptions\\\":[{\\\"denyProtocolAllValue\\\":true},{\\\"auditSgDirection\\\":{\\\"type\\\":\\\"ALL\\\"}}],\\\"securityGroups\\\":[{\\\"id\\\":\\\"sg-049b2393a25468971\\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"\n

    \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.

    \n
    • \n
  • \n

    Example: SECURITY_GROUPS_USAGE_AUDIT\n

    \n

    \n \"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true,\\\"optionalDelayForUnusedInMinutes\\\":60}\"\n

    \n
    • \n
  • \n

    Example: SHIELD_ADVANCED with web ACL management

    \n

    \n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"optimizeUnassociatedWebACL\\\":true}\"\n

    \n

    If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.

    \n

    Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager doesn't disassociate the resource from the web ACL. If you want Firewall Manager to clean up the web ACL, you must first manually disassociate the resources from the web ACL, and then enable the manage unused web ACLs option in your policy.

    \n

    If you set optimizeUnassociatedWebACL to false, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.

    \n
    • \n
  • \n

    Specification for SHIELD_ADVANCED for Amazon CloudFront distributions

    \n

    \n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\": {\\\"automaticResponseStatus\\\":\\\"ENABLED|IGNORED|DISABLED\\\", \\\"automaticResponseAction\\\":\\\"BLOCK|COUNT\\\"}, \\\"overrideCustomerWebaclClassic\\\":true|false, \\\"optimizeUnassociatedWebACL\\\":true|false}\"\n

    \n

    For example:\n \"{\\\"type\\\":\\\"SHIELD_ADVANCED\\\",\\\"automaticResponseConfiguration\\\":\n {\\\"automaticResponseStatus\\\":\\\"ENABLED\\\",\n \\\"automaticResponseAction\\\":\\\"COUNT\\\"}}\"\n

    \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.

    \n

    For other resource types that you can protect with a Shield Advanced policy, this\n ManagedServiceData configuration is an empty string.

    \n
    • \n
  • \n

    Example: THIRD_PARTY_FIREWALL\n

    \n

    Replace THIRD_PARTY_FIREWALL_NAME with the name of the third-party firewall.

    \n

    \n \"{\n \"type\":\"THIRD_PARTY_FIREWALL\",\n \"thirdPartyFirewall\":\"THIRD_PARTY_FIREWALL_NAME\",\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

    \n
    • \n
  • \n

    Example: WAFV2 - Account takeover prevention, Bot Control managed rule groups, optimize unassociated web ACL, and rule action override\n

    \n

    \n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesATPRuleSet\\\",\\\"managedRuleGroupConfigs\\\":[{\\\"awsmanagedRulesATPRuleSet\\\":{\\\"loginPath\\\":\\\"/loginpath\\\",\\\"requestInspection\\\":{\\\"payloadType\\\":\\\"FORM_ENCODED|JSON\\\",\\\"usernameField\\\":{\\\"identifier\\\":\\\"/form/username\\\"},\\\"passwordField\\\":{\\\"identifier\\\":\\\"/form/password\\\"}}}}]},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true},{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesBotControlRuleSet\\\",\\\"managedRuleGroupConfigs\\\":[{\\\"awsmanagedRulesBotControlRuleSet\\\":{\\\"inspectionLevel\\\":\\\"TARGETED|COMMON\\\"}}]},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true,\\\"ruleActionOverrides\\\":[{\\\"name\\\":\\\"Rule1\\\",\\\"actionToUse\\\":{\\\"allow|block|count|captcha|challenge\\\":{}}},{\\\"name\\\":\\\"Rule2\\\",\\\"actionToUse\\\":{\\\"allow|block|count|captcha|challenge\\\":{}}}]}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":null,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"optimizeUnassociatedWebACL\\\":true}\"\n

    \n
      \n
    • \n

      Bot Control - For information about AWSManagedRulesBotControlRuleSet managed rule groups, see AWSManagedRulesBotControlRuleSet in the WAF API Reference.

      \n
      • \n
    • \n

      Fraud Control account takeover prevention (ATP) - For information about the properties available for AWSManagedRulesATPRuleSet managed rule groups, see AWSManagedRulesATPRuleSet in the WAF API Reference.

      \n
      • \n
    • \n

      Optimize unassociated web ACL - If you set optimizeUnassociatedWebACL to true, Firewall Manager creates web ACLs in accounts within the policy scope if the web ACLs will be used by at least one resource. Firewall Manager creates web ACLs in the accounts within policy scope only if the web ACLs will be used by at least one resource. If at any time an account comes into policy scope, Firewall Manager automatically creates a web ACL in the account if at least one resource will use the web ACL.

      \n

      Upon enablement, Firewall Manager performs a one-time cleanup of unused web ACLs in your account. The cleanup process can take several hours. If a resource leaves policy scope after Firewall Manager creates a web ACL, Firewall Manager disassociates the resource from the web ACL, but won't clean up the unused web ACL. Firewall Manager only cleans up unused web ACLs when you first enable management of unused web ACLs in a policy.

      \n

      If you set optimizeUnassociatedWebACL to false Firewall Manager doesn't manage unused web ACLs, and Firewall Manager automatically creates an empty web ACL in each account that's within policy scope.

      \n
      • \n
    • \n

      Rule action overrides - Firewall Manager supports rule action overrides only for managed rule groups. To configure a RuleActionOverrides add the Name of the rule to override, and ActionToUse, which is the new action to use for the rule. For information about using rule action override, see RuleActionOverride in the WAF API Reference.

      \n
      • \n
    \n
    • \n
  • \n

    Example: WAFV2 - CAPTCHA and Challenge configs\n

    \n

    \n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null,\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\":{\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\"},\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[],\\\"sampledRequestsEnabled\\\":true}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\":false,\\\"loggingConfiguration\\\":null,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"captchaConfig\\\":{\\\"immunityTimeProperty\\\":{\\\"immunityTime\\\":500}},\\\"challengeConfig\\\":{\\\"immunityTimeProperty\\\":{\\\"immunityTime\\\":800}},\\\"tokenDomains\\\":[\\\"google.com\\\",\\\"amazon.com\\\"],\\\"associationConfig\\\":{\\\"requestBody\\\":{\\\"CLOUDFRONT\\\":{\\\"defaultSizeInspectionLimit\\\":\\\"KB_16\\\"}}}}\"\n

    \n
      \n
    • \n

      \n CAPTCHA and Challenge configs - If you update the policy's values for associationConfig, captchaConfig, challengeConfig, or tokenDomains, Firewall Manager will overwrite your local web ACLs to contain the new value(s). However, if you don't update the policy's associationConfig, captchaConfig, challengeConfig, or tokenDomains values, the values in your local web ACLs will remain unchanged. For information about association configs, see AssociationConfig. For information about CAPTCHA and Challenge configs, see CaptchaConfig and ChallengeConfig in the WAF API Reference.

      \n
      • \n
    • \n

      \n defaultSizeInspectionLimit - Specifies the maximum size of the web request body component that an associated Amazon CloudFront distribution should send to WAF for inspection. For more information, see DefaultSizeInspectionLimit in the WAF API Reference.

      \n
      • \n
    \n
    • \n
  • \n

    Example: WAFV2 - Firewall Manager support for WAF managed rule group versioning\n

    \n

    \n \"{\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"sampledRequestsEnabled\\\":true,\\\"managedRuleGroupIdentifier\\\":{\\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\",\\\"vendorName\\\":\\\"AWS\\\",\\\"managedRuleGroupConfigs\\\":null}}],\\\"postProcessRuleGroups\\\":[],\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\":null,\\\"tokenDomains\\\":null,\\\"customResponse\\\":null,\\\"type\\\":\\\"WAFV2\\\",\\\"overrideCustomerWebACLAssociation\\\":false,\\\"sampledRequestsEnabledForDefaultActions\\\":true,\\\"optimizeUnassociatedWebACL\\\":true,\\\"webACLSource\\\":\\\"RETROFIT_EXISTING\\\"}\"\n

    \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

    \n
    • \n
  • \n

    Example: WAFV2 - Logging configurations\n

    \n

    \n \"{\\\"type\\\":\\\"WAFV2\\\",\\\"preProcessRuleGroups\\\":[{\\\"ruleGroupArn\\\":null, \\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"},\\\"managedRuleGroupIdentifier\\\": {\\\"versionEnabled\\\":null,\\\"version\\\":null,\\\"vendorName\\\":\\\"AWS\\\", \\\"managedRuleGroupName\\\":\\\"AWSManagedRulesAdminProtectionRuleSet\\\"} ,\\\"ruleGroupType\\\":\\\"ManagedRuleGroup\\\",\\\"excludeRules\\\":[], \\\"sampledRequestsEnabled\\\":true}],\\\"postProcessRuleGroups\\\":[], \\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"customRequestHandling\\\" :null,\\\"customResponse\\\":null,\\\"overrideCustomerWebACLAssociation\\\" :false,\\\"loggingConfiguration\\\":{\\\"logDestinationConfigs\\\": [\\\"arn:aws:s3:::aws-waf-logs-example-bucket\\\"] ,\\\"redactedFields\\\":[],\\\"loggingFilterConfigs\\\":{\\\"defaultBehavior\\\":\\\"KEEP\\\", \\\"filters\\\":[{\\\"behavior\\\":\\\"KEEP\\\",\\\"requirement\\\":\\\"MEETS_ALL\\\", \\\"conditions\\\":[{\\\"actionCondition\\\":\\\"CAPTCHA\\\"},{\\\"actionCondition\\\": \\\"CHALLENGE\\\"}, {\\\"actionCondition\\\":\\\"EXCLUDED_AS_COUNT\\\"}]}]}},\\\"sampledRequestsEnabledForDefaultActions\\\":true}\"\n

    \n

    Firewall Manager supports Amazon Kinesis Data Firehose and Amazon S3 as the logDestinationConfigs in your loggingConfiguration. For information about WAF logging configurations, see LoggingConfiguration in the WAF API Reference\n

    \n

    In the loggingConfiguration, you can specify one\n logDestinationConfigs. Optionally provide as many as 20\n redactedFields. The RedactedFieldType must be one of\n URI, QUERY_STRING, HEADER, or\n METHOD.

    \n
    • \n
  • \n

    Example: WAF Classic\n

    \n

    \n \"{\\\"ruleGroups\\\":[{\\\"id\\\":\\\"78cb36c0-1b5e-4d7d-82b2-cf48d3ad9659\\\",\\\"overrideAction\\\":{\\\"type\\\":\\\"NONE\\\"}}],\\\"overrideCustomerWebACLAssociation\\\":true,\\\"defaultAction\\\":{\\\"type\\\":\\\"ALLOW\\\"},\\\"type\\\":\\\"WAF\\\"}\"\n

    \n
    • \n
" } }, "PolicyOption": { @@ -8761,6 +8779,12 @@ "traits": { "smithy.api#enumValue": "INVALID_NETWORK_ACL_ENTRY" } + }, + "WebACLConfigurationOrScopeOfUse": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEB_ACL_CONFIGURATION_OR_SCOPE_OF_USE" + } } } }, @@ -8773,6 +8797,46 @@ }, "smithy.api#pattern": ".*" } + }, + "com.amazonaws.fms#WebACLHasIncompatibleConfigurationViolation": { + "type": "structure", + "members": { + "WebACLArn": { + "target": "com.amazonaws.fms#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

" + } + }, + "Description": { + "target": "com.amazonaws.fms#LengthBoundedString", + "traits": { + "smithy.api#documentation": "

Information about the problems that Firewall Manager encountered with the web ACL configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The violation details for a web ACL whose configuration is incompatible with the Firewall Manager policy.

" + } + }, + "com.amazonaws.fms#WebACLHasOutOfScopeResourcesViolation": { + "type": "structure", + "members": { + "WebACLArn": { + "target": "com.amazonaws.fms#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the web ACL.

" + } + }, + "OutOfScopeResourceList": { + "target": "com.amazonaws.fms#ResourceArnList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Name (ARN) for the resources that are out of scope of the policy and are associated with the web ACL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The violation details for a web ACL that's associated with at least one resource that's out of scope of the Firewall Manager policy.

" + } } } } diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index 76702f73e2b..c021226bc6a 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -2218,7 +2218,7 @@ "Path": { "target": "com.amazonaws.fsx#ArchivePath", "traits": { - "smithy.api#documentation": "

Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. \n The Path you provide must be located within the file system’s ExportPath. \n An example Path value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report:\n FilePath, FileStatus, and ErrorCode.

" + "smithy.api#documentation": "

Required if Enabled is set to true. Specifies the location of the report on the file system's\n linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. \n The Path you provide must be located within the file system’s ExportPath. \n An example Path value is \"s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix\".\n The report provides the following information for each file in the report:\n FilePath, FileStatus, and ErrorCode.

" } }, "Format": { @@ -2644,7 +2644,7 @@ "target": "com.amazonaws.fsx#ArchivePath", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The path to the Amazon S3 data repository that will be linked to the file\n system. The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix/. This path specifies where in the S3\n data repository files will be imported from or exported to.

", + "smithy.api#documentation": "

The path to the Amazon S3 data repository that will be linked to the file\n system. The path can be an S3 bucket or prefix in the format\n s3://bucket-name/prefix/ (where prefix\n is optional). This path specifies where in the S3 data repository\n files will be imported from or exported to.

", "smithy.api#required": {} } }, @@ -2744,7 +2744,7 @@ "Paths": { "target": "com.amazonaws.fsx#DataRepositoryTaskPaths", "traits": { - "smithy.api#documentation": "

A list of paths for the data repository task to use when the task is processed.\n If a path that you provide isn't valid, the task fails. If you don't provide\n paths, the default behavior is to export all files to S3 (for export tasks), import\n all files from S3 (for import tasks), or release all exported files that meet the\n last accessed time criteria (for release tasks).

\n
    \n
  • \n

    For export tasks, the list contains paths on the FSx for Lustre file system\n from which the files are exported to the Amazon S3 bucket. The default path is the\n file system root directory. The paths you provide need to be relative to the mount\n point of the file system. If the mount point is /mnt/fsx and\n /mnt/fsx/path1 is a directory or file on the file system you want\n to export, then the path to provide is path1.

    \n
    • \n
  • \n

    For import tasks, the list contains paths in the Amazon S3 bucket\n from which POSIX metadata changes are imported to the FSx for Lustre file system.\n The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix (where myPrefix is optional).\n

    \n
    • \n
  • \n

    For release tasks, the list contains directory or file paths on the\n FSx for Lustre file system from which to release exported files. If a directory is\n specified, files within the directory are released. If a file path is specified,\n only that file is released. To release all exported files in the file system,\n specify a forward slash (/) as the path.

    \n \n

    A file must also meet the last accessed time criteria\n specified in for the\n file to be released.

    \n     \n
    • \n
" + "smithy.api#documentation": "

A list of paths for the data repository task to use when the task is processed.\n If a path that you provide isn't valid, the task fails. If you don't provide\n paths, the default behavior is to export all files to S3 (for export tasks), import\n all files from S3 (for import tasks), or release all exported files that meet the\n last accessed time criteria (for release tasks).

\n
    \n
  • \n

    For export tasks, the list contains paths on the FSx for Lustre file system\n from which the files are exported to the Amazon S3 bucket. The default path is the\n file system root directory. The paths you provide need to be relative to the mount\n point of the file system. If the mount point is /mnt/fsx and\n /mnt/fsx/path1 is a directory or file on the file system you want\n to export, then the path to provide is path1.

    \n
    • \n
  • \n

    For import tasks, the list contains paths in the Amazon S3 bucket\n from which POSIX metadata changes are imported to the FSx for Lustre file system.\n The path can be an S3 bucket or prefix in the format\n s3://bucket-name/prefix (where prefix is optional).

    \n
    • \n
  • \n

    For release tasks, the list contains directory or file paths on the\n FSx for Lustre file system from which to release exported files. If a directory is\n specified, files within the directory are released. If a file path is specified,\n only that file is released. To release all exported files in the file system,\n specify a forward slash (/) as the path.

    \n \n

    A file must also meet the last accessed time criteria\n specified in for the\n file to be released.

    \n     \n
    • \n
" } }, "FileSystemId": { @@ -4282,7 +4282,7 @@ "DataRepositoryPath": { "target": "com.amazonaws.fsx#ArchivePath", "traits": { - "smithy.api#documentation": "

The path to the data repository that will be linked to the cache\n or file system.

\n
    \n
  • \n

    For Amazon File Cache, the path can be an NFS data repository\n that will be linked to the cache. The path can be in one of two formats:

    \n
      \n
    • \n

      If you are not using the DataRepositorySubdirectories\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nsf://nfs-domain-name/exportpath. You can therefore\n link a single NFS Export to a single data repository association.

      \n
      • \n
    • \n

      If you are using the DataRepositorySubdirectories\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories\n parameter.

      \n
      • \n
    \n
    • \n
  • \n

    For Amazon File Cache, the path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/.

    \n
    • \n
  • \n

    For Amazon FSx for Lustre, the path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/.

    \n
    • \n
" + "smithy.api#documentation": "

The path to the data repository that will be linked to the cache\n or file system.

\n
    \n
  • \n

    For Amazon File Cache, the path can be an NFS data repository\n that will be linked to the cache. The path can be in one of two formats:

    \n
      \n
    • \n

      If you are not using the DataRepositorySubdirectories\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nsf://nfs-domain-name/exportpath. You can therefore\n link a single NFS Export to a single data repository association.

      \n
      • \n
    • \n

      If you are using the DataRepositorySubdirectories\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories\n parameter.

      \n
      • \n
    \n
    • \n
  • \n

    For Amazon File Cache, the path can be an S3 bucket or prefix\n in the format s3://bucket-name/prefix/ (where prefix\n is optional).

    \n
    • \n
  • \n

    For Amazon FSx for Lustre, the path can be an S3 bucket or prefix\n in the format s3://bucket-name/prefix/ (where prefix\n is optional).

    \n
    • \n
" } }, "BatchImportMetaDataOnCreate": { @@ -6817,7 +6817,7 @@ "target": "com.amazonaws.fsx#ArchivePath", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:

\n
    \n
  • \n

    The path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:

    \n
      \n
    • \n

      If you are not using the DataRepositorySubdirectories\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nfs://nfs-domain-name/exportpath. You can therefore\n link a single NFS Export to a single data repository association.

      \n
      • \n
    • \n

      If you are using the DataRepositorySubdirectories\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories\n parameter.

      \n
      • \n
    \n
    • \n
  • \n

    The path can be an S3 bucket or prefix\n in the format s3://myBucket/myPrefix/.

    \n
    • \n
", + "smithy.api#documentation": "

The path to the S3 or NFS data repository that links to the\n cache. You must provide one of the following paths:

\n
    \n
  • \n

    The path can be an NFS data repository that links to\n the cache. The path can be in one of two formats:

    \n
      \n
    • \n

      If you are not using the DataRepositorySubdirectories\n parameter, the path is to an NFS Export directory (or one of its subdirectories)\n in the format nfs://nfs-domain-name/exportpath. You can therefore\n link a single NFS Export to a single data repository association.

      \n
      • \n
    • \n

      If you are using the DataRepositorySubdirectories\n parameter, the path is the domain name of the NFS file system in the format\n nfs://filer-domain-name, which indicates the root of the\n subdirectories specified with the DataRepositorySubdirectories\n parameter.

      \n
      • \n
    \n
    • \n
  • \n

    The path can be an S3 bucket or prefix\n in the format s3://bucket-name/prefix/ (where prefix\n is optional).

    \n
    • \n
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/guardduty.json b/codegen/sdk/aws-models/guardduty.json index 3e052ca8466..e81b116ea54 100644 --- a/codegen/sdk/aws-models/guardduty.json +++ b/codegen/sdk/aws-models/guardduty.json @@ -11049,6 +11049,13 @@ "smithy.api#jsonName": "localIpDetails" } }, + "LocalNetworkInterface": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "

The EC2 instance's local elastic network interface utilized for the connection.

", + "smithy.api#jsonName": "localNetworkInterface" + } + }, "RemoteIpDetails": { "target": "com.amazonaws.guardduty#RemoteIpDetails", "traits": { diff --git a/codegen/sdk/aws-models/iot-data-plane.json b/codegen/sdk/aws-models/iot-data-plane.json index 08866867f5f..1b58de88f6a 100644 --- a/codegen/sdk/aws-models/iot-data-plane.json +++ b/codegen/sdk/aws-models/iot-data-plane.json @@ -273,7 +273,23 @@ "method": "GET", "uri": "/things/{thingName}/shadow", "code": 200 - } + }, + "smithy.test#smokeTests": [ + { + "id": "GetThingShadowFailure", + "params": { + "thingName": "fake-thing" + }, + "vendorParams": { + "region": "us-west-2", + "uri": "https://data-ats.iot.us-west-2.amazonaws.com" + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "failure": {} + } + } + ] } }, "com.amazonaws.iotdataplane#GetThingShadowRequest": { diff --git a/codegen/sdk/aws-models/iot.json b/codegen/sdk/aws-models/iot.json index 9e4668244ac..08eca7377bf 100644 --- a/codegen/sdk/aws-models/iot.json +++ b/codegen/sdk/aws-models/iot.json @@ -2590,6 +2590,35 @@ "smithy.api#documentation": "

Contains information that allowed the authorization.

" } }, + "com.amazonaws.iot#ApplicationProtocol": { + "type": "enum", + "members": { + "SECURE_MQTT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURE_MQTT" + } + }, + "MQTT_WSS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MQTT_WSS" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + } + } + }, "com.amazonaws.iot#ApproximateSecondsBeforeTimedOut": { "type": "long" }, @@ -2764,7 +2793,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates a software bill of materials (SBOM) with a specific software package version.

\n

Requires permission to access the AssociateSbomWithPackageVersion action.

", + "smithy.api#documentation": "

Associates the selected software bill of materials (SBOM) with a specific software package version.

\n

Requires permission to access the AssociateSbomWithPackageVersion action.

", "smithy.api#http": { "method": "PUT", "uri": "/packages/{packageName}/versions/{versionName}/sbom", @@ -2832,7 +2861,7 @@ "sbomValidationStatus": { "target": "com.amazonaws.iot#SbomValidationStatus", "traits": { - "smithy.api#documentation": "

The status of the initial validation for the SBOM against the Software Package Data Exchange (SPDX) and CycloneDX industry standard format.

" + "smithy.api#documentation": "

The status of the initial validation for the software bill of materials against the Software Package Data Exchange (SPDX) and CycloneDX industry standard formats.

" } } }, @@ -4045,6 +4074,41 @@ "target": "com.amazonaws.iot#AuthResult" } }, + "com.amazonaws.iot#AuthenticationType": { + "type": "enum", + "members": { + "CUSTOM_AUTH_X509": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_AUTH_X509" + } + }, + "CUSTOM_AUTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_AUTH" + } + }, + "AWS_X509": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_X509" + } + }, + "AWS_SIGV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_SIGV4" + } + }, + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + } + } + }, "com.amazonaws.iot#AuthorizerArn": { "type": "string", "traits": { @@ -5881,6 +5945,30 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#ClientCertificateCallbackArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.iot#ClientCertificateConfig": { + "type": "structure", + "members": { + "clientCertificateCallbackArn": { + "target": "com.amazonaws.iot#ClientCertificateCallbackArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that specifies the client certificate configuration for a domain.

" + } + }, "com.amazonaws.iot#ClientId": { "type": "string" }, @@ -6583,7 +6671,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a billing group.

\n

Requires permission to access the CreateBillingGroup action.

", + "smithy.api#documentation": "

Creates a billing group. If this call is made multiple times using\n\t\t\tthe same billing group name and configuration, the call will succeed. If this call is made with\n\t\t\tthe same billing group name but different configuration a ResourceAlreadyExistsException is thrown.

\n

Requires permission to access the CreateBillingGroup action.

", "smithy.api#http": { "method": "POST", "uri": "/billing-groups/{billingGroupName}", @@ -7129,6 +7217,24 @@ "traits": { "smithy.api#documentation": "

The server certificate configuration.

" } + }, + "authenticationType": { + "target": "com.amazonaws.iot#AuthenticationType", + "traits": { + "smithy.api#documentation": "

An enumerated string that specifies the authentication type.

\n
    \n
  • \n

    \n CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

    \n
    • \n
\n \n
    \n
  • \n

    \n AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information,\n see X.509 client certificates.

    \n
    • \n
\n \n
    \n
  • \n

    \n DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type.\n For more information, see Device communication protocols.

    \n
    • \n
" + } + }, + "applicationProtocol": { + "target": "com.amazonaws.iot#ApplicationProtocol", + "traits": { + "smithy.api#documentation": "

An enumerated string that specifies the application-layer protocol.

\n
    \n
  • \n

    \n SECURE_MQTT - MQTT over TLS.

    \n
    • \n
\n
    \n
  • \n

    \n MQTT_WSS - MQTT over WebSocket.

    \n
    • \n
\n
    \n
  • \n

    \n HTTPS - HTTP over TLS.

    \n
    • \n
\n
    \n
  • \n

    \n DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. \n For more information, see Device communication protocols.

    \n
    • \n
" + } + }, + "clientCertificateConfig": { + "target": "com.amazonaws.iot#ClientCertificateConfig", + "traits": { + "smithy.api#documentation": "

An object that specifies the client certificate configuration for a domain.

" + } } }, "traits": { @@ -8260,7 +8366,7 @@ "recipe": { "target": "com.amazonaws.iot#PackageVersionRecipe", "traits": { - "smithy.api#documentation": "

The inline job document associated with a software package version used for a quick job\n deployment via IoT Jobs.

" + "smithy.api#documentation": "

The inline job document associated with a software package version used for a quick job\n deployment.

" } }, "tags": { @@ -8887,7 +8993,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a role alias.

\n

Requires permission to access the CreateRoleAlias action.

", + "smithy.api#documentation": "

Creates a role alias.

\n

Requires permission to access the CreateRoleAlias action.

\n \n

The value of \n credentialDurationSeconds\n must be less than or equal to the maximum session \n duration of the IAM role that the role alias references. For more information, see \n \n Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.

\n ", "smithy.api#http": { "method": "POST", "uri": "/role-aliases/{roleAlias}", @@ -9497,7 +9603,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new thing type.

\n

Requires permission to access the CreateThingType action.

", + "smithy.api#documentation": "

Creates a new thing type. If this call is made multiple times using\n\t\t\tthe same thing type name and configuration, the call will succeed. If this call is made with\n\t\t\tthe same thing type name but different configuration a ResourceAlreadyExistsException is thrown.\n\t\t

\n

Requires permission to access the CreateThingType action.

", "smithy.api#http": { "method": "POST", "uri": "/thing-types/{thingTypeName}", @@ -13288,6 +13394,24 @@ "traits": { "smithy.api#documentation": "

The server certificate configuration.

" } + }, + "authenticationType": { + "target": "com.amazonaws.iot#AuthenticationType", + "traits": { + "smithy.api#documentation": "

An enumerated string that specifies the authentication type.

\n
    \n
  • \n

    \n CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

    \n
    • \n
\n \n
    \n
  • \n

    \n AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information,\n see X.509 client certificates.

    \n
    • \n
\n \n
    \n
  • \n

    \n DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type.\n For more information, see Device communication protocols.

    \n
    • \n
" + } + }, + "applicationProtocol": { + "target": "com.amazonaws.iot#ApplicationProtocol", + "traits": { + "smithy.api#documentation": "

An enumerated string that specifies the application-layer protocol.

\n
    \n
  • \n

    \n SECURE_MQTT - MQTT over TLS.

    \n
    • \n
\n
    \n
  • \n

    \n MQTT_WSS - MQTT over WebSocket.

    \n
    • \n
\n
    \n
  • \n

    \n HTTPS - HTTP over TLS.

    \n
    • \n
\n
    \n
  • \n

    \n DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. \n For more information, see Device communication protocols.

    \n
    • \n
" + } + }, + "clientCertificateConfig": { + "target": "com.amazonaws.iot#ClientCertificateConfig", + "traits": { + "smithy.api#documentation": "

An object that specifies the client certificate configuration for a domain.

" + } } }, "traits": { @@ -15894,7 +16018,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates a software bill of materials (SBOM) from a specific software package version.

\n

Requires permission to access the DisassociateSbomWithPackageVersion action.

", + "smithy.api#documentation": "

Disassociates the selected software bill of materials (SBOM) from a specific software package version.

\n

Requires permission to access the DisassociateSbomWithPackageVersion action.

", "smithy.api#http": { "method": "DELETE", "uri": "/packages/{packageName}/versions/{versionName}/sbom", @@ -17978,7 +18102,7 @@ "recipe": { "target": "com.amazonaws.iot#PackageVersionRecipe", "traits": { - "smithy.api#documentation": "

The inline job document associated with a software package version used for a quick job\n deployment via IoT Jobs.

" + "smithy.api#documentation": "

The inline job document associated with a software package version used for a quick job\n deployment.

" } } }, @@ -27463,7 +27587,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon S3 location for the artifacts associated with a software package\n version.

" + "smithy.api#documentation": "

A specific package version artifact associated with a software package version.

" } }, "com.amazonaws.iot#PackageVersionErrorReason": { @@ -29791,7 +29915,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon S3 location for the software bill of materials associated with a software\n package version.

" + "smithy.api#documentation": "

A specific software bill of matrerials associated with a software\n package version.

" } }, "com.amazonaws.iot#SbomValidationErrorCode": { @@ -32417,7 +32541,7 @@ "thingGroupNames": { "target": "com.amazonaws.iot#ThingGroupNameList", "traits": { - "smithy.api#documentation": "

Thing group names.

" + "smithy.api#documentation": "

Thing group and billing group names.

" } }, "attributes": { @@ -34526,6 +34650,24 @@ "traits": { "smithy.api#documentation": "

The server certificate configuration.

" } + }, + "authenticationType": { + "target": "com.amazonaws.iot#AuthenticationType", + "traits": { + "smithy.api#documentation": "

An enumerated string that specifies the authentication type.

\n
    \n
  • \n

    \n CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

    \n
    • \n
\n \n
    \n
  • \n

    \n AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information,\n see X.509 client certificates.

    \n
    • \n
\n \n
    \n
  • \n

    \n DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type.\n For more information, see Device communication protocols.

    \n
    • \n
" + } + }, + "applicationProtocol": { + "target": "com.amazonaws.iot#ApplicationProtocol", + "traits": { + "smithy.api#documentation": "

An enumerated string that specifies the application-layer protocol.

\n
    \n
  • \n

    \n SECURE_MQTT - MQTT over TLS.

    \n
    • \n
\n
    \n
  • \n

    \n MQTT_WSS - MQTT over WebSocket.

    \n
    • \n
\n
    \n
  • \n

    \n HTTPS - HTTP over TLS.

    \n
    • \n
\n
    \n
  • \n

    \n DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. \n For more information, see Device communication protocols.

    \n
    • \n
" + } + }, + "clientCertificateConfig": { + "target": "com.amazonaws.iot#ClientCertificateConfig", + "traits": { + "smithy.api#documentation": "

An object that specifies the client certificate configuration for a domain.

" + } } }, "traits": { @@ -35276,7 +35418,7 @@ "recipe": { "target": "com.amazonaws.iot#PackageVersionRecipe", "traits": { - "smithy.api#documentation": "

The inline job document associated with a software package version used for a quick job\n deployment via IoT Jobs.

" + "smithy.api#documentation": "

The inline job document associated with a software package version used for a quick job\n deployment.

" } }, "clientToken": { @@ -35421,7 +35563,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a role alias.

\n

Requires permission to access the UpdateRoleAlias action.

", + "smithy.api#documentation": "

Updates a role alias.

\n

Requires permission to access the UpdateRoleAlias action.

\n \n

The value of \n credentialDurationSeconds\n must be less than or equal to the\n maximum session duration of the IAM role that the role alias references. For more\n information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services\n Identity and Access Management User Guide.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/role-aliases/{roleAlias}", diff --git a/codegen/sdk/aws-models/iotdeviceadvisor.json b/codegen/sdk/aws-models/iotdeviceadvisor.json index 0ca5e6ae2f2..fd638cd1e0d 100644 --- a/codegen/sdk/aws-models/iotdeviceadvisor.json +++ b/codegen/sdk/aws-models/iotdeviceadvisor.json @@ -55,6 +55,16 @@ } } }, + "com.amazonaws.iotdeviceadvisor#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\u0021-\\u007E]+$" + } + }, "com.amazonaws.iotdeviceadvisor#ConflictException": { "type": "structure", "members": { @@ -112,6 +122,13 @@ "traits": { "smithy.api#documentation": "

The tags to be attached to the suite definition.

" } + }, + "clientToken": { + "target": "com.amazonaws.iotdeviceadvisor#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token for the test suite definition creation. \n This token is used for tracking test suite definition creation \n using retries and obtaining its status. This parameter is optional.

", + "smithy.api#idempotencyToken": {} + } } }, "traits": { diff --git a/codegen/sdk/aws-models/iotfleetwise.json b/codegen/sdk/aws-models/iotfleetwise.json index f0bd3f5e59c..6d45e04fa88 100644 --- a/codegen/sdk/aws-models/iotfleetwise.json +++ b/codegen/sdk/aws-models/iotfleetwise.json @@ -102,7 +102,8 @@ "smithy.api#length": { "min": 1, "max": 1011 - } + }, + "smithy.api#pattern": "^arn:.*" } }, "com.amazonaws.iotfleetwise#AssociateVehicleFleet": { @@ -463,7 +464,7 @@ "type": "structure", "members": { "arn": { - "target": "com.amazonaws.iotfleetwise#arn", + "target": "com.amazonaws.iotfleetwise#campaignArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a campaign.

" } @@ -897,6 +898,9 @@ "priority": { "target": "com.amazonaws.iotfleetwise#priority", "traits": { + "smithy.api#deprecated": { + "message": "priority is no longer used or needed as input" + }, "smithy.api#documentation": "

(Optional) A number indicating the priority of one campaign over another campaign for\n a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles\n before any other campaigns. If it's not specified, 0 is used.

\n

Default: 0\n

" } }, @@ -943,7 +947,7 @@ } }, "arn": { - "target": "com.amazonaws.iotfleetwise#arn", + "target": "com.amazonaws.iotfleetwise#campaignArn", "traits": { "smithy.api#documentation": "

The ARN of the created campaign.

" } @@ -1667,10 +1671,12 @@ "target": "com.amazonaws.iotfleetwise#NodePath" }, "traits": { + "aws.api#data": "content", "smithy.api#length": { "min": 0, "max": 5 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.iotfleetwise#DataFormat": { @@ -1868,7 +1874,7 @@ } }, "arn": { - "target": "com.amazonaws.iotfleetwise#arn", + "target": "com.amazonaws.iotfleetwise#campaignArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted campaign.

\n \n

The ARN isn’t returned if a campaign doesn’t exist.

\n " } @@ -2503,7 +2509,7 @@ } }, "arn": { - "target": "com.amazonaws.iotfleetwise#arn", + "target": "com.amazonaws.iotfleetwise#campaignArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" } @@ -4592,7 +4598,7 @@ } }, "status": { - "target": "com.amazonaws.iotfleetwise#status", + "target": "com.amazonaws.iotfleetwise#statusStr", "traits": { "smithy.api#documentation": "

Optional parameter to filter the results by the status of each created campaign in\n your account. The status can be one of: CREATING,\n WAITING_FOR_APPROVAL, RUNNING, or\n SUSPENDED.

", "smithy.api#httpQuery": "status" @@ -7290,10 +7296,12 @@ "target": "com.amazonaws.iotfleetwise#SignalInformation" }, "traits": { + "aws.api#data": "content", "smithy.api#length": { "min": 0, "max": 1000 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.iotfleetwise#SignalNodeType": { @@ -7983,7 +7991,7 @@ "type": "structure", "members": { "arn": { - "target": "com.amazonaws.iotfleetwise#arn", + "target": "com.amazonaws.iotfleetwise#campaignArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" } @@ -8829,7 +8837,7 @@ "type": "structure", "members": { "campaignName": { - "target": "com.amazonaws.iotfleetwise#string", + "target": "com.amazonaws.iotfleetwise#campaignName", "traits": { "smithy.api#documentation": "

The name of a campaign.

" } @@ -8962,6 +8970,12 @@ "target": "com.amazonaws.iotfleetwise#attributeValue" } }, + "com.amazonaws.iotfleetwise#campaignArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws:iotfleetwise:[a-z0-9-]+:[0-9]{12}:campaign/[a-zA-Z\\d\\-_:]{1,100}$" + } + }, "com.amazonaws.iotfleetwise#campaignName": { "type": "string", "traits": { @@ -8983,7 +8997,7 @@ "traits": { "smithy.api#range": { "min": 10000, - "max": 60000 + "max": 86400000 } } }, @@ -9038,10 +9052,12 @@ "com.amazonaws.iotfleetwise#eventExpression": { "type": "string", "traits": { + "aws.api#data": "content", "smithy.api#length": { "min": 1, "max": 2048 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.iotfleetwise#fleetId": { @@ -9070,7 +9086,8 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1 + "min": 1, + "max": 1 } } }, @@ -9188,8 +9205,15 @@ "target": "com.amazonaws.iotfleetwise#SignalCatalogSummary" } }, - "com.amazonaws.iotfleetwise#status": { - "type": "string" + "com.amazonaws.iotfleetwise#statusStr": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 20 + }, + "smithy.api#pattern": "^[A-Z_]*$" + } }, "com.amazonaws.iotfleetwise#string": { "type": "string" diff --git a/codegen/sdk/aws-models/ivs-realtime.json b/codegen/sdk/aws-models/ivs-realtime.json index c3099d5492f..4f32146ef92 100644 --- a/codegen/sdk/aws-models/ivs-realtime.json +++ b/codegen/sdk/aws-models/ivs-realtime.json @@ -2190,7 +2190,7 @@ "errorCode": { "target": "com.amazonaws.ivsrealtime#EventErrorCode", "traits": { - "smithy.api#documentation": "

If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.\n INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an\n action that the participant’s token is not allowed to do. For more information about\n participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the\n number of participants who want to publish/subscribe to a stage exceeds the quota; for more\n information, see Service Quotas.\n PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a\n publisher that doesn’t exist.

" + "smithy.api#documentation": "

If the event is an error event, the error code is provided to give insight into the\n specific error that occurred. If the event is not an error event, this field is null.

\n
    \n
  • \n

    \n B_FRAME_PRESENT —\n\t\t The participant's stream includes B-frames.\n\t\t For details, see \n\t\t IVS RTMP Publishing.

    \n
    • \n
  • \n

    \n BITRATE_EXCEEDED —\n\t\t The participant exceeded the maximum supported bitrate.\n\t\t For details, see \n\t\t Service Quotas.

    \n
    • \n
  • \n

    \n INSUFFICIENT_CAPABILITIES —\n\t\t The participant tried to take an action\n\t\t that the participant’s token is not allowed to do. For details on participant capabilities, see\n\t\t the capabilities field in CreateParticipantToken.

    \n
    • \n
  • \n

    \n INTERNAL_SERVER_EXCEPTION —\n\t\t The participant failed to publish to the stage due to an internal server error.

    \n
    • \n
  • \n

    \n INVALID_AUDIO_CODEC —\n\t\t The participant is using an invalid audio codec.\n\t\t For details, see \n\t\t Stream Ingest.

    \n
    • \n
  • \n

    \n INVALID_INPUT —\n\t\t The participant is using an invalid input stream.

    \n
    • \n
  • \n

    \n INVALID_PROTOCOL —\n\t\t The participant's IngestConfiguration resource is configured for RTMPS but they tried streaming with RTMP.\n\t\t For details, see \n\t\t IVS RTMP Publishing.

    \n
    • \n
  • \n

    \n INVALID_STREAM_KEY —\n\t\t The participant is using an invalid stream key.\n\t\t For details, see \n\t\t IVS RTMP Publishing.

    \n
    • \n
  • \n

    \n INVALID_VIDEO_CODEC —\n\t\t The participant is using an invalid video codec.\n\t\t For details, see \n\t\t Stream Ingest.

    \n
    • \n
  • \n

    \n PUBLISHER_NOT_FOUND —\n\t\t The participant tried to subscribe to a publisher that doesn’t exist.

    \n
    • \n
  • \n

    \n QUOTA_EXCEEDED —\n\t\t The number of participants who want to publish/subscribe to a stage exceeds the quota.\n\t\t For details, see \n\t\t Service Quotas.

    \n
    • \n
  • \n

    \n RESOLUTION_EXCEEDED —\n\t\t The participant exceeded the maximum supported resolution.\n\t\t For details, see \n\t\t Service Quotas.

    \n
    • \n
  • \n

    \n REUSE_OF_STREAM_KEY —\n\t\t The participant tried to use a stream key that is associated with another active stage session.

    \n
    • \n
  • \n

    \n STREAM_DURATION_EXCEEDED —\n\t\t The participant exceeded the maximum allowed stream duration.\n\t\t For details, see \n\t\t Service Quotas.

    \n
    • \n
" } } }, @@ -2266,6 +2266,24 @@ "traits": { "smithy.api#enumValue": "REUSE_OF_STREAM_KEY" } + }, + "B_FRAME_PRESENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "B_FRAME_PRESENT" + } + }, + "INVALID_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_INPUT" + } + }, + "INTERNAL_SERVER_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER_EXCEPTION" + } } } }, @@ -2878,7 +2896,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1, + "min": 2, "max": 1920 } } @@ -5795,13 +5813,13 @@ "width": { "target": "com.amazonaws.ivsrealtime#Width", "traits": { - "smithy.api#documentation": "

Video-resolution width. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 1280.

" + "smithy.api#documentation": "

Video-resolution width. This must be an even number. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 1280.

" } }, "height": { "target": "com.amazonaws.ivsrealtime#Height", "traits": { - "smithy.api#documentation": "

Video-resolution height. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 720.

" + "smithy.api#documentation": "

Video-resolution height. This must be an even number. Note that the maximum value is determined by width\n times height, such that the maximum total pixels is 2073600 (1920x1080 or\n 1080x1920). Default: 720.

" } }, "framerate": { @@ -5877,7 +5895,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1, + "min": 2, "max": 1920 } } diff --git a/codegen/sdk/aws-models/ivs.json b/codegen/sdk/aws-models/ivs.json index 950439110e0..bd40fc7c47f 100644 --- a/codegen/sdk/aws-models/ivs.json +++ b/codegen/sdk/aws-models/ivs.json @@ -4037,6 +4037,12 @@ "traits": { "smithy.api#documentation": "

Time when the event occurred. This is an ISO 8601 timestamp; note that this is\n returned as a string.

" } + }, + "code": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

Provides additional details about the stream event. There are several values; note that \n\t\t\tthe long descriptions are provided in the IVS console but not delivered through \n\t \t the IVS API or EventBridge:

\n
    \n
  • \n

    \n StreamTakeoverMediaMismatch — The broadcast client attempted to take over \n\t\t\twith different media properties (e.g., codec, resolution, or video track type) from the \n\t\t\toriginal stream.

    \n
    • \n
  • \n

    \n StreamTakeoverInvalidPriority — The broadcast client attempted a takeover \n\t\t\twith either a priority integer value equal to or lower than the original stream's value or a value outside \n\t\t\tthe allowed range of 1 to 2,147,483,647.

    \n
    • \n
  • \n

    \n StreamTakeoverLimitBreached — The broadcast client reached the maximum allowed \n\t\t\ttakeover attempts for this stream.

    \n
    • \n
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/kinesis.json b/codegen/sdk/aws-models/kinesis.json index 4176b38755d..035a669dd78 100644 --- a/codegen/sdk/aws-models/kinesis.json +++ b/codegen/sdk/aws-models/kinesis.json @@ -300,7 +300,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n
    \n
  • \n

    Have more than five streams in the CREATING state at any point in\n time.

    \n
    • \n
  • \n

    Create more shards than are authorized for your account.

    \n
    • \n
\n

For the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n
    \n
  • \n

    Have more than five streams in the CREATING state at any point in\n time.

    \n
    • \n
  • \n

    Create more shards than are authorized for your account.

    \n
    • \n
\n

For the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

\n

You can add tags to the stream when making a CreateStream request by\n setting the Tags parameter. If you pass Tags parameter, in\n addition to having kinesis:createStream permission, you must also have\n kinesis:addTagsToStream permission for the stream that will be created.\n Tags will take effect from the CREATING status of the stream.

" } }, "com.amazonaws.kinesis#CreateStreamInput": { @@ -324,6 +324,12 @@ "traits": { "smithy.api#documentation": "

Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,\n you can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data\n streams.

" } + }, + "Tags": { + "target": "com.amazonaws.kinesis#TagMap", + "traits": { + "smithy.api#documentation": "

A set of up to 10 key-value pairs to use to create the tags.

" + } } }, "traits": { @@ -1296,6 +1302,9 @@ { "target": "com.amazonaws.kinesis#LimitExceededException" }, + { + "target": "com.amazonaws.kinesis#ResourceInUseException" + }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } @@ -6929,7 +6938,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

", + "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operation, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" @@ -7889,7 +7898,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

", + "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operation, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "data" diff --git a/codegen/sdk/aws-models/lambda.json b/codegen/sdk/aws-models/lambda.json index 9e4dec4c63d..674144fde12 100644 --- a/codegen/sdk/aws-models/lambda.json +++ b/codegen/sdk/aws-models/lambda.json @@ -84,9 +84,6 @@ { "target": "com.amazonaws.lambda#DeleteProvisionedConcurrencyConfig" }, - { - "target": "com.amazonaws.lambda#DeleteResourcePolicy" - }, { "target": "com.amazonaws.lambda#GetAccountSettings" }, @@ -135,12 +132,6 @@ { "target": "com.amazonaws.lambda#GetProvisionedConcurrencyConfig" }, - { - "target": "com.amazonaws.lambda#GetPublicAccessBlockConfig" - }, - { - "target": "com.amazonaws.lambda#GetResourcePolicy" - }, { "target": "com.amazonaws.lambda#GetRuntimeManagementConfig" }, @@ -210,12 +201,6 @@ { "target": "com.amazonaws.lambda#PutProvisionedConcurrencyConfig" }, - { - "target": "com.amazonaws.lambda#PutPublicAccessBlockConfig" - }, - { - "target": "com.amazonaws.lambda#PutResourcePolicy" - }, { "target": "com.amazonaws.lambda#PutRuntimeManagementConfig" }, @@ -1771,9 +1756,6 @@ { "target": "com.amazonaws.lambda#PreconditionFailedException" }, - { - "target": "com.amazonaws.lambda#PublicPolicyException" - }, { "target": "com.amazonaws.lambda#ResourceConflictException" }, @@ -1788,7 +1770,7 @@ } ], "traits": { - "smithy.api#documentation": "

Grants a principal \n permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict\n access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name\n (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies\n to version $LATEST.

\n

To grant permission to another account, specify the account ID as the Principal. To grant\n permission to an organization defined in Organizations, specify the organization ID as the\n PrincipalOrgID. For Amazon Web Servicesservices, the principal is a domain-style identifier that\n the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Servicesservices, you can also specify the ARN of the associated resource as the SourceArn. If\n you grant permission to a service principal without specifying the source, other accounts could potentially\n configure resources in their account to invoke your Lambda function.

\n

This operation adds a statement to a resource-based permissions policy for the function. For more information\n about function policies, see Using resource-based policies for Lambda.

", + "smithy.api#documentation": "

Grants a principal \n permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict\n access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name\n (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies\n to version $LATEST.

\n

To grant permission to another account, specify the account ID as the Principal. To grant\n permission to an organization defined in Organizations, specify the organization ID as the\n PrincipalOrgID. For Amazon Web Services services, the principal is a domain-style identifier that\n the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If\n you grant permission to a service principal without specifying the source, other accounts could potentially\n configure resources in their account to invoke your Lambda function.

\n

This operation adds a statement to a resource-based permissions policy for the function. For more information\n about function policies, see Using resource-based policies for Lambda.

", "smithy.api#examples": [ { "title": "To grant Amazon S3 permission to invoke a function", @@ -1854,20 +1836,20 @@ "Principal": { "target": "com.amazonaws.lambda#Principal", "traits": { - "smithy.api#documentation": "

The Amazon Web Servicesservice, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a\n service, use SourceArn or SourceAccount to limit who can invoke the function through\n that service.

", + "smithy.api#documentation": "

The Amazon Web Services service, Amazon Web Services account, IAM user, or IAM role that invokes the function. If you specify a\n service, use SourceArn or SourceAccount to limit who can invoke the function through\n that service.

", "smithy.api#required": {} } }, "SourceArn": { "target": "com.amazonaws.lambda#Arn", "traits": { - "smithy.api#documentation": "

For Amazon Web Servicesservices, the ARN of the Amazon Web Services resource that invokes the function. For\n example, an Amazon S3 bucket or Amazon SNS topic.

\n

Note that Lambda configures the comparison using the StringLike operator.

" + "smithy.api#documentation": "

For Amazon Web Services services, the ARN of the Amazon Web Services resource that invokes the function. For\n example, an Amazon S3 bucket or Amazon SNS topic.

\n

Note that Lambda configures the comparison using the StringLike operator.

" } }, "SourceAccount": { "target": "com.amazonaws.lambda#SourceOwner", "traits": { - "smithy.api#documentation": "

For Amazon Web Servicesservice, the ID of the Amazon Web Services account that owns the resource. Use this\n together with SourceArn to ensure that the specified account owns the resource. It is possible for an\n Amazon S3 bucket to be deleted by its owner and recreated by another account.

" + "smithy.api#documentation": "

For Amazon Web Services service, the ID of the Amazon Web Services account that owns the resource. Use this\n together with SourceArn to ensure that the specified account owns the resource. It is possible for an\n Amazon S3 bucket to be deleted by its owner and recreated by another account.

" } }, "EventSourceToken": { @@ -2836,7 +2818,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The\n deployment package is a .zip file archive or container image that contains your function code. The execution role\n grants the function permission to use Amazon Web Servicesservices, such as Amazon CloudWatch Logs for log\n streaming and X-Ray for request tracing.

\n

If the deployment package is a container\n image, then you set the package type to Image. For a container image, the code property\n must include the URI of a container image in the Amazon ECR registry. You do not need to specify the\n handler and runtime properties.

\n

If the deployment package is a .zip file archive, then\n you set the package type to Zip. For a .zip file archive, the code property specifies the location of\n the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must\n be compatible with the target instruction set architecture of the function (x86-64 or\n arm64). If you do not specify the architecture, then the default value is\n x86-64.

\n

When you create a function, Lambda provisions an instance of the function and its supporting\n resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't\n invoke or modify the function. The State, StateReason, and StateReasonCode\n fields in the response from GetFunctionConfiguration indicate when the function is ready to\n invoke. For more information, see Lambda function states.

\n

A function has an unpublished version, and can have published versions and aliases. The unpublished version\n changes when you update your function's code and configuration. A published version is a snapshot of your function\n code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be\n changed to map to a different version. Use the Publish parameter to create version 1 of\n your function from its initial configuration.

\n

The other parameters let you configure version-specific and function-level settings. You can modify\n version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply\n to both the unpublished and published versions of the function, and include tags (TagResource)\n and per-function concurrency limits (PutFunctionConcurrency).

\n

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this\n function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with\n UpdateFunctionCode, Lambda checks that the code package has a valid signature from\n a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted\n publishers for this function.

\n

If another Amazon Web Services account or an Amazon Web Servicesservice invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.

\n

To invoke your function directly, use Invoke. To invoke your function in response to events\n in other Amazon Web Servicesservices, create an event source mapping (CreateEventSourceMapping),\n or configure a function trigger in the other service. For more information, see Invoking Lambda\n functions.

", + "smithy.api#documentation": "

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The\n deployment package is a .zip file archive or container image that contains your function code. The execution role\n grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log\n streaming and X-Ray for request tracing.

\n

If the deployment package is a container\n image, then you set the package type to Image. For a container image, the code property\n must include the URI of a container image in the Amazon ECR registry. You do not need to specify the\n handler and runtime properties.

\n

If the deployment package is a .zip file archive, then\n you set the package type to Zip. For a .zip file archive, the code property specifies the location of\n the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must\n be compatible with the target instruction set architecture of the function (x86-64 or\n arm64). If you do not specify the architecture, then the default value is\n x86-64.

\n

When you create a function, Lambda provisions an instance of the function and its supporting\n resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't\n invoke or modify the function. The State, StateReason, and StateReasonCode\n fields in the response from GetFunctionConfiguration indicate when the function is ready to\n invoke. For more information, see Lambda function states.

\n

A function has an unpublished version, and can have published versions and aliases. The unpublished version\n changes when you update your function's code and configuration. A published version is a snapshot of your function\n code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be\n changed to map to a different version. Use the Publish parameter to create version 1 of\n your function from its initial configuration.

\n

The other parameters let you configure version-specific and function-level settings. You can modify\n version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply\n to both the unpublished and published versions of the function, and include tags (TagResource)\n and per-function concurrency limits (PutFunctionConcurrency).

\n

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this\n function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with\n UpdateFunctionCode, Lambda checks that the code package has a valid signature from\n a trusted publisher. The code-signing configuration includes set of signing profiles, which define the trusted\n publishers for this function.

\n

If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias.

\n

To invoke your function directly, use Invoke. To invoke your function in response to events\n in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping),\n or configure a function trigger in the other service. For more information, see Invoking Lambda\n functions.

", "smithy.api#examples": [ { "title": "To create a function", @@ -3409,7 +3391,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter.\n Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit\n permissions for DeleteAlias.

\n

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Servicesservices and resources that invoke your function\n directly, delete the trigger in the service where you originally configured it.

", + "smithy.api#documentation": "

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter.\n Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit\n permissions for DeleteAlias.

\n

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function\n directly, delete the trigger in the service where you originally configured it.

", "smithy.api#examples": [ { "title": "To delete a version of a Lambda function", @@ -3811,66 +3793,6 @@ "smithy.api#input": {} } }, - "com.amazonaws.lambda#DeleteResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.lambda#DeleteResourcePolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lambda#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.lambda#PreconditionFailedException" - }, - { - "target": "com.amazonaws.lambda#ResourceConflictException" - }, - { - "target": "com.amazonaws.lambda#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lambda#ServiceException" - }, - { - "target": "com.amazonaws.lambda#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "\n

The option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.

\n \n

Deletes a resource-based policy from a function.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2024-09-16/resource-policy/{ResourceArn}", - "code": 204 - } - } - }, - "com.amazonaws.lambda#DeleteResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lambda#PolicyResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function you want to delete the policy from. You can use either a qualified or an unqualified ARN, \n but the value you specify must be a complete ARN and wildcard characters are not accepted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RevisionId": { - "target": "com.amazonaws.lambda#RevisionId", - "traits": { - "smithy.api#documentation": "

Delete the existing policy only if its revision ID matches the string you specify. To find the revision ID of the policy currently attached \n to your function, use the GetResourcePolicy action.

", - "smithy.api#httpQuery": "RevisionId" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, "com.amazonaws.lambda#Description": { "type": "string", "traits": { @@ -6639,134 +6561,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.lambda#GetPublicAccessBlockConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.lambda#GetPublicAccessBlockConfigRequest" - }, - "output": { - "target": "com.amazonaws.lambda#GetPublicAccessBlockConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lambda#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.lambda#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lambda#ServiceException" - }, - { - "target": "com.amazonaws.lambda#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "\n

The option to configure public-access settings, and to use the PutPublicAccessBlock and GetPublicAccessBlock APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.

\n \n

Retrieve the public-access settings for a function.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2024-09-16/public-access-block/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.lambda#GetPublicAccessBlockConfigRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lambda#PublicAccessBlockResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function you want to retrieve public-access settings for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lambda#GetPublicAccessBlockConfigResponse": { - "type": "structure", - "members": { - "PublicAccessBlockConfig": { - "target": "com.amazonaws.lambda#PublicAccessBlockConfig", - "traits": { - "smithy.api#documentation": "

The public-access settings configured for the function you specified

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lambda#GetResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.lambda#GetResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.lambda#GetResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lambda#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.lambda#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lambda#ServiceException" - }, - { - "target": "com.amazonaws.lambda#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "\n

The option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.

\n \n

Retrieves the resource-based policy attached to a function.

", - "smithy.api#http": { - "method": "GET", - "uri": "/2024-09-16/resource-policy/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.lambda#GetResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lambda#PolicyResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function you want to retrieve the policy for. You can use either a qualified or an unqualified ARN, \n but the value you specify must be a complete ARN and wildcard characters are not accepted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lambda#GetResourcePolicyResponse": { - "type": "structure", - "members": { - "Policy": { - "target": "com.amazonaws.lambda#ResourcePolicy", - "traits": { - "smithy.api#documentation": "

The resource-based policy attached to the function you specified.

" - } - }, - "RevisionId": { - "target": "com.amazonaws.lambda#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision ID of the policy.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.lambda#GetRuntimeManagementConfig": { "type": "operation", "input": { @@ -9326,7 +9120,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a function, event source mapping, or code signing configuration's tags. You can\n also view funciton tags with GetFunction.

", + "smithy.api#documentation": "

Returns a function, event source mapping, or code signing configuration's tags. You can\n also view function tags with GetFunction.

", "smithy.api#examples": [ { "title": "To retrieve the list of tags for a Lambda function", @@ -9891,16 +9685,6 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.lambda#PolicyResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_])+)?$" - } - }, "com.amazonaws.lambda#PositiveInteger": { "type": "integer", "traits": { @@ -10042,55 +9826,6 @@ } } }, - "com.amazonaws.lambda#PublicAccessBlockConfig": { - "type": "structure", - "members": { - "BlockPublicPolicy": { - "target": "com.amazonaws.lambda#NullableBoolean", - "traits": { - "smithy.api#documentation": "

To block the creation of resource-based policies that would grant public access to your function, set BlockPublicPolicy \n to true. To allow the creation of resource-based policies that would grant public access to your function, set BlockPublicPolicy \n to false.

" - } - }, - "RestrictPublicResource": { - "target": "com.amazonaws.lambda#NullableBoolean", - "traits": { - "smithy.api#documentation": "

To block public access to your function, even if its resource-based policy allows it, set RestrictPublicResource to true. To \n allow public access to a function with a resource-based policy that permits it, set RestrictPublicResource to false.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that defines the public-access settings for a function.

" - } - }, - "com.amazonaws.lambda#PublicAccessBlockResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 170 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+$" - } - }, - "com.amazonaws.lambda#PublicPolicyException": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.lambda#String", - "traits": { - "smithy.api#documentation": "

The exception type.

" - } - }, - "Message": { - "target": "com.amazonaws.lambda#String" - } - }, - "traits": { - "smithy.api#documentation": "

Lambda prevented your policy from being created because it would grant public access to your function. If you intended to \n create a public policy, use the PutPublicAccessBlockConfig API action to configure your function's public-access settings \n to allow public policies.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, "com.amazonaws.lambda#PublishLayerVersion": { "type": "operation", "input": { @@ -10807,169 +10542,6 @@ "smithy.api#output": {} } }, - "com.amazonaws.lambda#PutPublicAccessBlockConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.lambda#PutPublicAccessBlockConfigRequest" - }, - "output": { - "target": "com.amazonaws.lambda#PutPublicAccessBlockConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lambda#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.lambda#ResourceConflictException" - }, - { - "target": "com.amazonaws.lambda#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lambda#ServiceException" - }, - { - "target": "com.amazonaws.lambda#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "\n

The option to configure public-access settings, and to use the PutPublicAccessBlock and GetPublicAccessBlock APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.

\n \n

Configure your function's public-access settings.

\n

To control public access to a Lambda function, you can choose whether to allow the creation of \n resource-based policies that \n allow public access to that function. You can also block public access to a function, even if it has an existing resource-based \n policy that allows it.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/2024-09-16/public-access-block/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.lambda#PutPublicAccessBlockConfigRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lambda#PublicAccessBlockResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function you want to configure public-access settings for. Public-access settings \n are applied at the function level, so you can't apply different settings to function versions or aliases.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PublicAccessBlockConfig": { - "target": "com.amazonaws.lambda#PublicAccessBlockConfig", - "traits": { - "smithy.api#documentation": "

An object defining the public-access settings you want to apply.

\n

To block the creation of resource-based policies that would grant public access to your function, set BlockPublicPolicy \n to true. To allow the creation of resource-based policies that would grant public access to your function, set BlockPublicPolicy \n to false.

\n

To block public access to your function, even if its resource-based policy allows it, set RestrictPublicResource to true. To \n allow public access to a function with a resource-based policy that permits it, set RestrictPublicResource to false.

\n

The default setting for both BlockPublicPolicy and RestrictPublicResource is true.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lambda#PutPublicAccessBlockConfigResponse": { - "type": "structure", - "members": { - "PublicAccessBlockConfig": { - "target": "com.amazonaws.lambda#PublicAccessBlockConfig", - "traits": { - "smithy.api#documentation": "

The public-access settings Lambda applied to your function.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lambda#PutResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.lambda#PutResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.lambda#PutResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lambda#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.lambda#PolicyLengthExceededException" - }, - { - "target": "com.amazonaws.lambda#PreconditionFailedException" - }, - { - "target": "com.amazonaws.lambda#PublicPolicyException" - }, - { - "target": "com.amazonaws.lambda#ResourceConflictException" - }, - { - "target": "com.amazonaws.lambda#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lambda#ServiceException" - }, - { - "target": "com.amazonaws.lambda#TooManyRequestsException" - } - ], - "traits": { - "smithy.api#documentation": "\n

The option to create and modify full JSON resource-based policies, and to use the PutResourcePolicy, GetResourcePolicy, and DeleteResourcePolicy APIs, won't be \n available in all Amazon Web Services Regions until September 30, 2024.

\n \n

Adds a resource-based policy \n to a function. You can use resource-based policies to grant access to other \n Amazon Web Services accounts, \n organizations, or \n services. Resource-based policies \n apply to a single function, version, or alias.

\n \n

Adding a resource-based policy using this API action replaces any existing policy you've previously created. This means that if \n you've previously added resource-based permissions to a function using the AddPermission action, those \n permissions will be overwritten by your new policy.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/2024-09-16/resource-policy/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.lambda#PutResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lambda#PolicyResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the function you want to add the policy to. You can use either a qualified or an unqualified ARN, \n but the value you specify must be a complete ARN and wildcard characters are not accepted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Policy": { - "target": "com.amazonaws.lambda#ResourcePolicy", - "traits": { - "smithy.api#documentation": "

The JSON resource-based policy you want to add to your function.

\n

To learn more about creating resource-based policies for controlling access to \n Lambda, see Working with resource-based IAM policies in Lambda in the \n Lambda Developer Guide.

", - "smithy.api#required": {} - } - }, - "RevisionId": { - "target": "com.amazonaws.lambda#RevisionId", - "traits": { - "smithy.api#documentation": "

Replace the existing policy only if its revision ID matches the string you specify. To find the revision ID of the policy currently attached \n to your function, use the GetResourcePolicy action.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lambda#PutResourcePolicyResponse": { - "type": "structure", - "members": { - "Policy": { - "target": "com.amazonaws.lambda#ResourcePolicy", - "traits": { - "smithy.api#documentation": "

The policy Lambda added to your function.

" - } - }, - "RevisionId": { - "target": "com.amazonaws.lambda#RevisionId", - "traits": { - "smithy.api#documentation": "

The revision ID of the policy Lambda added to your function.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, "com.amazonaws.lambda#PutRuntimeManagementConfig": { "type": "operation", "input": { @@ -11239,9 +10811,6 @@ { "target": "com.amazonaws.lambda#PreconditionFailedException" }, - { - "target": "com.amazonaws.lambda#PublicPolicyException" - }, { "target": "com.amazonaws.lambda#ResourceNotFoundException" }, @@ -11253,7 +10822,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes function-use permission from an Amazon Web Servicesservice or another Amazon Web Services account. You\n can get the ID of the statement from the output of GetPolicy.

", + "smithy.api#documentation": "

Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You\n can get the ID of the statement from the output of GetPolicy.

", "smithy.api#examples": [ { "title": "To remove a Lambda function's permissions", @@ -11416,16 +10985,6 @@ "smithy.api#httpError": 502 } }, - "com.amazonaws.lambda#ResourcePolicy": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20480 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, "com.amazonaws.lambda#ResponseStreamingInvocationType": { "type": "enum", "members": { @@ -11443,16 +11002,6 @@ } } }, - "com.amazonaws.lambda#RevisionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - } - }, "com.amazonaws.lambda#RoleArn": { "type": "string", "traits": { @@ -13227,7 +12776,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modify the version-specific settings of a Lambda function.

\n

When you update a function, Lambda provisions an instance of the function and its supporting\n resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify\n the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason,\n and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration\n indicate when the update is complete and the function is processing events with the new configuration. For more\n information, see Lambda\n function states.

\n

These settings can vary between versions of a function and are locked when you publish a version. You can't\n modify the configuration of a published version, only the unpublished version.

\n

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions\n to an Amazon Web Services account or Amazon Web Servicesservice, use AddPermission.

", + "smithy.api#documentation": "

Modify the version-specific settings of a Lambda function.

\n

When you update a function, Lambda provisions an instance of the function and its supporting\n resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify\n the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason,\n and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration\n indicate when the update is complete and the function is processing events with the new configuration. For more\n information, see Lambda\n function states.

\n

These settings can vary between versions of a function and are locked when you publish a version. You can't\n modify the configuration of a published version, only the unpublished version.

\n

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions\n to an Amazon Web Services account or Amazon Web Services service, use AddPermission.

", "smithy.api#examples": [ { "title": "To update a Lambda function's configuration", diff --git a/codegen/sdk/aws-models/mailmanager.json b/codegen/sdk/aws-models/mailmanager.json index 49bd9a0ebeb..80c71866104 100644 --- a/codegen/sdk/aws-models/mailmanager.json +++ b/codegen/sdk/aws-models/mailmanager.json @@ -613,6 +613,18 @@ "traits": { "smithy.api#enumValue": "SUBJECT" } + }, + "ENVELOPE_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENVELOPE_TO" + } + }, + "ENVELOPE_FROM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENVELOPE_FROM" + } } } }, @@ -1741,6 +1753,32 @@ "target": "smithy.api#String" } }, + "com.amazonaws.mailmanager#Envelope": { + "type": "structure", + "members": { + "Helo": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HELO used by the host from which the email was received.

" + } + }, + "From": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The RCPT FROM given by the host from which the email was received.

" + } + }, + "To": { + "target": "com.amazonaws.mailmanager#StringList", + "traits": { + "smithy.api#documentation": "

All SMTP TO entries given by the host from which the email was received.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SMTP envelope information of the email.

" + } + }, "com.amazonaws.mailmanager#ErrorMessage": { "type": "string" }, @@ -2218,6 +2256,18 @@ "traits": { "smithy.api#documentation": "

A pre-signed URL to temporarily download the full message content.

" } + }, + "Metadata": { + "target": "com.amazonaws.mailmanager#Metadata", + "traits": { + "smithy.api#documentation": "

The metadata about the email.

" + } + }, + "Envelope": { + "target": "com.amazonaws.mailmanager#Envelope", + "traits": { + "smithy.api#documentation": "

The SMTP envelope information of the email.

" + } } }, "traits": { @@ -5120,6 +5170,62 @@ "smithy.api#documentation": "

The textual body content of an email message.

" } }, + "com.amazonaws.mailmanager#Metadata": { + "type": "structure", + "members": { + "Timestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the email was received.

" + } + }, + "IngressPointId": { + "target": "com.amazonaws.mailmanager#IngressPointId", + "traits": { + "smithy.api#documentation": "

The ID of the ingress endpoint through which the email was received.

" + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.mailmanager#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "

The ID of the traffic policy that was in effect when the email was received.

" + } + }, + "RuleSetId": { + "target": "com.amazonaws.mailmanager#RuleSetId", + "traits": { + "smithy.api#documentation": "

The ID of the rule set that processed the email.

" + } + }, + "SenderHostname": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the host from which the email was received.

" + } + }, + "SenderIpAddress": { + "target": "com.amazonaws.mailmanager#SenderIpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the host from which the email was received.

" + } + }, + "TlsCipherSuite": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The TLS cipher suite used to communicate with the host from which the email was received.

" + } + }, + "TlsProtocol": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The TLS protocol used to communicate with the host from which the email was received.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metadata about the email.

" + } + }, "com.amazonaws.mailmanager#MimeHeaderAttribute": { "type": "string", "traits": { @@ -5647,6 +5753,30 @@ "traits": { "smithy.api#documentation": "

The priority level of the email.

" } + }, + "IngressPointId": { + "target": "com.amazonaws.mailmanager#IngressPointId", + "traits": { + "smithy.api#documentation": "

The ID of the ingress endpoint through which the email was received.

" + } + }, + "SenderHostname": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the host from which the email was received.

" + } + }, + "SenderIpAddress": { + "target": "com.amazonaws.mailmanager#SenderIpAddress", + "traits": { + "smithy.api#documentation": "

The IP address of the host from which the email was received.

" + } + }, + "Envelope": { + "target": "com.amazonaws.mailmanager#Envelope", + "traits": { + "smithy.api#documentation": "

The SMTP envelope information of the email.

" + } } }, "traits": { @@ -6787,6 +6917,12 @@ "smithy.api#documentation": "

Sends the email to the internet using the ses:SendRawEmail API.

" } }, + "com.amazonaws.mailmanager#SenderIpAddress": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.mailmanager#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -6882,6 +7018,12 @@ "smithy.api#documentation": "

Details on where to deliver the exported email data.

", "smithy.api#required": {} } + }, + "IncludeMetadata": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Whether to include message metadata as JSON files in the export.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/marketplace-reporting.json b/codegen/sdk/aws-models/marketplace-reporting.json new file mode 100644 index 00000000000..04b79f3f803 --- /dev/null +++ b/codegen/sdk/aws-models/marketplace-reporting.json @@ -0,0 +1,954 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.marketplacereporting#AWSMarketplaceReporting": { + "type": "service", + "version": "2018-05-10", + "resources": [ + { + "target": "com.amazonaws.marketplacereporting#Dashboard" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Marketplace Reporting", + "cloudTrailEventSource": "reporting-marketplace.amazonaws.com", + "arnNamespace": "aws-marketplace", + "endpointPrefix": "reporting-marketplace" + }, + "aws.auth#sigv4": { + "name": "aws-marketplace" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalExposedHeaders": [ + "x-amzn-requestid", + "x-amzn-errortype", + "x-amzn-errormessage", + "date" + ] + }, + "smithy.api#documentation": "

The Amazon Web Services Marketplace GetBuyerDashboard API enables you to get a procurement insights\n dashboard programmatically. The API gets the agreement and cost analysis dashboards with\n data for all of the Amazon Web Services accounts in your Amazon Web Services Organization.

\n

To use the Amazon Web Services Marketplace Reporting API, you must complete the following prerequisites:

\n
    \n
  • \n

    Enable all features for your organization. For more information, see Enabling all features for an organization with Organizations, in the\n Organizations User Guide.

    \n
    • \n
  • \n

    Call the service as the Organizations management account or an account registered\n as a delegated administrator for the procurement insights service.

    \n

    For more information about management accounts, see Tutorial:\n Creating and configuring an organization and Managing the management account with Organizations, both in the\n Organizations User Guide.

    \n

    For more information about delegated administrators, see Using\n delegated administrators, in the Amazon Web Services Marketplace Buyer\n Guide.

    \n
    • \n
  • \n

    Create an IAM policy that enables the\n aws-marketplace:GetBuyerDashboard and\n organizations:DescribeOrganization permissions. In addition,\n the management account requires the\n organizations:EnableAWSServiceAccess and\n iam:CreateServiceLinkedRole permissions to create. For more\n information about creating the policy, see Policies and permissions in\n Identity and Access Management, in the IAM User Guide.

    \n \n

    Access can be shared only by registering the desired linked account as a\n delegated administrator. That requires\n organizations:RegisterDelegatedAdministrator\n organizations:ListDelegatedAdministrators and\n organizations:DeregisterDelegatedAdministrator\n permissions.

    \n     \n
    • \n
  • \n

    Use the Amazon Web Services Marketplace console to create the\n AWSServiceRoleForProcurementInsightsPolicy service-linked role.\n The role enables Amazon Web Services Marketplace procurement visibility integration. The management\n account requires an IAM policy with the\n organizations:EnableAWSServiceAccess and\n iam:CreateServiceLinkedRole permissions to create the\n service-linked role and enable the service access. For more information, see\n Granting access to\n Organizations and Service-linked role to share procurement data in the\n Amazon Web Services Marketplace Buyer Guide.

    \n
    • \n
  • \n

    After creating the service-linked role, you must enable trusted access that\n grants Amazon Web Services Marketplace permission to access data from your Organizations. For more information,\n see Granting access to\n Organizations in the Amazon Web Services Marketplace Buyer Guide.

    \n
    • \n
", + "smithy.api#title": "AWS Marketplace Reporting Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://reporting-marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://reporting-marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://reporting-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://reporting-marketplace.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://reporting-marketplace.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.marketplacereporting#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.marketplacereporting#BadRequestException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request is malformed, or it contains an error such as an invalid parameter. Ensure the request has all required parameters.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.marketplacereporting#Dashboard": { + "type": "resource", + "identifiers": { + "dashboardIdentifier": { + "target": "com.amazonaws.marketplacereporting#DashboardIdentifier" + } + }, + "operations": [ + { + "target": "com.amazonaws.marketplacereporting#GetBuyerDashboard" + } + ], + "traits": { + "aws.api#arn": { + "template": "{dashboardIdentifier}", + "absolute": true, + "noRegion": true + } + } + }, + "com.amazonaws.marketplacereporting#DashboardIdentifier": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "service": "com.amazonaws.marketplacereporting#AWSMarketplaceReporting", + "resource": "com.amazonaws.marketplacereporting#Dashboard", + "type": "AWS::Service::Resource" + }, + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#pattern": "^arn:aws:aws-marketplace::[0-9]{12}:AWSMarketplace/ReportingData/(Agreement_V1/Dashboard/AgreementSummary_V1|BillingEvent_V1/Dashboard/CostAnalysis_V1)$" + } + }, + "com.amazonaws.marketplacereporting#EmbeddingDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^(https://[a-zA-Z\\.\\*0-9\\-_]+[\\.]{1}[a-zA-Z]{1,}[a-zA-Z0-9&?/-_=]*[a-zA-Z\\*0-9/]+|http[s]*://localhost(:[0-9]{1,5})?)$" + } + }, + "com.amazonaws.marketplacereporting#EmbeddingDomains": { + "type": "list", + "member": { + "target": "com.amazonaws.marketplacereporting#EmbeddingDomain" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.marketplacereporting#GetBuyerDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.marketplacereporting#GetBuyerDashboardInput" + }, + "output": { + "target": "com.amazonaws.marketplacereporting#GetBuyerDashboardOutput" + }, + "errors": [ + { + "target": "com.amazonaws.marketplacereporting#AccessDeniedException" + }, + { + "target": "com.amazonaws.marketplacereporting#BadRequestException" + }, + { + "target": "com.amazonaws.marketplacereporting#InternalServerException" + }, + { + "target": "com.amazonaws.marketplacereporting#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates an embedding URL for an Amazon QuickSight dashboard for an anonymous user.

\n \n

This API is available only to Amazon Web Services Organization management accounts or\n delegated administrators registered for the procurement insights\n (procurement-insights.marketplace.amazonaws.com) feature.

\n \n

The following rules apply to a generated URL:

\n
    \n
  • \n

    It contains a temporary bearer token, valid for 5 minutes after it is generated. Once redeemed within that period, it cannot be re-used again.

    \n
    • \n
  • \n

    It has a session lifetime of one hour. The 5-minute validity period runs separately from the session lifetime.

    \n
    • \n
", + "smithy.api#examples": [ + { + "title": "Getting an agreements dashboard", + "documentation": "The following example shows how to obtain a dashboard for active agreements", + "input": { + "dashboardIdentifier": "arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/Agreement_V1/Dashboard/AgreementSummary_V1", + "embeddingDomains": [ + "https://*.amazon.com" + ] + }, + "output": { + "dashboardIdentifier": "arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/Agreement_V1/Dashboard/AgreementSummary_V1", + "embedUrl": "https://us-east-1.quicksight.aws.amazon.com/embed/1235asdbffffbbasdf123/dashboards/8a66afa6-f316-4e71-a1ed-0a5bea07a314?code=abcdefghijklmn&identityprovider=quicksight&isauthcode=true", + "embeddingDomains": [ + "https://*.amazon.com" + ] + } + }, + { + "title": "Getting a cost-analysis dashboard", + "documentation": "The following example shows how to obtain a dashboard for cost analysis", + "input": { + "dashboardIdentifier": "arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/BillingEvent_V1/Dashboard/CostAnalysis_V1", + "embeddingDomains": [ + "https://*.amazon.com" + ] + }, + "output": { + "dashboardIdentifier": "arn:aws:aws-marketplace::123456789012:AWSMarketplace/ReportingData/BillingEvent_V1/Dashboard/CostAnalysis_V1", + "embedUrl": "https://us-east-1.quicksight.aws.amazon.com/embed/1235asdbffffbbasdf123/dashboards/8a66afa6-f316-4e71-a1ed-0a5bea07a314?code=abcdefghijklmn&identityprovider=quicksight&isauthcode=true", + "embeddingDomains": [ + "https://*.amazon.com" + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/getBuyerDashboard" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetBuyerDashboardUnauthorized", + "params": { + "dashboardIdentifier": "arn:aws:aws-marketplace::021234567890:AWSMarketplace/ReportingData/Agreement_V1/Dashboard/AgreementSummary_V1", + "embeddingDomains": [ + "https://localhost:8080" + ] + }, + "expect": { + "failure": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.marketplacereporting#GetBuyerDashboardInput": { + "type": "structure", + "members": { + "dashboardIdentifier": { + "target": "com.amazonaws.marketplacereporting#DashboardIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the requested dashboard.

", + "smithy.api#required": {} + } + }, + "embeddingDomains": { + "target": "com.amazonaws.marketplacereporting#EmbeddingDomains", + "traits": { + "smithy.api#documentation": "

Fully qualified domains that you add to the allow list for access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call.\n To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under \n https://aws.amazon.com.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.marketplacereporting#Dashboard", + "ids": { + "dashboardIdentifier": "dashboardIdentifier" + } + } + ] + } + }, + "com.amazonaws.marketplacereporting#GetBuyerDashboardOutput": { + "type": "structure", + "members": { + "embedUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The dashboard's embedding URL.

", + "smithy.api#required": {} + } + }, + "dashboardIdentifier": { + "target": "com.amazonaws.marketplacereporting#DashboardIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the returned dashboard.

", + "smithy.api#required": {} + } + }, + "embeddingDomains": { + "target": "com.amazonaws.marketplacereporting#EmbeddingDomains", + "traits": { + "smithy.api#documentation": "

The fully qualified domains specified in the request. The domains enable access to the generated URL that is then embedded. You can list up to two domains or subdomains in each API call.\n To include all subdomains under a specific domain, use *. For example, https://*.amazon.com includes all subdomains under \n https://aws.amazon.com.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.marketplacereporting#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed due to a server error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.marketplacereporting#UnauthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have permission to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/mediapackagev2.json b/codegen/sdk/aws-models/mediapackagev2.json index 86781cc506c..01de86232e9 100644 --- a/codegen/sdk/aws-models/mediapackagev2.json +++ b/codegen/sdk/aws-models/mediapackagev2.json @@ -840,6 +840,9 @@ "ScteHls": { "target": "com.amazonaws.mediapackagev2#ScteHls" }, + "StartTag": { + "target": "com.amazonaws.mediapackagev2#StartTag" + }, "ManifestWindowSeconds": { "target": "smithy.api#Integer", "traits": { @@ -852,7 +855,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", "smithy.api#range": { "min": 1, "max": 1209600 @@ -892,6 +895,9 @@ "ScteHls": { "target": "com.amazonaws.mediapackagev2#ScteHls" }, + "StartTag": { + "target": "com.amazonaws.mediapackagev2#StartTag" + }, "ManifestWindowSeconds": { "target": "smithy.api#Integer", "traits": { @@ -904,7 +910,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

", "smithy.api#range": { "min": 1, "max": 1209600 @@ -2370,6 +2376,12 @@ "max": 1209600 } } + }, + "ClipStartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL.

" + } } }, "traits": { @@ -2909,7 +2921,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" } }, "ScteHls": { @@ -2917,6 +2929,9 @@ }, "FilterConfiguration": { "target": "com.amazonaws.mediapackagev2#FilterConfiguration" + }, + "StartTag": { + "target": "com.amazonaws.mediapackagev2#StartTag" } }, "traits": { @@ -2961,7 +2976,7 @@ "ProgramDateTimeIntervalSeconds": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, \n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. \n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. \n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" + "smithy.api#documentation": "

Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval,\n EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest.\n The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player.\n ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

\n

Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

" } }, "ScteHls": { @@ -2969,6 +2984,9 @@ }, "FilterConfiguration": { "target": "com.amazonaws.mediapackagev2#FilterConfiguration" + }, + "StartTag": { + "target": "com.amazonaws.mediapackagev2#StartTag" } }, "traits": { @@ -4836,6 +4854,27 @@ "smithy.api#documentation": "

The parameters for the SPEKE key provider.

" } }, + "com.amazonaws.mediapackagev2#StartTag": { + "type": "structure", + "members": { + "TimeOffset": { + "target": "smithy.api#Float", + "traits": { + "smithy.api#documentation": "

Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration.

", + "smithy.api#required": {} + } + }, + "Precise": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag.

" + } + }, "com.amazonaws.mediapackagev2#TagArn": { "type": "string" }, @@ -4876,7 +4915,7 @@ "aws:TagKeys", "aws:RequestTag/${TagKey}" ], - "smithy.api#documentation": "

Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user \n permissions, by granting a user permission to access or change only resources with certain tag values.\n You can use the TagResource operation with a resource that already has tags. If you specify a new tag \n key for the resource, this tag is appended to the list of tags associated with the resource. If you \n specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

", + "smithy.api#documentation": "

Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.

\n

Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only resources with certain tag values.\n You can use the TagResource operation with a resource that already has tags. If you specify a new tag\n key for the resource, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

", "smithy.api#examples": [ { "title": "Add tags to a resource", @@ -6103,6 +6142,18 @@ "traits": { "smithy.api#enumValue": "SOURCE_DISRUPTIONS_ENABLED_INCORRECTLY" } + }, + "CLIP_START_TIME_WITH_START_OR_END": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIP_START_TIME_WITH_START_OR_END" + } + }, + "START_TAG_TIME_OFFSET_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START_TAG_TIME_OFFSET_INVALID" + } } } }, @@ -6184,7 +6235,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "\n

This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. \n To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to\n migrate your resources from MediaPackage v1 to MediaPackage v2.

\n

The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information \n added, like \"v2\", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use\n the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.

\n

If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, \n see the MediaPackage v1 Live API Reference.

\n \n

This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.

\n

We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.

", + "smithy.api#documentation": "\n

This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023.\n To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to\n migrate your resources from MediaPackage v1 to MediaPackage v2.

\n

The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information\n added, like \"v2\", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use\n the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.

\n

If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet,\n see the MediaPackage v1 Live API Reference.

\n \n

This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.

\n

We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.

", "smithy.api#title": "AWS Elemental MediaPackage v2", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk/aws-models/memorydb.json b/codegen/sdk/aws-models/memorydb.json index a3376ad257d..431cac56582 100644 --- a/codegen/sdk/aws-models/memorydb.json +++ b/codegen/sdk/aws-models/memorydb.json @@ -362,7 +362,7 @@ "name": "memorydb" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

MemoryDB is a fully managed, Redis OSS-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.\n \n MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.

", + "smithy.api#documentation": "

MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.\n \n MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.

", "smithy.api#title": "Amazon MemoryDB", "smithy.api#xmlNamespace": { "uri": "http://memorydb.amazonaws.com/doc/2021-01-01/" @@ -1461,16 +1461,22 @@ "smithy.api#documentation": "

The cluster's node type

" } }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

\n The Redis OSS or Valkey engine used by the cluster.

" + } + }, "EngineVersion": { "target": "com.amazonaws.memorydb#String", "traits": { - "smithy.api#documentation": "

The Redis OSS engine version used by the cluster

" + "smithy.api#documentation": "

The Redis engine version used by the cluster

" } }, "EnginePatchVersion": { "target": "com.amazonaws.memorydb#String", "traits": { - "smithy.api#documentation": "

The Redis OSS engine patch version used by the cluster

" + "smithy.api#documentation": "

The engine patch version used by the cluster

" } }, "ParameterGroupName": { @@ -1606,10 +1612,16 @@ "smithy.api#documentation": "

The node type used for the cluster

" } }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The configuration for the Redis OSS or Valkey engine used by the cluster.

" + } + }, "EngineVersion": { "target": "com.amazonaws.memorydb#String", "traits": { - "smithy.api#documentation": "

The Redis OSS engine version used by the cluster

" + "smithy.api#documentation": "

The engine version used by the cluster

" } }, "MaintenanceWindow": { @@ -2108,10 +2120,16 @@ "smithy.api#required": {} } }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine to be used for the nodes in this cluster. The value must be set to either Redis or Valkey.

" + } + }, "EngineVersion": { "target": "com.amazonaws.memorydb#String", "traits": { - "smithy.api#documentation": "

The version number of the Redis OSS engine to be used for the cluster.

" + "smithy.api#documentation": "

The version number of the engine to be used for the cluster.

" } }, "AutoMinorVersionUpgrade": { @@ -2593,7 +2611,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a cluster. It also deletes all associated nodes and node endpoints

\n \n

\n CreateSnapshot permission is required to create a final snapshot. \n Without this permission, the API call will fail with an Access Denied exception.

\n " + "smithy.api#documentation": "

Deletes a cluster. It also deletes all associated nodes and node endpoints

" } }, "com.amazonaws.memorydb#DeleteClusterRequest": { @@ -3027,7 +3045,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the available Redis OSS engine versions.

", + "smithy.api#documentation": "

Returns a list of the available engine versions.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3039,10 +3057,16 @@ "com.amazonaws.memorydb#DescribeEngineVersionsRequest": { "type": "structure", "members": { + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The engine version to return. Valid values are either valkey or redis.

" + } + }, "EngineVersion": { "target": "com.amazonaws.memorydb#String", "traits": { - "smithy.api#documentation": "

The Redis OSS engine version

" + "smithy.api#documentation": "

The engine version.

" } }, "ParameterGroupFamily": { @@ -3926,6 +3950,12 @@ "com.amazonaws.memorydb#EngineVersionInfo": { "type": "structure", "members": { + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The version of the Redis OSS or Valkey engine used by the cluster.

" + } + }, "EngineVersion": { "target": "com.amazonaws.memorydb#String", "traits": { @@ -3946,7 +3976,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides details of the Redis OSS engine version

" + "smithy.api#documentation": "

Provides details of the engine version.

" } }, "com.amazonaws.memorydb#EngineVersionInfoList": { @@ -5370,6 +5400,12 @@ "smithy.api#documentation": "

Reflects the nature of the service update

" } }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The MemoryDB engine to which the update applies. The values are either Redis or Valkey.

" + } + }, "NodesUpdated": { "target": "com.amazonaws.memorydb#String", "traits": { @@ -6505,6 +6541,12 @@ "smithy.api#documentation": "

A valid node type that you want to scale this cluster up or down to.

" } }, + "Engine": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the engine to be used for the nodes in this cluster. The value must be set to either Redis or Valkey.

" + } + }, "EngineVersion": { "target": "com.amazonaws.memorydb#String", "traits": { diff --git a/codegen/sdk/aws-models/neptune-graph.json b/codegen/sdk/aws-models/neptune-graph.json index 03a62605750..428904d8ad2 100644 --- a/codegen/sdk/aws-models/neptune-graph.json +++ b/codegen/sdk/aws-models/neptune-graph.json @@ -2195,7 +2195,7 @@ "format": { "target": "com.amazonaws.neptunegraph#Format", "traits": { - "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format or OPENCYPHER, which identies the openCypher\n load format.

" + "smithy.api#documentation": "

Specifies the format of S3 data to be imported. Valid values are CSV, which identifies\n the Gremlin\n CSV format, OPEN_CYPHER, which identifies the openCypher\n load format, or ntriples, which identifies the\n RDF n-triples format.

" } }, "blankNodeHandling": { @@ -5238,7 +5238,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 32, + "min": 16, "max": 24576 } } diff --git a/codegen/sdk/aws-models/organizations.json b/codegen/sdk/aws-models/organizations.json index c2b0af0ddb8..9efaec2e810 100644 --- a/codegen/sdk/aws-models/organizations.json +++ b/codegen/sdk/aws-models/organizations.json @@ -1902,7 +1902,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a policy to a root, an organizational unit (OU), or an individual account.\n How the policy affects accounts depends on the type of policy. Refer to the\n Organizations User Guide for information about each policy type:

\n \n

This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.

", + "smithy.api#documentation": "

Attaches a policy to a root, an organizational unit (OU), or an individual account.\n How the policy affects accounts depends on the type of policy. Refer to the\n Organizations User Guide for information about each policy type:

\n \n

This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.

", "smithy.api#examples": [ { "title": "To attach a policy to an account", @@ -3129,7 +3129,7 @@ "Type": { "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

The type of policy to create. You can specify one of the following values:

\n ", + "smithy.api#documentation": "

The type of policy to create. You can specify one of the following values:

\n ", "smithy.api#required": {} } }, @@ -3837,7 +3837,7 @@ "PolicyType": { "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { - "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", + "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", "smithy.api#required": {} } }, @@ -4478,7 +4478,7 @@ "PolicyType": { "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

The policy type that you want to disable in this root. You can specify one of the\n following values:

\n ", + "smithy.api#documentation": "

The policy type that you want to disable in this root. You can specify one of the\n following values:

\n ", "smithy.api#required": {} } } @@ -4630,6 +4630,12 @@ "traits": { "smithy.api#enumValue": "AISERVICES_OPT_OUT_POLICY" } + }, + "CHATBOT_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHATBOT_POLICY" + } } } }, @@ -4867,7 +4873,7 @@ "PolicyType": { "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

The policy type that you want to enable. You can specify one of the following\n values:

\n ", + "smithy.api#documentation": "

The policy type that you want to enable. You can specify one of the following\n values:

\n ", "smithy.api#required": {} } } @@ -7116,7 +7122,7 @@ "Filter": { "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

The type of policy that you want to include in the returned list. You must specify one\n of the following values:

\n ", + "smithy.api#documentation": "

The type of policy that you want to include in the returned list. You must specify one\n of the following values:

\n ", "smithy.api#required": {} } }, @@ -7163,7 +7169,7 @@ "Filter": { "target": "com.amazonaws.organizations#PolicyType", "traits": { - "smithy.api#documentation": "

Specifies the type of policy that you want to include in the response. You must\n specify one of the following values:

\n ", + "smithy.api#documentation": "

Specifies the type of policy that you want to include in the response. You must\n specify one of the following values:

\n ", "smithy.api#required": {} } }, @@ -8107,6 +8113,12 @@ "traits": { "smithy.api#enumValue": "AISERVICES_OPT_OUT_POLICY" } + }, + "CHATBOT_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHATBOT_POLICY" + } } } }, diff --git a/codegen/sdk/aws-models/outposts.json b/codegen/sdk/aws-models/outposts.json index ab20bd0f19b..50c92efa94f 100644 --- a/codegen/sdk/aws-models/outposts.json +++ b/codegen/sdk/aws-models/outposts.json @@ -3200,7 +3200,7 @@ "Status": { "target": "com.amazonaws.outposts#OrderStatus", "traits": { - "smithy.api#documentation": "

The status of the order.

\n
    \n
  • \n

    \n PREPARING - Order is received and being prepared.

    \n
    • \n
  • \n

    \n IN_PROGRESS - Order is either being built, shipped, or installed. To get\n more details, see the line item status.

    \n
    • \n
  • \n

    \n COMPLETED - Order is complete.

    \n
    • \n
  • \n

    \n CANCELLED - Order is cancelled.

    \n
    • \n
  • \n

    \n ERROR - Customer should contact support.

    \n
    • \n
\n \n

The following status are deprecated: RECEIVED, PENDING,\n PROCESSING, INSTALLING, and FULFILLED.

\n " + "smithy.api#documentation": "

The status of the order.

\n
    \n
  • \n

    \n PREPARING - Order is received and being prepared.

    \n
    • \n
  • \n

    \n IN_PROGRESS - Order is either being built or shipped. To get\n more details, see the line item status.

    \n
    • \n
  • \n

    \n DELIVERED - Order was delivered to the Outpost site.

    \n
    • \n
  • \n

    \n COMPLETED - Order is complete.

    \n
    • \n
  • \n

    \n CANCELLED - Order is cancelled.

    \n
    • \n
  • \n

    \n ERROR - Customer should contact support.

    \n
    • \n
\n \n

The following status are deprecated: RECEIVED, PENDING,\n PROCESSING, INSTALLING, and FULFILLED.

\n " } }, "LineItems": { @@ -3305,6 +3305,12 @@ "smithy.api#enumValue": "IN_PROGRESS" } }, + "DELIVERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERED" + } + }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { diff --git a/codegen/sdk/aws-models/payment-cryptography-data.json b/codegen/sdk/aws-models/payment-cryptography-data.json index e551c23b9c6..08d6e006de7 100644 --- a/codegen/sdk/aws-models/payment-cryptography-data.json +++ b/codegen/sdk/aws-models/payment-cryptography-data.json @@ -14,6 +14,55 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.paymentcryptographydata#AmexAttributes": { + "type": "structure", + "members": { + "MajorKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode", + "traits": { + "smithy.api#documentation": "

The method to use when deriving the master key for a payment card using Amex derivation.

", + "smithy.api#required": {} + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#PrimaryAccountNumberType", + "traits": { + "smithy.api#documentation": "

The Primary Account Number (PAN) of the cardholder.

", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals2", + "traits": { + "smithy.api#documentation": "

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.

", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals4", + "traits": { + "smithy.api#documentation": "

The transaction counter of the current transaction that is provided by the terminal during transaction processing.

", + "smithy.api#required": {} + } + }, + "AuthorizationRequestKeyIdentifier": { + "target": "com.amazonaws.paymentcryptographydata#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "

The keyArn of the issuer master key for cryptogram (IMK-AC) for the payment card.

", + "smithy.api#required": {} + } + }, + "CurrentPinAttributes": { + "target": "com.amazonaws.paymentcryptographydata#CurrentPinAttributes", + "traits": { + "smithy.api#documentation": "

The encrypted pinblock of the old pin stored on the chip card.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a payment card using Amex derivation method.

" + } + }, "com.amazonaws.paymentcryptographydata#AmexCardSecurityCodeVersion1": { "type": "structure", "members": { @@ -279,13 +328,24 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 16, + "min": 2, "max": 4096 }, "smithy.api#pattern": "^(?:[0-9a-fA-F][0-9a-fA-F])+$", "smithy.api#sensitive": {} } }, + "com.amazonaws.paymentcryptographydata#CommandMessageDataType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 1024 + }, + "smithy.api#pattern": "^(?:[0-9a-fA-F][0-9a-fA-F])+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.paymentcryptographydata#CryptogramAuthResponse": { "type": "union", "members": { @@ -342,6 +402,28 @@ "smithy.api#documentation": "

Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.

" } }, + "com.amazonaws.paymentcryptographydata#CurrentPinAttributes": { + "type": "structure", + "members": { + "CurrentPinPekIdentifier": { + "target": "com.amazonaws.paymentcryptographydata#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "

The keyArn of the current PIN PEK.

", + "smithy.api#required": {} + } + }, + "CurrentEncryptedPinBlock": { + "target": "com.amazonaws.paymentcryptographydata#PinBlockLengthEquals16", + "traits": { + "smithy.api#documentation": "

The encrypted pinblock of the current pin stored on the chip card.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameter values of the current PIN to be changed on the EMV chip card.

" + } + }, "com.amazonaws.paymentcryptographydata#DecimalizationTableType": { "type": "string", "traits": { @@ -379,7 +461,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.

\n

You can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling GetPublicCertificate.

\n

For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.

\n

When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

\n

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

\n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", + "smithy.api#documentation": "

Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.

\n

You can use an decryption key generated within Amazon Web Services Payment Cryptography, or you can import your own decryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling GetPublicCertificate.

\n

This operation also supports dynamic keys, allowing you to pass a dynamic decryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To decrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped decryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.

\n

For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.

\n

When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

\n

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

\n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/keys/{KeyIdentifier}/decrypt", @@ -452,6 +534,44 @@ "smithy.api#output": {} } }, + "com.amazonaws.paymentcryptographydata#DerivationMethodAttributes": { + "type": "union", + "members": { + "EmvCommon": { + "target": "com.amazonaws.paymentcryptographydata#EmvCommonAttributes", + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a payment card using Emv common derivation method.

" + } + }, + "Amex": { + "target": "com.amazonaws.paymentcryptographydata#AmexAttributes", + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a payment card using Amex derivation method.

" + } + }, + "Visa": { + "target": "com.amazonaws.paymentcryptographydata#VisaAttributes", + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a a payment card using Visa derivation method.

" + } + }, + "Emv2000": { + "target": "com.amazonaws.paymentcryptographydata#Emv2000Attributes", + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a payment card using Emv2000 derivation method.

" + } + }, + "Mastercard": { + "target": "com.amazonaws.paymentcryptographydata#MasterCardAttributes", + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a payment card using Mastercard derivation method.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters to derive the payment card specific confidentiality and integrity keys.

" + } + }, "com.amazonaws.paymentcryptographydata#DiscoverDynamicCardVerificationCode": { "type": "structure", "members": { @@ -531,30 +651,38 @@ } }, "com.amazonaws.paymentcryptographydata#DukptDerivationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TDES_2KEY", - "name": "TDES_2KEY" - }, - { - "value": "TDES_3KEY", - "name": "TDES_3KEY" - }, - { - "value": "AES_128", - "name": "AES_128" - }, - { - "value": "AES_192", - "name": "AES_192" - }, - { - "value": "AES_256", - "name": "AES_256" + "type": "enum", + "members": { + "TDES_2KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TDES_2KEY" } - ] + }, + "TDES_3KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TDES_3KEY" + } + }, + "AES_128": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES_128" + } + }, + "AES_192": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES_192" + } + }, + "AES_256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AES_256" + } + } } }, "com.amazonaws.paymentcryptographydata#DukptEncryptionAttributes": { @@ -597,37 +725,43 @@ } }, "com.amazonaws.paymentcryptographydata#DukptEncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ECB", - "name": "ECB" - }, - { - "value": "CBC", - "name": "CBC" + "type": "enum", + "members": { + "ECB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECB" } - ] + }, + "CBC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBC" + } + } } }, "com.amazonaws.paymentcryptographydata#DukptKeyVariant": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BIDIRECTIONAL", - "name": "BIDIRECTIONAL" - }, - { - "value": "REQUEST", - "name": "REQUEST" - }, - { - "value": "RESPONSE", - "name": "RESPONSE" + "type": "enum", + "members": { + "BIDIRECTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIDIRECTIONAL" } - ] + }, + "REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUEST" + } + }, + "RESPONSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSE" + } + } } }, "com.amazonaws.paymentcryptographydata#DynamicCardVerificationCode": { @@ -702,6 +836,99 @@ "smithy.api#documentation": "

Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).

" } }, + "com.amazonaws.paymentcryptographydata#Emv2000Attributes": { + "type": "structure", + "members": { + "MajorKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode", + "traits": { + "smithy.api#documentation": "

The method to use when deriving the master key for the payment card.

", + "smithy.api#required": {} + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#PrimaryAccountNumberType", + "traits": { + "smithy.api#documentation": "

The Primary Account Number (PAN) of the cardholder.

", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals2", + "traits": { + "smithy.api#documentation": "

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.

", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals4", + "traits": { + "smithy.api#documentation": "

The transaction counter of the current transaction that is provided by the terminal during transaction processing.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a payment card using EMV2000 deruv.

" + } + }, + "com.amazonaws.paymentcryptographydata#EmvCommonAttributes": { + "type": "structure", + "members": { + "MajorKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode", + "traits": { + "smithy.api#documentation": "

The method to use when deriving the master key for the payment card.

", + "smithy.api#required": {} + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#PrimaryAccountNumberType", + "traits": { + "smithy.api#documentation": "

The Primary Account Number (PAN) of the cardholder.

", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals2", + "traits": { + "smithy.api#documentation": "

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.

", + "smithy.api#required": {} + } + }, + "ApplicationCryptogram": { + "target": "com.amazonaws.paymentcryptographydata#ApplicationCryptogramType", + "traits": { + "smithy.api#documentation": "

The application cryptogram for the current transaction that is provided by the terminal during transaction processing.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.paymentcryptographydata#EmvEncryptionMode", + "traits": { + "smithy.api#documentation": "

The block cipher method to use for encryption.

", + "smithy.api#required": {} + } + }, + "PinBlockPaddingType": { + "target": "com.amazonaws.paymentcryptographydata#PinBlockPaddingType", + "traits": { + "smithy.api#documentation": "

The padding to be added to the PIN block prior to encryption.

\n

Padding type should be ISO_IEC_7816_4, if PinBlockLengthPosition is set to FRONT_OF_PIN_BLOCK. No padding is required, if PinBlockLengthPosition is set to NONE.

", + "smithy.api#required": {} + } + }, + "PinBlockLengthPosition": { + "target": "com.amazonaws.paymentcryptographydata#PinBlockLengthPosition", + "traits": { + "smithy.api#documentation": "

Specifies if PIN block length should be added to front of the pin block.

\n

If value is set to FRONT_OF_PIN_BLOCK, then PIN block padding type should be ISO_IEC_7816_4.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for an Emv common payment card.

" + } + }, "com.amazonaws.paymentcryptographydata#EmvEncryptionAttributes": { "type": "structure", "members": { @@ -722,7 +949,7 @@ "PanSequenceNumber": { "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals2", "traits": { - "smithy.api#documentation": "

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

", + "smithy.api#documentation": "

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.

", "smithy.api#required": {} } }, @@ -751,33 +978,37 @@ } }, "com.amazonaws.paymentcryptographydata#EmvEncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ECB", - "name": "ECB" - }, - { - "value": "CBC", - "name": "CBC" + "type": "enum", + "members": { + "ECB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECB" } - ] + }, + "CBC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBC" + } + } } }, "com.amazonaws.paymentcryptographydata#EmvMajorKeyDerivationMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EMV_OPTION_A", - "name": "EMV_OPTION_A" - }, - { - "value": "EMV_OPTION_B", - "name": "EMV_OPTION_B" + "type": "enum", + "members": { + "EMV_OPTION_A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMV_OPTION_A" } - ] + }, + "EMV_OPTION_B": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMV_OPTION_B" + } + } } }, "com.amazonaws.paymentcryptographydata#EncryptData": { @@ -806,7 +1037,7 @@ } ], "traits": { - "smithy.api#documentation": "

Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

\n

You can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey.

\n

For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA.

\n

When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

\n

To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.

\n

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

\n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", + "smithy.api#documentation": "

Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

\n

You can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey.

\n

For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey.

\n

This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.

\n

For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA.

\n

When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

\n

To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.

\n

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

\n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/keys/{KeyIdentifier}/encrypt", @@ -916,42 +1147,56 @@ } }, "com.amazonaws.paymentcryptographydata#EncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ECB", - "name": "ECB" - }, - { - "value": "CBC", - "name": "CBC" - }, - { - "value": "CFB", - "name": "CFB" - }, - { - "value": "CFB1", - "name": "CFB1" - }, - { - "value": "CFB8", - "name": "CFB8" - }, - { - "value": "CFB64", - "name": "CFB64" - }, - { - "value": "CFB128", - "name": "CFB128" - }, - { - "value": "OFB", - "name": "OFB" + "type": "enum", + "members": { + "ECB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECB" } - ] + }, + "CBC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CBC" + } + }, + "CFB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CFB" + } + }, + "CFB1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CFB1" + } + }, + "CFB8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CFB8" + } + }, + "CFB64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CFB64" + } + }, + "CFB128": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CFB128" + } + }, + "OFB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFB" + } + } } }, "com.amazonaws.paymentcryptographydata#GenerateCardValidationData": { @@ -1086,6 +1331,167 @@ } } }, + "com.amazonaws.paymentcryptographydata#GenerateMacEmvPinChange": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#GenerateMacEmvPinChangeInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#GenerateMacEmvPinChangeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates an issuer script mac for EMV payment cards that use offline PINs as the cardholder verification method (CVM).

\n

This operation generates an authenticated issuer script response by appending the incoming message data (APDU command) with the target encrypted PIN block in ISO2 format. The command structure and method to send the issuer script update to the card is not defined by this operation and is typically determined by the applicable payment card scheme.

\n

The primary inputs to this operation include the incoming new encrypted pinblock, PIN encryption key (PEK), issuer master key (IMK), primary account number (PAN), and the payment card derivation method.

\n

The operation uses two issuer master keys - secure messaging for confidentiality (IMK-SMC) and secure messaging for integrity (IMK-SMI). The SMC key is used to internally derive a key to secure the pin, while SMI key is used to internally derive a key to authenticate the script reponse as per the EMV 4.4 - Book 2 - Security and Key Management specification.

\n

This operation supports Amex, EMV2000, EMVCommon, Mastercard and Visa derivation methods, each requiring specific input parameters. Users must follow the specific derivation method and input parameters defined by the respective payment card scheme.

\n \n

Use GenerateMac operation when sending a script update to an EMV card that does not involve PIN change. When assigning IAM permissions, it is important to understand that EncryptData using EMV keys and GenerateMac perform similar functions to this command.

\n \n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/macemvpinchange/generate", + "code": 200 + } + } + }, + "com.amazonaws.paymentcryptographydata#GenerateMacEmvPinChangeInput": { + "type": "structure", + "members": { + "NewPinPekIdentifier": { + "target": "com.amazonaws.paymentcryptographydata#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "

The keyARN of the PEK protecting the incoming new encrypted PIN block.

", + "smithy.api#required": {} + } + }, + "NewEncryptedPinBlock": { + "target": "com.amazonaws.paymentcryptographydata#PinBlockLengthEquals16", + "traits": { + "smithy.api#documentation": "

The incoming new encrypted PIN block data for offline pin change on an EMV card.

", + "smithy.api#required": {} + } + }, + "PinBlockFormat": { + "target": "com.amazonaws.paymentcryptographydata#PinBlockFormatForEmvPinChange", + "traits": { + "smithy.api#documentation": "

The PIN encoding format of the incoming new encrypted PIN block as specified in ISO 9564.

", + "smithy.api#required": {} + } + }, + "SecureMessagingIntegrityKeyIdentifier": { + "target": "com.amazonaws.paymentcryptographydata#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "

The keyARN of the issuer master key (IMK-SMI) used to authenticate the issuer script response.

", + "smithy.api#required": {} + } + }, + "SecureMessagingConfidentialityKeyIdentifier": { + "target": "com.amazonaws.paymentcryptographydata#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "

The keyARN of the issuer master key (IMK-SMC) used to protect the PIN block data in the issuer script response.

", + "smithy.api#required": {} + } + }, + "MessageData": { + "target": "com.amazonaws.paymentcryptographydata#CommandMessageDataType", + "traits": { + "smithy.api#documentation": "

The message data is the APDU command from the card reader or terminal. The target encrypted PIN block, after translation to ISO2 format, is appended to this message data to generate an issuer script response.

", + "smithy.api#required": {} + } + }, + "DerivationMethodAttributes": { + "target": "com.amazonaws.paymentcryptographydata#DerivationMethodAttributes", + "traits": { + "smithy.api#documentation": "

The attributes and data values to derive payment card specific confidentiality and integrity keys.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#GenerateMacEmvPinChangeOutput": { + "type": "structure", + "members": { + "NewPinPekArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "

Returns the keyArn of the PEK protecting the incoming new encrypted PIN block.

", + "smithy.api#required": {} + } + }, + "SecureMessagingIntegrityKeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "

Returns the keyArn of the IMK-SMI used by the operation.

", + "smithy.api#required": {} + } + }, + "SecureMessagingConfidentialityKeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "

Returns the keyArn of the IMK-SMC used by the operation.

", + "smithy.api#required": {} + } + }, + "Mac": { + "target": "com.amazonaws.paymentcryptographydata#PinChangeMacOutputType", + "traits": { + "smithy.api#documentation": "

Returns the mac of the issuer script containing message data and appended target encrypted pin block in ISO2 format.

", + "smithy.api#required": {} + } + }, + "EncryptedPinBlock": { + "target": "com.amazonaws.paymentcryptographydata#EncryptedPinBlockType", + "traits": { + "smithy.api#documentation": "

Returns the incoming new encrpted PIN block.

", + "smithy.api#required": {} + } + }, + "NewPinPekKeyCheckValue": { + "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", + "traits": { + "smithy.api#documentation": "

The key check value (KCV) of the PEK uprotecting the incoming new encrypted PIN block.

", + "smithy.api#required": {} + } + }, + "SecureMessagingIntegrityKeyCheckValue": { + "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", + "traits": { + "smithy.api#documentation": "

The key check value (KCV) of the SMI issuer master key used by the operation.

", + "smithy.api#required": {} + } + }, + "SecureMessagingConfidentialityKeyCheckValue": { + "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", + "traits": { + "smithy.api#documentation": "

The key check value (KCV) of the SMC issuer master key used by the operation.

", + "smithy.api#required": {} + } + }, + "VisaAmexDerivationOutputs": { + "target": "com.amazonaws.paymentcryptographydata#VisaAmexDerivationOutputs", + "traits": { + "smithy.api#documentation": "

The attribute values used for Amex and Visa derivation methods.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.paymentcryptographydata#GenerateMacInput": { "type": "structure", "members": { @@ -1211,7 +1617,6 @@ "PinDataLength": { "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween4And12", "traits": { - "smithy.api#default": null, "smithy.api#documentation": "

The length of PIN under generation.

" } }, @@ -1620,47 +2025,59 @@ "name": "CMAC" }, { - "value": "ANSI_X9_24", - "name": "ANSI_X9_24" - } - ] - } - }, - "com.amazonaws.paymentcryptographydata#MacAlgorithm": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ISO9797_ALGORITHM1", - "name": "ISO9797_ALGORITHM1" - }, - { - "value": "ISO9797_ALGORITHM3", - "name": "ISO9797_ALGORITHM3" - }, - { - "value": "CMAC", - "name": "CMAC" - }, - { - "value": "HMAC_SHA224", - "name": "HMAC_SHA224" - }, - { - "value": "HMAC_SHA256", - "name": "HMAC_SHA256" - }, - { - "value": "HMAC_SHA384", - "name": "HMAC_SHA384" - }, - { - "value": "HMAC_SHA512", - "name": "HMAC_SHA512" + "value": "ANSI_X9_24", + "name": "ANSI_X9_24" } ] } }, + "com.amazonaws.paymentcryptographydata#MacAlgorithm": { + "type": "enum", + "members": { + "ISO9797_ALGORITHM1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISO9797_ALGORITHM1" + } + }, + "ISO9797_ALGORITHM3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISO9797_ALGORITHM3" + } + }, + "CMAC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CMAC" + } + }, + "HMAC_SHA224": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HMAC_SHA224" + } + }, + "HMAC_SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HMAC_SHA256" + } + }, + "HMAC_SHA384": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HMAC_SHA384" + } + }, + "HMAC_SHA512": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HMAC_SHA512" + } + } + } + }, "com.amazonaws.paymentcryptographydata#MacAlgorithmDukpt": { "type": "structure", "members": { @@ -1793,18 +2210,56 @@ } }, "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EMV_OPTION_A", - "name": "EMV_OPTION_A" - }, - { - "value": "EMV_OPTION_B", - "name": "EMV_OPTION_B" + "type": "enum", + "members": { + "EMV_OPTION_A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMV_OPTION_A" } - ] + }, + "EMV_OPTION_B": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMV_OPTION_B" + } + } + } + }, + "com.amazonaws.paymentcryptographydata#MasterCardAttributes": { + "type": "structure", + "members": { + "MajorKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode", + "traits": { + "smithy.api#documentation": "

The method to use when deriving the master key for the payment card.

", + "smithy.api#required": {} + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#PrimaryAccountNumberType", + "traits": { + "smithy.api#documentation": "

The Primary Account Number (PAN) of the cardholder.

", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals2", + "traits": { + "smithy.api#documentation": "

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.

", + "smithy.api#required": {} + } + }, + "ApplicationCryptogram": { + "target": "com.amazonaws.paymentcryptographydata#ApplicationCryptogramType", + "traits": { + "smithy.api#documentation": "

The application cryptogram for the current transaction that is provided by the terminal during transaction processing.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a Mastercard payment card.

" } }, "com.amazonaws.paymentcryptographydata#MessageDataType": { @@ -1829,26 +2284,32 @@ } }, "com.amazonaws.paymentcryptographydata#PaddingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PKCS1", - "name": "PKCS1" - }, - { - "value": "OAEP_SHA1", - "name": "OAEP_SHA1" - }, - { - "value": "OAEP_SHA256", - "name": "OAEP_SHA256" - }, - { - "value": "OAEP_SHA512", - "name": "OAEP_SHA512" + "type": "enum", + "members": { + "PKCS1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PKCS1" } - ] + }, + "OAEP_SHA1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAEP_SHA1" + } + }, + "OAEP_SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAEP_SHA256" + } + }, + "OAEP_SHA512": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAEP_SHA512" + } + } } }, "com.amazonaws.paymentcryptographydata#PaymentCryptographyDataPlane": { @@ -1867,6 +2328,9 @@ { "target": "com.amazonaws.paymentcryptographydata#GenerateMac" }, + { + "target": "com.amazonaws.paymentcryptographydata#GenerateMacEmvPinChange" + }, { "target": "com.amazonaws.paymentcryptographydata#GeneratePinData" }, @@ -2568,19 +3032,100 @@ } } }, + "com.amazonaws.paymentcryptographydata#PinBlockFormatForEmvPinChange": { + "type": "enum", + "members": { + "ISO_FORMAT_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISO_FORMAT_0" + } + }, + "ISO_FORMAT_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISO_FORMAT_1" + } + }, + "ISO_FORMAT_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISO_FORMAT_3" + } + } + } + }, "com.amazonaws.paymentcryptographydata#PinBlockFormatForPinData": { + "type": "enum", + "members": { + "ISO_FORMAT_0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISO_FORMAT_0" + } + }, + "ISO_FORMAT_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISO_FORMAT_3" + } + } + } + }, + "com.amazonaws.paymentcryptographydata#PinBlockLengthEquals16": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "ISO_FORMAT_0", - "name": "ISO_FORMAT_0" - }, - { - "value": "ISO_FORMAT_3", - "name": "ISO_FORMAT_3" + "smithy.api#length": { + "min": 16, + "max": 16 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptographydata#PinBlockLengthPosition": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" } - ] + }, + "FRONT_OF_PIN_BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRONT_OF_PIN_BLOCK" + } + } + } + }, + "com.amazonaws.paymentcryptographydata#PinBlockPaddingType": { + "type": "enum", + "members": { + "NO_PADDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PADDING" + } + }, + "ISO_IEC_7816_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISO_IEC_7816_4" + } + } + } + }, + "com.amazonaws.paymentcryptographydata#PinChangeMacOutputType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 16 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.paymentcryptographydata#PinData": { @@ -2693,7 +3238,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 16, + "min": 2, "max": 4096 }, "smithy.api#pattern": "^(?:[0-9a-fA-F][0-9a-fA-F])+$", @@ -2704,7 +3249,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 16, + "min": 2, "max": 4064 }, "smithy.api#pattern": "^(?:[0-9a-fA-F][0-9a-fA-F])+$", @@ -2759,7 +3304,7 @@ } ], "traits": { - "smithy.api#documentation": "

Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.

\n

You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt.

\n

For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.

\n

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

\n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", + "smithy.api#documentation": "

Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.

\n

You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt.

\n

This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To re-encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.

\n

For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.

\n

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

\n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/keys/{IncomingKeyIdentifier}/reencrypt", @@ -2968,30 +3513,38 @@ } }, "com.amazonaws.paymentcryptographydata#SessionKeyDerivationMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EMV_COMMON_SESSION_KEY", - "name": "EMV_COMMON_SESSION_KEY" - }, - { - "value": "EMV2000", - "name": "EMV2000" - }, - { - "value": "AMEX", - "name": "AMEX" - }, - { - "value": "MASTERCARD_SESSION_KEY", - "name": "MASTERCARD_SESSION_KEY" - }, - { - "value": "VISA", - "name": "VISA" + "type": "enum", + "members": { + "EMV_COMMON_SESSION_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMV_COMMON_SESSION_KEY" } - ] + }, + "EMV2000": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMV2000" + } + }, + "AMEX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMEX" + } + }, + "MASTERCARD_SESSION_KEY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MASTERCARD_SESSION_KEY" + } + }, + "VISA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VISA" + } + } } }, "com.amazonaws.paymentcryptographydata#SessionKeyDerivationValue": { @@ -3004,7 +3557,7 @@ } }, "ApplicationTransactionCounter": { - "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals4", "traits": { "smithy.api#documentation": "

The transaction counter that is provided by the terminal during transaction processing.

" } @@ -3032,7 +3585,7 @@ } }, "ApplicationTransactionCounter": { - "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals4", "traits": { "smithy.api#documentation": "

The transaction counter that is provided by the terminal during transaction processing.

", "smithy.api#required": {} @@ -3061,7 +3614,7 @@ } }, "ApplicationTransactionCounter": { - "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals4", "traits": { "smithy.api#documentation": "

The transaction counter that is provided by the terminal during transaction processing.

", "smithy.api#required": {} @@ -3090,7 +3643,7 @@ } }, "ApplicationTransactionCounter": { - "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals4", "traits": { "smithy.api#documentation": "

The transaction counter that is provided by the terminal during transaction processing.

", "smithy.api#required": {} @@ -3229,7 +3782,7 @@ } ], "traits": { - "smithy.api#documentation": "

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.

\n

PIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT translations.

\n

The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.

\n

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

\n \n

Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.

\n \n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", + "smithy.api#documentation": "

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.

\n

PIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT translations.

\n

This operation also supports dynamic keys, allowing you to pass a dynamic PEK as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To translate PIN block using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped PEK. The incoming wrapped key shall have a key purpose of P0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.

\n

The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.

\n

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

\n \n

Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.

\n \n

\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.

\n

\n Related operations:\n

\n ", "smithy.api#http": { "method": "POST", "uri": "/pindata/translate", @@ -3899,7 +4452,6 @@ "PinDataLength": { "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween4And12", "traits": { - "smithy.api#default": null, "smithy.api#documentation": "

The length of PIN being verified.

" } }, @@ -3950,6 +4502,89 @@ "smithy.api#output": {} } }, + "com.amazonaws.paymentcryptographydata#VisaAmexDerivationOutputs": { + "type": "structure", + "members": { + "AuthorizationRequestKeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "

The keyArn of the issuer master key for cryptogram (IMK-AC) used by the operation.

", + "smithy.api#required": {} + } + }, + "AuthorizationRequestKeyCheckValue": { + "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", + "traits": { + "smithy.api#documentation": "

The key check value (KCV) of the issuer master key for cryptogram (IMK-AC) used by the operation.

", + "smithy.api#required": {} + } + }, + "CurrentPinPekArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "

The keyArn of the current PIN PEK.

" + } + }, + "CurrentPinPekKeyCheckValue": { + "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", + "traits": { + "smithy.api#documentation": "

The key check value (KCV) of the current PIN PEK.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The attributes values used for Amex and Visa derivation methods.

" + } + }, + "com.amazonaws.paymentcryptographydata#VisaAttributes": { + "type": "structure", + "members": { + "MajorKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode", + "traits": { + "smithy.api#documentation": "

The method to use when deriving the master key for the payment card.

", + "smithy.api#required": {} + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#PrimaryAccountNumberType", + "traits": { + "smithy.api#documentation": "

The Primary Account Number (PAN) of the cardholder.

", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals2", + "traits": { + "smithy.api#documentation": "

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.

", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals4", + "traits": { + "smithy.api#documentation": "

The transaction counter of the current transaction that is provided by the terminal during transaction processing.

", + "smithy.api#required": {} + } + }, + "AuthorizationRequestKeyIdentifier": { + "target": "com.amazonaws.paymentcryptographydata#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "

The keyArn of the issuer master key for cryptogram (IMK-AC) for the payment card.

", + "smithy.api#required": {} + } + }, + "CurrentPinAttributes": { + "target": "com.amazonaws.paymentcryptographydata#CurrentPinAttributes", + "traits": { + "smithy.api#documentation": "

The encrypted pinblock of the old pin stored on the chip card.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters to derive the confidentiality and integrity keys for a Visa payment card.

" + } + }, "com.amazonaws.paymentcryptographydata#VisaPin": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/pcs.json b/codegen/sdk/aws-models/pcs.json index 9b954eeee93..b823ea8f277 100644 --- a/codegen/sdk/aws-models/pcs.json +++ b/codegen/sdk/aws-models/pcs.json @@ -1156,7 +1156,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances\n correctly.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the pcs:RegisterComputeNodeGroupInstance\n permission. The resource identifier of the ARN must start with \n AWSPCS or it must have /aws-pcs/ in its path.

\n

\n Examples\n

\n
    \n
  • \n

    \n arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1\n

    \n
    • \n
  • \n

    \n arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -1642,7 +1642,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n pcs:RegisterComputeNodeGroupInstance permissions attached in order to\n provision instances correctly. The resource identifier of the ARN must start with \n AWSPCS. For example, arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.\n

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the pcs:RegisterComputeNodeGroupInstance\n permission. The resource identifier of the ARN must start with \n AWSPCS or it must have /aws-pcs/ in its path.

\n

\n Examples\n

\n
    \n
  • \n

    \n arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1\n

    \n
    • \n
  • \n

    \n arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -3362,7 +3362,7 @@ "parameterName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Amazon Web Services PCS supports configuration of the following Slurm parameters: \n Prolog\n , \n Epilog\n , and \n SelectTypeParameters\n .

", + "smithy.api#documentation": "

Amazon Web Services PCS supports configuration of the following Slurm parameters:

\n ", "smithy.api#required": {} } }, @@ -3722,7 +3722,7 @@ "iamInstanceProfileArn": { "target": "com.amazonaws.pcs#InstanceProfileArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the \n IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have\n pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances\n correctly.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM instance \n profile used to pass an IAM role when launching EC2 instances. The role contained \n in your instance profile must have the pcs:RegisterComputeNodeGroupInstance\n permission. The resource identifier of the ARN must start with \n AWSPCS or it must have /aws-pcs/ in its path.

\n

\n Examples\n

\n
    \n
  • \n

    \n arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1\n

    \n
    • \n
  • \n

    \n arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2\n

    \n
    • \n
" } }, "slurmConfiguration": { diff --git a/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json b/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json index e5717832f6b..7424dcd3b6c 100644 --- a/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json +++ b/codegen/sdk/aws-models/pinpoint-sms-voice-v2.json @@ -204,14 +204,14 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The pool to update with the new Identity. This value can be either the PoolId or\n PoolArn, and you can find these values using DescribePools.

", + "smithy.api#documentation": "

The pool to update with the new Identity. This value can be either the PoolId or\n PoolArn, and you can find these values using DescribePools.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

", + "smithy.api#documentation": "

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -1149,7 +1149,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

", + "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -1568,7 +1568,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” (LOA) to be submitted.

" + "smithy.api#documentation": "

Create a new registration attachment to use for uploading a file or a URL to a file.\n The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For\n example, many sender ID registrations require a signed “letter of authorization” (LOA)\n to be submitted.

\n

Use either AttachmentUrl or AttachmentBody to upload your attachment. If both are specified then an exception is returned.

" } }, "com.amazonaws.pinpointsmsvoicev2#CreateRegistrationAttachmentRequest": { @@ -1577,13 +1577,13 @@ "AttachmentBody": { "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentBody", "traits": { - "smithy.api#documentation": "

The registration file to upload. The maximum file size is 1MiB and valid file extensions are PDF, JPEG and PNG.

" + "smithy.api#documentation": "

The registration file to upload. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG.

" } }, "AttachmentUrl": { "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentUrl", "traits": { - "smithy.api#documentation": "

A URL to the required registration file. For example, you can provide the S3 object URL.

" + "smithy.api#documentation": "

Registration files have to be stored in an Amazon S3 bucket. The URI to use when sending is in the format s3://BucketName/FileName.

" } }, "Tags": { @@ -2339,7 +2339,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.

", + "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -2478,7 +2478,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

", + "smithy.api#documentation": "

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } } @@ -2551,7 +2551,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn to remove the phone number from.

", + "smithy.api#documentation": "

The OptOutListName or OptOutListArn to remove the phone number from.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -2644,7 +2644,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

", + "smithy.api#documentation": "

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } } @@ -3134,6 +3134,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource you're deleting the resource-based policy from.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource that the resource-based policy was deleted from.

" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The JSON formatted resource-based policy that was deleted.

" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the resource-based policy was created, in UNIX epoch time format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride": { "type": "operation", "input": { @@ -3581,7 +3651,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

", + "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -3684,7 +3754,7 @@ "OptOutListNames": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList", "traits": { - "smithy.api#documentation": "

The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.

" + "smithy.api#documentation": "

The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "NextToken": { @@ -3698,6 +3768,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return per each request.

" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "

Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.

" + } } }, "traits": { @@ -3750,7 +3826,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified opted out destination numbers or all opted out destination\n numbers in an opt-out list.

\n

If you specify opted out numbers, the output includes information for only the\n specified opted out numbers. If you specify filters, the output includes information for\n only those opted out numbers that meet the filter criteria. If you don't specify opted\n out numbers or filters, the output includes information for all opted out destination\n numbers in your opt-out list.

\n

If you specify an opted out number that isn't valid, an error is returned.

", + "smithy.api#documentation": "

Describes the specified opted out destination numbers or all opted out destination\n numbers in an opt-out list.

\n

If you specify opted out numbers, the output includes information for only the\n specified opted out numbers. If you specify filters, the output includes information for\n only those opted out numbers that meet the filter criteria. If you don't specify opted\n out numbers or filters, the output includes information for all opted out destination\n numbers in your opt-out list.

\n

If you specify an opted out number that isn't valid, an exception is returned.

", "smithy.api#paginated": { "items": "OptedOutNumbers" } @@ -3762,14 +3838,14 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

", + "smithy.api#documentation": "

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, "OptedOutNumbers": { "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberList", "traits": { - "smithy.api#documentation": "

An array of phone numbers to search for in the OptOutList.

" + "smithy.api#documentation": "

An array of phone numbers to search for in the OptOutList.

\n

If you specify an opted out number that isn't valid, an exception is returned.

" } }, "Filters": { @@ -3865,7 +3941,7 @@ "PhoneNumberIds": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList", "traits": { - "smithy.api#documentation": "

The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.

" + "smithy.api#documentation": "

The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "Filters": { @@ -3885,6 +3961,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return per each request.

" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "

Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.

" + } } }, "traits": { @@ -3949,7 +4031,7 @@ "PoolIds": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdList", "traits": { - "smithy.api#documentation": "

The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.

" + "smithy.api#documentation": "

The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "Filters": { @@ -3969,6 +4051,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return per each request.

" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "

Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.

" + } } }, "traits": { @@ -4780,7 +4868,7 @@ "SenderIds": { "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdList", "traits": { - "smithy.api#documentation": "

An array of SenderIdAndCountry objects to search for.

" + "smithy.api#documentation": "

An array of SenderIdAndCountry objects to search for.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "Filters": { @@ -4800,6 +4888,12 @@ "traits": { "smithy.api#documentation": "

The maximum number of results to return per each request.

" } + }, + "Owner": { + "target": "com.amazonaws.pinpointsmsvoicev2#Owner", + "traits": { + "smithy.api#documentation": "

Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

" + } } }, "traits": { @@ -5074,14 +5168,14 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.

", + "smithy.api#documentation": "

The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.

", + "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -5740,6 +5834,76 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the JSON text of the resource-based policy document attached to the AWS End User Messaging SMS and Voice resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The JSON formatted string that contains the resource-based policy attached to the AWS End User Messaging SMS and Voice resource.

" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the resource-based policy was created, in UNIX epoch time format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#IamRoleArn": { "type": "string", "traits": { @@ -6027,7 +6191,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.

", + "smithy.api#documentation": "

The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -6665,6 +6829,21 @@ "target": "com.amazonaws.pinpointsmsvoicev2#OriginationIdentityMetadata" } }, + "com.amazonaws.pinpointsmsvoicev2#Owner": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SELF", + "name": "SELF" + }, + { + "value": "SHARED", + "name": "SHARED" + } + ] + } + }, "com.amazonaws.pinpointsmsvoicev2#PhoneNumber": { "type": "string", "traits": { @@ -7016,6 +7195,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteRegistrationFieldValue" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#DeleteResourcePolicy" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#DeleteTextMessageSpendLimitOverride" }, @@ -7094,6 +7276,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#GetProtectConfigurationCountryRuleSet" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#GetResourcePolicy" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ListPoolOriginationIdentities" }, @@ -7112,6 +7297,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#PutRegistrationFieldValue" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicy" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumber" }, @@ -8454,7 +8642,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

", + "smithy.api#documentation": "

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -8556,7 +8744,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutListName or OptOutListArn to add the phone number to.

", + "smithy.api#documentation": "

The OptOutListName or OptOutListArn to add the phone number to.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -8737,6 +8925,83 @@ "smithy.api#output": {} } }, + "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyResult" + }, + "errors": [ + { + "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ThrottlingException" + }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for\n sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about\n resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.

" + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to.

", + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The JSON formatted resource-based policy to attach.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyResult": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.pinpointsmsvoicev2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

" + } + }, + "Policy": { + "target": "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy", + "traits": { + "smithy.api#documentation": "

The JSON formatted Resource Policy.

" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the resource-based policy was created, in UNIX epoch time format.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.pinpointsmsvoicev2#RegistrationAssociationBehavior": { "type": "string", "traits": { @@ -9420,6 +9685,10 @@ "value": "REVIEWING", "name": "REVIEWING" }, + { + "value": "REQUIRES_AUTHENTICATION", + "name": "REQUIRES_AUTHENTICATION" + }, { "value": "PROVISIONING", "name": "PROVISIONING" @@ -9706,6 +9975,10 @@ "value": "REVIEWING", "name": "REVIEWING" }, + { + "value": "REQUIRES_AUTHENTICATION", + "name": "REQUIRES_AUTHENTICATION" + }, { "value": "APPROVED", "name": "APPROVED" @@ -9824,7 +10097,7 @@ "PhoneNumberId": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.

", + "smithy.api#documentation": "

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } } @@ -10119,13 +10392,13 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.

" + "smithy.api#documentation": "

The name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The pool to associated with the phone number. You can use the PoolId or PoolArn.

" + "smithy.api#documentation": "

The pool to associated with the phone number. You can use the PoolId or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "RegistrationId": { @@ -10484,6 +10757,15 @@ "smithy.api#error": "client" } }, + "com.amazonaws.pinpointsmsvoicev2#ResourcePolicy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, "com.amazonaws.pinpointsmsvoicev2#ResourceType": { "type": "string", "traits": { @@ -10539,6 +10821,10 @@ { "value": "protect-configuration", "name": "PROTECT_CONFIGURATION" + }, + { + "value": "policy", + "name": "POLICY" } ] } @@ -10707,7 +10993,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#VerificationMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

" + "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "ConfigurationSetName": { @@ -10796,7 +11082,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#MediaMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

", + "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -10916,7 +11202,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

" + "smithy.api#documentation": "

The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "MessageBody": { @@ -11047,7 +11333,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "

The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

", + "smithy.api#documentation": "

The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -12469,7 +12755,7 @@ "PhoneNumberId": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.

", + "smithy.api#documentation": "

The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -12665,7 +12951,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "

The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.

", + "smithy.api#documentation": "

The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n ", "smithy.api#required": {} } }, @@ -12696,7 +12982,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "

The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.

" + "smithy.api#documentation": "

The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.

\n \n

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

\n " } }, "SharedRoutesEnabled": { @@ -13319,6 +13605,10 @@ "value": "VOICE_CAPABILITY_NOT_AVAILABLE", "name": "VOICE_CAPABILITY_NOT_AVAILABLE" }, + { + "value": "UNSPECIFIED_PARAMETER_NOT_SUPPORTED", + "name": "UNSPECIFIED_PARAMETER_NOT_SUPPORTED" + }, { "value": "OTHER", "name": "OTHER" diff --git a/codegen/sdk/aws-models/pipes.json b/codegen/sdk/aws-models/pipes.json index 66e223b5ce1..5a73f9d8295 100644 --- a/codegen/sdk/aws-models/pipes.json +++ b/codegen/sdk/aws-models/pipes.json @@ -8,7 +8,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$" + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\\d{1})?)?:(\\d{12})?:(.+)$" } }, "com.amazonaws.pipes#ArnOrJsonPath": { @@ -18,7 +18,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$" + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\\d{1})?)?:(\\d{12})?:(.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$" } }, "com.amazonaws.pipes#ArnOrUrl": { @@ -28,7 +28,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$" + "smithy.api#pattern": "^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\\d{1})?)?:(\\d{12})?:(.+)$" } }, "com.amazonaws.pipes#AssignPublicIp": { @@ -364,7 +364,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:logs:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):log-group:[\\.\\-_/#A-Za-z0-9]{1,512}(:\\*)?)$" + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:logs:([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\\d{1})?):(\\d{12}):log-group:[\\.\\-_/#A-Za-z0-9]{1,512}(:\\*)?)$" } }, "com.amazonaws.pipes#CloudwatchLogsLogDestination": { @@ -1410,7 +1410,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:firehose:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):deliverystream/[a-zA-Z0-9_.-]{1,64})$" + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:firehose:([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\\d{1})?):(\\d{12}):deliverystream/[a-zA-Z0-9_.-]{1,64})$" } }, "com.amazonaws.pipes#FirehoseLogDestination": { @@ -2162,7 +2162,7 @@ "min": 0, "max": 1600 }, - "smithy.api#pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:(.+)$" + "smithy.api#pattern": "^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-]+):([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\\d{1})?)?:(\\d{12})?:(.+)$" } }, "com.amazonaws.pipes#PathParameter": { @@ -2506,7 +2506,7 @@ "OnPartialBatchItemFailure": { "target": "com.amazonaws.pipes#OnPartialBatchItemFailureStreams", "traits": { - "smithy.api#documentation": "

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" + "smithy.api#documentation": "

Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" } }, "MaximumBatchingWindowInSeconds": { @@ -2518,25 +2518,25 @@ "MaximumRecordAgeInSeconds": { "target": "com.amazonaws.pipes#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" + "smithy.api#documentation": "

Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" } }, "MaximumRetryAttempts": { "target": "com.amazonaws.pipes#MaximumRetryAttemptsESM", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" + "smithy.api#documentation": "

Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" } }, "ParallelizationFactor": { "target": "com.amazonaws.pipes#LimitMax10", "traits": { - "smithy.api#documentation": "

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

" + "smithy.api#documentation": "

The number of batches to process concurrently from each shard. The default value is 1.

" } }, "StartingPosition": { "target": "com.amazonaws.pipes#DynamoDBStreamStartPosition", "traits": { - "smithy.api#documentation": "

(Streams only) The position in a stream from which to start reading.

", + "smithy.api#documentation": "

The position in a stream from which to start reading.

", "smithy.api#required": {} } } @@ -2563,7 +2563,7 @@ "OnPartialBatchItemFailure": { "target": "com.amazonaws.pipes#OnPartialBatchItemFailureStreams", "traits": { - "smithy.api#documentation": "

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" + "smithy.api#documentation": "

Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" } }, "MaximumBatchingWindowInSeconds": { @@ -2575,25 +2575,25 @@ "MaximumRecordAgeInSeconds": { "target": "com.amazonaws.pipes#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" + "smithy.api#documentation": "

Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" } }, "MaximumRetryAttempts": { "target": "com.amazonaws.pipes#MaximumRetryAttemptsESM", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" + "smithy.api#documentation": "

Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" } }, "ParallelizationFactor": { "target": "com.amazonaws.pipes#LimitMax10", "traits": { - "smithy.api#documentation": "

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

" + "smithy.api#documentation": "

The number of batches to process concurrently from each shard. The default value is 1.

" } }, "StartingPosition": { "target": "com.amazonaws.pipes#KinesisStreamStartPosition", "traits": { - "smithy.api#documentation": "

(Streams only) The position in a stream from which to start reading.

", + "smithy.api#documentation": "

The position in a stream from which to start reading.

", "smithy.api#required": {} } }, @@ -2621,7 +2621,7 @@ "StartingPosition": { "target": "com.amazonaws.pipes#MSKStartPosition", "traits": { - "smithy.api#documentation": "

(Streams only) The position in a stream from which to start reading.

" + "smithy.api#documentation": "

The position in a stream from which to start reading.

" } }, "BatchSize": { @@ -2762,7 +2762,7 @@ "StartingPosition": { "target": "com.amazonaws.pipes#SelfManagedKafkaStartPosition", "traits": { - "smithy.api#documentation": "

(Streams only) The position in a stream from which to start reading.

" + "smithy.api#documentation": "

The position in a stream from which to start reading.

" } }, "AdditionalBootstrapServers": { @@ -3396,7 +3396,7 @@ "TimestampFormat": { "target": "com.amazonaws.pipes#TimestampFormat", "traits": { - "smithy.api#documentation": "

How to format the timestamps. For example,\n YYYY-MM-DDThh:mm:ss.sssTZD.

\n

Required if TimeFieldType is specified as\n TIMESTAMP_FORMAT.

" + "smithy.api#documentation": "

How to format the timestamps. For example,\n yyyy-MM-dd'T'HH:mm:ss'Z'.

\n

Required if TimeFieldType is specified as\n TIMESTAMP_FORMAT.

" } }, "VersionValue": { @@ -4558,7 +4558,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)$" + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\\d{1})?):(\\d{12}):secret:.+)$" } }, "com.amazonaws.pipes#SecretManagerArnOrJsonPath": { @@ -4569,7 +4569,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):secret:.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$" + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:secretsmanager:([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\\d{1})?):(\\d{12}):secret:.+)|(\\$(\\.[\\w/_-]+(\\[(\\d+|\\*)\\])*)*)$" } }, "com.amazonaws.pipes#SecurityGroup": { @@ -4602,7 +4602,7 @@ "traits": { "smithy.api#documentation": "List of SecurityGroupId.", "smithy.api#length": { - "min": 0, + "min": 1, "max": 5 } } @@ -5045,7 +5045,7 @@ "traits": { "smithy.api#documentation": "List of SubnetId.", "smithy.api#length": { - "min": 0, + "min": 1, "max": 16 } } @@ -5564,7 +5564,7 @@ "OnPartialBatchItemFailure": { "target": "com.amazonaws.pipes#OnPartialBatchItemFailureStreams", "traits": { - "smithy.api#documentation": "

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" + "smithy.api#documentation": "

Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" } }, "MaximumBatchingWindowInSeconds": { @@ -5576,19 +5576,19 @@ "MaximumRecordAgeInSeconds": { "target": "com.amazonaws.pipes#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" + "smithy.api#documentation": "

Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" } }, "MaximumRetryAttempts": { "target": "com.amazonaws.pipes#MaximumRetryAttemptsESM", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" + "smithy.api#documentation": "

Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" } }, "ParallelizationFactor": { "target": "com.amazonaws.pipes#LimitMax10", "traits": { - "smithy.api#documentation": "

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

" + "smithy.api#documentation": "

The number of batches to process concurrently from each shard. The default value is 1.

" } } }, @@ -5614,7 +5614,7 @@ "OnPartialBatchItemFailure": { "target": "com.amazonaws.pipes#OnPartialBatchItemFailureStreams", "traits": { - "smithy.api#documentation": "

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" + "smithy.api#documentation": "

Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half \nuntil all the records are processed or there is one failed message left in the batch.

" } }, "MaximumBatchingWindowInSeconds": { @@ -5626,19 +5626,19 @@ "MaximumRecordAgeInSeconds": { "target": "com.amazonaws.pipes#MaximumRecordAgeInSeconds", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" + "smithy.api#documentation": "

Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. \nWhen the value is set to infinite, EventBridge never discards old records.

" } }, "MaximumRetryAttempts": { "target": "com.amazonaws.pipes#MaximumRetryAttemptsESM", "traits": { - "smithy.api#documentation": "

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" + "smithy.api#documentation": "

Discard records after the specified number of retries. The default value is -1, which sets the maximum number of \nretries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

" } }, "ParallelizationFactor": { "target": "com.amazonaws.pipes#LimitMax10", "traits": { - "smithy.api#documentation": "

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

" + "smithy.api#documentation": "

The number of batches to process concurrently from each shard. The default value is 1.

" } } }, diff --git a/codegen/sdk/aws-models/pricing.json b/codegen/sdk/aws-models/pricing.json index ded5814c1c1..4f6cdf0b49c 100644 --- a/codegen/sdk/aws-models/pricing.json +++ b/codegen/sdk/aws-models/pricing.json @@ -33,7 +33,7 @@ "name": "pricing" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

The Amazon Web Services Price List API is a centralized and convenient way to programmatically\n query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location,\n Storage Class, and Operating System, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:

\n
    \n
  • \n

    Build cost control and scenario planning tools

    \n
    • \n
  • \n

    Reconcile billing data

    \n
    • \n
  • \n

    Forecast future spend for budgeting purposes

    \n
    • \n
  • \n

    Provide cost benefit analysis that compare your internal workloads with Amazon Web Services

    \n
    • \n
\n

Use GetServices without a service code to retrieve the service codes for\n all Amazon Web Services, then GetServices with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use GetAttributeValues to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n use GetProducts to find specific products that you're interested in, such as\n an AmazonEC2 instance, with a Provisioned IOPS\n volumeType.

\n

For more information, see Using the\n Amazon Web Services Price List API in the Billing User\n Guide.

", + "smithy.api#documentation": "

The Amazon Web Services Price List API is a centralized and convenient way to programmatically\n query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location,\n Storage Class, and Operating System, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:

\n
    \n
  • \n

    Build cost control and scenario planning tools

    \n
    • \n
  • \n

    Reconcile billing data

    \n
    • \n
  • \n

    Forecast future spend for budgeting purposes

    \n
    • \n
  • \n

    Provide cost benefit analysis that compare your internal workloads with Amazon Web Services

    \n
    • \n
\n

Use GetServices without a service code to retrieve the service codes for\n all Amazon Web Services services, then GetServices with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use GetAttributeValues to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n use GetProducts to find specific products that you're interested in, such as\n an AmazonEC2 instance, with a Provisioned IOPS\n volumeType.

\n

For more information, see Using the\n Amazon Web Services Price List API in the Billing User\n Guide.

", "smithy.api#title": "AWS Price List Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -788,6 +788,33 @@ ], "traits": { "smithy.api#documentation": "

Returns the metadata for one service or a list of the metadata for all services. Use\n this without a service code to get the service codes for all services.\n Use it with a service code, such as AmazonEC2, to get information specific to \n that service, such as the attribute \n names available for that service. For example, some of the attribute names available for EC2 are \n volumeType, maxIopsVolume, operation,\n locationType, and instanceCapacity10xlarge.

", + "smithy.api#examples": [ + { + "title": "To retrieve a list of services and service codes", + "documentation": "Retrieves the service for the given Service Code.", + "input": { + "ServiceCode": "AmazonEC2", + "FormatVersion": "aws_v1", + "MaxResults": 1 + }, + "output": { + "FormatVersion": "aws_v1", + "NextToken": "abcdefg123", + "Services": [ + { + "AttributeNames": [ + "volumeType", + "maxIopsvolume", + "instanceCapacity10xlarge", + "locationType", + "operation" + ], + "ServiceCode": "AmazonEC2" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -962,6 +989,28 @@ ], "traits": { "smithy.api#documentation": "

Returns a list of attribute values. Attributes are similar to the details \n in a Price List API offer file. For a list of available attributes, see \n Offer File Definitions\n in the Billing and Cost Management User Guide.

", + "smithy.api#examples": [ + { + "title": "To retrieve a list of attribute values", + "documentation": "This operation returns a list of values available for the given attribute.", + "input": { + "ServiceCode": "AmazonEC2", + "AttributeName": "volumeType", + "MaxResults": 2 + }, + "output": { + "NextToken": "GpgauEXAMPLEezucl5LV0w==:7GzYJ0nw0DBTJ2J66EoTIIynE6O1uXwQtTRqioJzQadBnDVgHPzI1en4BUQnPCLpzeBk9RQQAWaFieA4+DapFAGLgk+Z/9/cTw9GldnPOHN98+FdmJP7wKU3QQpQ8MQr5KOeBkIsAqvAQYdL0DkL7tHwPtE5iCEByAmg9gcC/yBU1vAOsf7R3VaNN4M5jMDv3woSWqASSIlBVB6tgW78YL22KhssoItM/jWW+aP6Jqtq4mldxp/ct6DWAl+xLFwHU/CbketimPPXyqHF3/UXDw==", + "AttributeValues": [ + { + "Value": "Throughput Optimized HDD" + }, + { + "Value": "Provisioned IOPS" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", diff --git a/codegen/sdk/aws-models/qbusiness.json b/codegen/sdk/aws-models/qbusiness.json index 8565234f256..03165562266 100644 --- a/codegen/sdk/aws-models/qbusiness.json +++ b/codegen/sdk/aws-models/qbusiness.json @@ -1312,7 +1312,7 @@ "userGroups": { "target": "com.amazonaws.qbusiness#UserGroups", "traits": { - "smithy.api#documentation": "

The groups that a user associated with the chat input belongs to.

", + "smithy.api#documentation": "

The group names that a user associated with the chat input belongs to.

", "smithy.api#httpQuery": "userGroups" } }, @@ -1546,7 +1546,7 @@ "userGroups": { "target": "com.amazonaws.qbusiness#UserGroups", "traits": { - "smithy.api#documentation": "

The groups that a user associated with the chat input belongs to.

", + "smithy.api#documentation": "

The group names that a user associated with the chat input belongs to.

", "smithy.api#httpQuery": "userGroups" } }, @@ -1958,7 +1958,7 @@ "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon\n CloudWatch logs and metrics.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon\n CloudWatch logs and metrics. If this property is not specified, Amazon Q Business will create a service linked role (SLR) and use it as the\n application's role.

" } }, "identityType": { @@ -2748,6 +2748,12 @@ "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end\n user.

" } }, + "origins": { + "target": "com.amazonaws.qbusiness#WebExperienceOrigins", + "traits": { + "smithy.api#documentation": "

Sets the website domain origins that \n are allowed to embed the Amazon Q Business web experience.\n \n The domain origin refers to the \n base URL for accessing a website including the protocol \n (http/https), the domain name, and the port number (if specified).\n

\n \n

You must only submit a base URL and \n not a full path. For example, https://docs.aws.amazon.com.

\n " + } + }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { @@ -6376,6 +6382,12 @@ "smithy.api#documentation": "

Determines whether sample prompts are enabled in the web experience for an end\n user.

" } }, + "origins": { + "target": "com.amazonaws.qbusiness#WebExperienceOrigins", + "traits": { + "smithy.api#documentation": "

Gets the website domain origins that \n are allowed to embed the Amazon Q Business web experience.\n \n The domain origin refers to the \n base URL for accessing a website including the protocol \n (http/https), the domain name, and the port number (if specified).\n

" + } + }, "roleArn": { "target": "com.amazonaws.qbusiness#RoleArn", "traits": { @@ -8713,6 +8725,16 @@ "smithy.api#documentation": "

Information about the OIDC-compliant identity provider (IdP) used to authenticate end\n users of an Amazon Q Business web experience.

" } }, + "com.amazonaws.qbusiness#Origin": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?$" + } + }, "com.amazonaws.qbusiness#Payload": { "type": "string", "traits": { @@ -9290,13 +9312,13 @@ "qAppsControlMode": { "target": "com.amazonaws.qbusiness#QAppsControlMode", "traits": { - "smithy.api#documentation": "

Status information about whether end users can create and use Amazon Q Apps in the web experience.

", + "smithy.api#documentation": "

Status information about whether end users can create and use Amazon Q Apps in the web\n experience.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Configuration information about Amazon Q Apps. (preview feature)

" + "smithy.api#documentation": "

Configuration information about Amazon Q Apps.

" } }, "com.amazonaws.qbusiness#QAppsControlMode": { @@ -11439,6 +11461,12 @@ "traits": { "smithy.api#documentation": "

Information about the identity provider (IdP) used to authenticate end users of an\n Amazon Q Business web experience.

" } + }, + "origins": { + "target": "com.amazonaws.qbusiness#WebExperienceOrigins", + "traits": { + "smithy.api#documentation": "

Updates the website domain origins that \n are allowed to embed the Amazon Q Business web experience.\n \n The domain origin refers to the \n base URL for accessing a website including the protocol \n (http/https), the domain name, and the port number (if specified).

\n \n
    \n
  • \n

    Any values except null submitted as part of this \n update will replace all previous values.

    \n
    • \n
  • \n

    You must only submit a base URL and \n not a full path. For example, https://docs.aws.amazon.com.

    \n
    • \n
\n " + } } }, "traits": { @@ -11538,12 +11566,12 @@ "userGroups": { "target": "com.amazonaws.qbusiness#UserGroups", "traits": { - "smithy.api#documentation": "

The user groups associated with a topic control rule.

" + "smithy.api#documentation": "

The user group names associated with a topic control rule.

" } } }, "traits": { - "smithy.api#documentation": "

Provides information about users and groups associated with a topic control\n rule.

" + "smithy.api#documentation": "

Provides information about users and group names associated with a topic control\n rule.

" } }, "com.amazonaws.qbusiness#ValidationException": { @@ -11696,6 +11724,18 @@ "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$" } }, + "com.amazonaws.qbusiness#WebExperienceOrigins": { + "type": "list", + "member": { + "target": "com.amazonaws.qbusiness#Origin" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.qbusiness#WebExperienceResource": { "type": "resource", "identifiers": { diff --git a/codegen/sdk/aws-models/qconnect.json b/codegen/sdk/aws-models/qconnect.json index 363e641ecaf..a468eff5e39 100644 --- a/codegen/sdk/aws-models/qconnect.json +++ b/codegen/sdk/aws-models/qconnect.json @@ -1,190 +1,172 @@ { "smithy": "2.0", "shapes": { - "com.amazonaws.qconnect#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.qconnect#AmazonConnectGuideAssociationData": { - "type": "structure", - "members": { - "flowId": { - "target": "com.amazonaws.qconnect#GenericArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Content association data for a step-by-step\n guide.

" - } - }, - "com.amazonaws.qconnect#AndConditions": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#TagCondition" - } - }, - "com.amazonaws.qconnect#AppIntegrationsConfiguration": { - "type": "structure", - "members": { - "appIntegrationArn": { - "target": "com.amazonaws.qconnect#GenericArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

\n
    \n
  • \n

    For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted as source fields.

    \n
    • \n
  • \n

    For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least number,\n short_description, sys_mod_count, workflow_state,\n and active as source fields.

    \n
    • \n
  • \n

    For \n Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least id,\n title, updated_at, and draft as source fields.\n

    \n
    • \n
  • \n

    For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration,\n including only file extensions that are among docx, pdf,\n html, htm, and txt.

    \n
    • \n
  • \n

    For Amazon S3, the\n ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null.\n The SourceURI of your DataIntegration must use the following format:\n s3://your_s3_bucket_name.

    \n \n

    The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services\n principal app-integrations.amazonaws.com to perform\n s3:ListBucket, s3:GetObject, and\n s3:GetBucketLocation against the bucket.

    \n     \n
    • \n
", - "smithy.api#required": {} - } - }, - "objectFields": { - "target": "com.amazonaws.qconnect#ObjectFieldsList", - "traits": { - "smithy.api#documentation": "

The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if\n ObjectConfiguration is included in the provided DataIntegration.

\n
    \n
  • \n

    For Salesforce, you must include at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted.

    \n
    • \n
  • \n

    For ServiceNow, you must include at least number,\n short_description, sys_mod_count, workflow_state,\n and active.

    \n
    • \n
  • \n

    For \n Zendesk, you must include at least id, title,\n updated_at, and draft.

    \n
    • \n
\n

Make sure to include additional fields. These fields are indexed and used to source\n recommendations.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration information for Amazon AppIntegrations to automatically ingest content.

" - } - }, - "com.amazonaws.qconnect#Arn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" - } - }, - "com.amazonaws.qconnect#Assistant": { + "com.amazonaws.qconnect#AIAgent": { "type": "resource", "identifiers": { "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier" } }, "create": { - "target": "com.amazonaws.qconnect#CreateAssistant" + "target": "com.amazonaws.qconnect#CreateAIAgent" }, "read": { - "target": "com.amazonaws.qconnect#GetAssistant" + "target": "com.amazonaws.qconnect#GetAIAgent" + }, + "update": { + "target": "com.amazonaws.qconnect#UpdateAIAgent" }, "delete": { - "target": "com.amazonaws.qconnect#DeleteAssistant" + "target": "com.amazonaws.qconnect#DeleteAIAgent" }, "list": { - "target": "com.amazonaws.qconnect#ListAssistants" + "target": "com.amazonaws.qconnect#ListAIAgents" }, "operations": [ { - "target": "com.amazonaws.qconnect#GetRecommendations" - }, - { - "target": "com.amazonaws.qconnect#NotifyRecommendationsReceived" - }, - { - "target": "com.amazonaws.qconnect#PutFeedback" - }, - { - "target": "com.amazonaws.qconnect#QueryAssistant" + "target": "com.amazonaws.qconnect#CreateAIAgentVersion" }, { - "target": "com.amazonaws.qconnect#SearchSessions" - } - ], - "resources": [ - { - "target": "com.amazonaws.qconnect#AssistantAssociation" + "target": "com.amazonaws.qconnect#DeleteAIAgentVersion" }, { - "target": "com.amazonaws.qconnect#Session" + "target": "com.amazonaws.qconnect#ListAIAgentVersions" } ], "traits": { "aws.api#arn": { - "template": "assistant/{assistantId}" + "template": "ai-agent/{assistantId}/{aiAgentId}" }, - "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, - "com.amazonaws.qconnect#AssistantAssociation": { - "type": "resource", - "identifiers": { - "assistantId": { - "target": "com.amazonaws.qconnect#UuidOrArn" + "com.amazonaws.qconnect#AIAgentAssociationConfigurationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_BASE", + "name": "KNOWLEDGE_BASE" + } + ] + } + }, + "com.amazonaws.qconnect#AIAgentConfiguration": { + "type": "union", + "members": { + "manualSearchAIAgentConfiguration": { + "target": "com.amazonaws.qconnect#ManualSearchAIAgentConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for AI Agents of type MANUAL_SEARCH.

" + } }, - "assistantAssociationId": { - "target": "com.amazonaws.qconnect#UuidOrArn" + "answerRecommendationAIAgentConfiguration": { + "target": "com.amazonaws.qconnect#AnswerRecommendationAIAgentConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for AI Agents of type ANSWER_RECOMMENDATION.

" + } } }, - "create": { - "target": "com.amazonaws.qconnect#CreateAssistantAssociation" - }, - "read": { - "target": "com.amazonaws.qconnect#GetAssistantAssociation" - }, - "delete": { - "target": "com.amazonaws.qconnect#DeleteAssistantAssociation" - }, - "list": { - "target": "com.amazonaws.qconnect#ListAssistantAssociations" + "traits": { + "smithy.api#documentation": "

A typed union that specifies the configuration based on the type of AI Agent.

" + } + }, + "com.amazonaws.qconnect#AIAgentConfigurationData": { + "type": "structure", + "members": { + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidWithQualifier", + "traits": { + "smithy.api#documentation": "

The ID of the AI Agent to be configured.

", + "smithy.api#required": {} + } + } }, "traits": { - "aws.api#arn": { - "template": "association/{assistantId}/{assistantAssociationId}" - }, - "aws.cloudformation#cfnResource": {}, - "aws.iam#disableConditionKeyInference": {} + "smithy.api#documentation": "

A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be\n used for an AI Agent type on a session or assistant.

" } }, - "com.amazonaws.qconnect#AssistantAssociationData": { + "com.amazonaws.qconnect#AIAgentConfigurationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.qconnect#AIAgentType" + }, + "value": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationData" + } + }, + "com.amazonaws.qconnect#AIAgentData": { "type": "structure", "members": { - "assistantAssociationId": { + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the assistant association.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", "smithy.api#required": {} } }, - "assistantAssociationArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assistant association.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, - "assistantId": { + "aiAgentId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant.

", + "smithy.api#documentation": "

The identifier of the AI Agent.

", "smithy.api#required": {} } }, - "assistantArn": { + "aiAgentArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AI agent.

", "smithy.api#required": {} } }, - "associationType": { - "target": "com.amazonaws.qconnect#AssociationType", + "name": { + "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "

The type of association.

", + "smithy.api#documentation": "

The name of the AI Agent.

", "smithy.api#required": {} } }, - "associationData": { - "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", + "type": { + "target": "com.amazonaws.qconnect#AIAgentType", "traits": { - "smithy.api#documentation": "

A union type that currently has a single argument, the knowledge base ID.

", + "smithy.api#documentation": "

The type of the AI Agent.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for the AI Agent.

", + "smithy.api#required": {} + } + }, + "modifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the AI Agent was last modified.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description of the AI Agent.

" + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "

The visibility status of the AI Agent.

", "smithy.api#required": {} } }, @@ -193,148 +175,239 @@ "traits": { "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "

Specifies the origin of the AI Agent. SYSTEM for a default AI Agent created\n by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation\n APIs.

" + } + }, + "status": { + "target": "com.amazonaws.qconnect#Status", + "traits": { + "smithy.api#documentation": "

The status of the AI Agent.

" + } } }, "traits": { - "smithy.api#documentation": "

Information about the assistant association.

", + "smithy.api#documentation": "

The data for the AI Agent.

", "smithy.api#references": [ { - "resource": "com.amazonaws.qconnect#AssistantAssociation" + "resource": "com.amazonaws.qconnect#AIAgent" } ] } }, - "com.amazonaws.qconnect#AssistantAssociationInputData": { - "type": "union", - "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", - "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data that is input into Amazon Q in Connect as a result of the assistant association.

" - } - }, - "com.amazonaws.qconnect#AssistantAssociationOutputData": { - "type": "union", + "com.amazonaws.qconnect#AIAgentSummary": { + "type": "structure", "members": { - "knowledgeBaseAssociation": { - "target": "com.amazonaws.qconnect#KnowledgeBaseAssociationData", + "name": { + "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "

The knowledge base where output data is sent.

" + "smithy.api#documentation": "

The name of the AI Agent.

", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

The data that is output as a result of the assistant association.

" - } - }, - "com.amazonaws.qconnect#AssistantAssociationSummary": { - "type": "structure", - "members": { - "assistantAssociationId": { + }, + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the assistant association.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", "smithy.api#required": {} } }, - "assistantAssociationArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assistant association.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, - "assistantId": { + "aiAgentId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant.

", + "smithy.api#documentation": "

The identifier of the AI Agent.

", "smithy.api#required": {} } }, - "assistantArn": { - "target": "com.amazonaws.qconnect#Arn", + "type": { + "target": "com.amazonaws.qconnect#AIAgentType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

", + "smithy.api#documentation": "

The type of the AI Agent.

", "smithy.api#required": {} } }, - "associationType": { - "target": "com.amazonaws.qconnect#AssociationType", + "aiAgentArn": { + "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The type of association.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AI agent.

", "smithy.api#required": {} } }, - "associationData": { - "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", + "modifiedTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The association data.

", + "smithy.api#documentation": "

The time the AI Agent was last modified.

" + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "

The visibility status of the AI Agent.

", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfiguration", "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + "smithy.api#documentation": "

The configuration for the AI Agent.

" } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information about the assistant association.

", - "smithy.api#references": [ - { - "resource": "com.amazonaws.qconnect#AssistantAssociation" + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "

The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in\n Connect or CUSTOMER for an AI Agent created by calling AI Agent creation\n APIs.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description of the AI Agent.

" + } + }, + "status": { + "target": "com.amazonaws.qconnect#Status", + "traits": { + "smithy.api#documentation": "

The status of the AI Agent.

" + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of the AI Agent.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#AIAgent" } ] } }, - "com.amazonaws.qconnect#AssistantAssociationSummaryList": { + "com.amazonaws.qconnect#AIAgentSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.qconnect#AssistantAssociationSummary" + "target": "com.amazonaws.qconnect#AIAgentSummary" } }, - "com.amazonaws.qconnect#AssistantCapabilityConfiguration": { + "com.amazonaws.qconnect#AIAgentType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "MANUAL_SEARCH", + "name": "MANUAL_SEARCH" + }, + { + "value": "ANSWER_RECOMMENDATION", + "name": "ANSWER_RECOMMENDATION" + } + ] + } + }, + "com.amazonaws.qconnect#AIAgentVersionSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AIAgentVersionSummary" + } + }, + "com.amazonaws.qconnect#AIAgentVersionSummary": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.qconnect#AssistantCapabilityType", + "aiAgentSummary": { + "target": "com.amazonaws.qconnect#AIAgentSummary", "traits": { - "smithy.api#documentation": "

The type of Amazon Q in Connect assistant capability.

" + "smithy.api#documentation": "

The data for the summary of the AI Agent version.

" + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "

The version number for this AI Agent version.

" } } }, "traits": { - "smithy.api#documentation": "

The capability configuration for an Amazon Q in Connect assistant.

" + "smithy.api#documentation": "

The summary of the AI Agent version.

" } }, - "com.amazonaws.qconnect#AssistantCapabilityType": { + "com.amazonaws.qconnect#AIPrompt": { + "type": "resource", + "identifiers": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateAIPrompt" + }, + "read": { + "target": "com.amazonaws.qconnect#GetAIPrompt" + }, + "update": { + "target": "com.amazonaws.qconnect#UpdateAIPrompt" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteAIPrompt" + }, + "list": { + "target": "com.amazonaws.qconnect#ListAIPrompts" + }, + "operations": [ + { + "target": "com.amazonaws.qconnect#CreateAIPromptVersion" + }, + { + "target": "com.amazonaws.qconnect#DeleteAIPromptVersion" + }, + { + "target": "com.amazonaws.qconnect#ListAIPromptVersions" + } + ], + "traits": { + "aws.api#arn": { + "template": "ai-prompt/{assistantId}/{aiPromptId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#AIPromptAPIFormat": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "V1", - "name": "V1" + "value": "ANTHROPIC_CLAUDE_MESSAGES", + "name": "ANTHROPIC_CLAUDE_MESSAGES" }, { - "value": "V2", - "name": "V2" + "value": "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", + "name": "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS" } ] } }, - "com.amazonaws.qconnect#AssistantData": { + "com.amazonaws.qconnect#AIPromptData": { "type": "structure", "members": { "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", "smithy.api#required": {} } }, @@ -345,120 +418,132 @@ "smithy.api#required": {} } }, + "aiPromptId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI prompt.

", + "smithy.api#required": {} + } + }, + "aiPromptArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AI Prompt.

", + "smithy.api#required": {} + } + }, "name": { "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "

The name.

", + "smithy.api#documentation": "

The name of the AI Prompt

", "smithy.api#required": {} } }, "type": { - "target": "com.amazonaws.qconnect#AssistantType", + "target": "com.amazonaws.qconnect#AIPromptType", "traits": { - "smithy.api#documentation": "

The type of assistant.

", + "smithy.api#documentation": "

The type of this AI Prompt.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.qconnect#AssistantStatus", + "templateType": { + "target": "com.amazonaws.qconnect#AIPromptTemplateType", "traits": { - "smithy.api#documentation": "

The status of the assistant.

", + "smithy.api#documentation": "

The type of the prompt template for this AI Prompt.

", + "smithy.api#required": {} + } + }, + "modelId": { + "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the model used for this AI Prompt. Model Ids supported are:\n CLAUDE_3_HAIKU_20240307_V1.

", + "smithy.api#required": {} + } + }, + "apiFormat": { + "target": "com.amazonaws.qconnect#AIPromptAPIFormat", + "traits": { + "smithy.api#documentation": "

The API format used for this AI Prompt.

", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.qconnect#AIPromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the prompt template for this AI Prompt.

", "smithy.api#required": {} } }, + "modifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the AI Prompt was last modified.

" + } + }, "description": { "target": "com.amazonaws.qconnect#Description", "traits": { - "smithy.api#documentation": "

The description.

" + "smithy.api#documentation": "

The description of the AI Prompt.

" } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + "smithy.api#documentation": "

The visibility status of the AI Prompt.

", + "smithy.api#required": {} } }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "tags": { + "target": "com.amazonaws.qconnect#Tags", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

" + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } }, - "integrationConfiguration": { - "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", + "origin": { + "target": "com.amazonaws.qconnect#Origin", "traits": { - "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant integration.

" + "smithy.api#documentation": "

The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in\n Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.\n

" } }, - "capabilityConfiguration": { - "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", + "status": { + "target": "com.amazonaws.qconnect#Status", "traits": { - "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant capability.

" + "smithy.api#documentation": "

The status of the AI Prompt.

" } } }, "traits": { - "smithy.api#documentation": "

The assistant data.

" - } - }, - "com.amazonaws.qconnect#AssistantIntegrationConfiguration": { - "type": "structure", - "members": { - "topicIntegrationArn": { - "target": "com.amazonaws.qconnect#GenericArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

" + "smithy.api#documentation": "

The data for the AI Prompt

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#AIPrompt" } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant integration.

" - } - }, - "com.amazonaws.qconnect#AssistantList": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#AssistantSummary" + ] } }, - "com.amazonaws.qconnect#AssistantStatus": { + "com.amazonaws.qconnect#AIPromptModelIdentifier": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "DELETED", - "name": "DELETED" - } - ] + "smithy.api#length": { + "min": 1, + "max": 2048 + } } }, - "com.amazonaws.qconnect#AssistantSummary": { + "com.amazonaws.qconnect#AIPromptSummary": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the AI Prompt.

", + "smithy.api#required": {} + } + }, "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", "smithy.api#required": {} } }, @@ -469,127 +554,172 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.qconnect#Name", + "aiPromptId": { + "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The name of the assistant.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI prompt.

", "smithy.api#required": {} } }, "type": { - "target": "com.amazonaws.qconnect#AssistantType", + "target": "com.amazonaws.qconnect#AIPromptType", "traits": { - "smithy.api#documentation": "

The type of the assistant.

", + "smithy.api#documentation": "

The type of this AI Prompt.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.qconnect#AssistantStatus", + "aiPromptArn": { + "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The status of the assistant.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AI Prompt.

", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.qconnect#Description", + "modifiedTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The description of the assistant.

" + "smithy.api#documentation": "

The time the AI Prompt was last modified.

" } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "templateType": { + "target": "com.amazonaws.qconnect#AIPromptTemplateType", "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + "smithy.api#documentation": "

The type of the prompt template for this AI Prompt.

", + "smithy.api#required": {} } }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "modelId": { + "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

" + "smithy.api#documentation": "

The identifier of the model used for this AI Prompt. Model Ids supported are:\n CLAUDE_3_HAIKU_20240307_V1.

", + "smithy.api#required": {} } }, - "integrationConfiguration": { - "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", + "apiFormat": { + "target": "com.amazonaws.qconnect#AIPromptAPIFormat", "traits": { - "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant integration.

" + "smithy.api#documentation": "

The API format used for this AI Prompt.

", + "smithy.api#required": {} } }, - "capabilityConfiguration": { - "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", "traits": { - "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant capability.

" + "smithy.api#documentation": "

The visibility status of the AI Prompt.

", + "smithy.api#required": {} + } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "

The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in\n Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.\n

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description of the AI Prompt.

" + } + }, + "status": { + "target": "com.amazonaws.qconnect#Status", + "traits": { + "smithy.api#documentation": "

The status of the AI Prompt.

" + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } } }, "traits": { - "smithy.api#documentation": "

Summary information about the assistant.

" + "smithy.api#documentation": "

The summary of the AI Prompt.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#AIPrompt" + } + ] } }, - "com.amazonaws.qconnect#AssistantType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AGENT", - "name": "AGENT" + "com.amazonaws.qconnect#AIPromptSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AIPromptSummary" + } + }, + "com.amazonaws.qconnect#AIPromptTemplateConfiguration": { + "type": "union", + "members": { + "textFullAIPromptEditTemplateConfiguration": { + "target": "com.amazonaws.qconnect#TextFullAIPromptEditTemplateConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a prompt template that supports full textual prompt configuration\n using a YAML prompt.

" } - ] + } + }, + "traits": { + "smithy.api#documentation": "

A typed union that specifies the configuration for a prompt template based on its\n type.

" } }, - "com.amazonaws.qconnect#AssociationType": { + "com.amazonaws.qconnect#AIPromptTemplateType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "KNOWLEDGE_BASE", - "name": "KNOWLEDGE_BASE" + "value": "TEXT", + "name": "TEXT" } ] } }, - "com.amazonaws.qconnect#Channel": { + "com.amazonaws.qconnect#AIPromptType": { "type": "string", "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - }, - "smithy.api#sensitive": {} + "smithy.api#enum": [ + { + "value": "ANSWER_GENERATION", + "name": "ANSWER_GENERATION" + }, + { + "value": "INTENT_LABELING_GENERATION", + "name": "INTENT_LABELING_GENERATION" + }, + { + "value": "QUERY_REFORMULATION", + "name": "QUERY_REFORMULATION" + } + ] } }, - "com.amazonaws.qconnect#Channels": { + "com.amazonaws.qconnect#AIPromptVersionSummariesList": { "type": "list", "member": { - "target": "com.amazonaws.qconnect#Channel" - }, - "traits": { - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.qconnect#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - } + "target": "com.amazonaws.qconnect#AIPromptVersionSummary" } }, - "com.amazonaws.qconnect#Configuration": { - "type": "union", + "com.amazonaws.qconnect#AIPromptVersionSummary": { + "type": "structure", "members": { - "connectConfiguration": { - "target": "com.amazonaws.qconnect#ConnectConfiguration", + "aiPromptSummary": { + "target": "com.amazonaws.qconnect#AIPromptSummary", "traits": { - "smithy.api#documentation": "

The configuration information of the Amazon Connect data source.

" + "smithy.api#documentation": "

The date for the summary of the AI Prompt version.

" + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "

The version number for this AI Prompt version.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration information of the external data source.

" + "smithy.api#documentation": "

The summary of the AI Prompt version.

" } }, - "com.amazonaws.qconnect#ConflictException": { + "com.amazonaws.qconnect#AccessDeniedException": { "type": "structure", "members": { "message": { @@ -597,197 +727,226 @@ } }, "traits": { - "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource. For example, if you're using a Create API (such as\n CreateAssistant) that accepts name, a conflicting resource (usually with the\n same name) is being created or mutated.

", + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", - "smithy.api#httpError": 409 + "smithy.api#httpError": 403 } }, - "com.amazonaws.qconnect#ConnectConfiguration": { + "com.amazonaws.qconnect#AmazonConnectGuideAssociationData": { "type": "structure", "members": { - "instanceId": { - "target": "com.amazonaws.qconnect#NonEmptyString", + "flowId": { + "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration information of the Amazon Connect data source.

" + "smithy.api#documentation": "

Content association data for a step-by-step\n guide.

" } }, - "com.amazonaws.qconnect#ContactAttributeKey": { - "type": "string" - }, - "com.amazonaws.qconnect#ContactAttributeKeys": { + "com.amazonaws.qconnect#AndConditions": { "type": "list", "member": { - "target": "com.amazonaws.qconnect#ContactAttributeKey" + "target": "com.amazonaws.qconnect#TagCondition" + } + }, + "com.amazonaws.qconnect#AnswerRecommendationAIAgentConfiguration": { + "type": "structure", + "members": { + "intentLabelingGenerationAIPromptId": { + "target": "com.amazonaws.qconnect#UuidWithQualifier", + "traits": { + "smithy.api#documentation": "

The AI Prompt identifier for the Intent Labeling prompt used by the\n ANSWER_RECOMMENDATION AI Agent.

" + } + }, + "queryReformulationAIPromptId": { + "target": "com.amazonaws.qconnect#UuidWithQualifier", + "traits": { + "smithy.api#documentation": "

The AI Prompt identifier for the Query Reformulation prompt used by the\n ANSWER_RECOMMENDATION AI Agent.

" + } + }, + "answerGenerationAIPromptId": { + "target": "com.amazonaws.qconnect#UuidWithQualifier", + "traits": { + "smithy.api#documentation": "

The AI Prompt identifier for the Answer Generation prompt used by the\n ANSWER_RECOMMENDATION AI Agent.

" + } + }, + "associationConfigurations": { + "target": "com.amazonaws.qconnect#AssociationConfigurationList", + "traits": { + "smithy.api#documentation": "

The association configurations for overriding behavior on this AI Agent.

" + } + } }, "traits": { - "smithy.api#sensitive": {}, - "smithy.api#uniqueItems": {} + "smithy.api#documentation": "

The configuration for the ANSWER_RECOMMENDATION AI Agent type.

" } }, - "com.amazonaws.qconnect#ContactAttributeValue": { - "type": "string" - }, - "com.amazonaws.qconnect#ContactAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.qconnect#ContactAttributeKey" - }, - "value": { - "target": "com.amazonaws.qconnect#ContactAttributeValue" + "com.amazonaws.qconnect#AppIntegrationsConfiguration": { + "type": "structure", + "members": { + "appIntegrationArn": { + "target": "com.amazonaws.qconnect#GenericArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

\n
    \n
  • \n

    For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted as source fields.

    \n
    • \n
  • \n

    For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least number,\n short_description, sys_mod_count, workflow_state,\n and active as source fields.

    \n
    • \n
  • \n

    For \n Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if\n objectFields is not provided, including at least id,\n title, updated_at, and draft as source fields.\n

    \n
    • \n
  • \n

    For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration,\n including only file extensions that are among docx, pdf,\n html, htm, and txt.

    \n
    • \n
  • \n

    For Amazon S3, the\n ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null.\n The SourceURI of your DataIntegration must use the following format:\n s3://your_s3_bucket_name.

    \n \n

    The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services\n principal app-integrations.amazonaws.com to perform\n s3:ListBucket, s3:GetObject, and\n s3:GetBucketLocation against the bucket.

    \n     \n
    • \n
", + "smithy.api#required": {} + } + }, + "objectFields": { + "target": "com.amazonaws.qconnect#ObjectFieldsList", + "traits": { + "smithy.api#documentation": "

The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if\n ObjectConfiguration is included in the provided DataIntegration.

\n
    \n
  • \n

    For Salesforce, you must include at least Id,\n ArticleNumber, VersionNumber, Title,\n PublishStatus, and IsDeleted.

    \n
    • \n
  • \n

    For ServiceNow, you must include at least number,\n short_description, sys_mod_count, workflow_state,\n and active.

    \n
    • \n
  • \n

    For \n Zendesk, you must include at least id, title,\n updated_at, and draft.

    \n
    • \n
\n

Make sure to include additional fields. These fields are indexed and used to source\n recommendations.

" + } + } }, "traits": { - "smithy.api#sensitive": {} + "smithy.api#documentation": "

Configuration information for Amazon AppIntegrations to automatically ingest content.

" } }, - "com.amazonaws.qconnect#Content": { + "com.amazonaws.qconnect#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" + } + }, + "com.amazonaws.qconnect#Assistant": { "type": "resource", "identifiers": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#UuidOrArn" - }, - "contentId": { + "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn" } }, "create": { - "target": "com.amazonaws.qconnect#CreateContent" + "target": "com.amazonaws.qconnect#CreateAssistant" }, "read": { - "target": "com.amazonaws.qconnect#GetContent" - }, - "update": { - "target": "com.amazonaws.qconnect#UpdateContent" + "target": "com.amazonaws.qconnect#GetAssistant" }, "delete": { - "target": "com.amazonaws.qconnect#DeleteContent" + "target": "com.amazonaws.qconnect#DeleteAssistant" }, "list": { - "target": "com.amazonaws.qconnect#ListContents" + "target": "com.amazonaws.qconnect#ListAssistants" }, "operations": [ { - "target": "com.amazonaws.qconnect#GetContentSummary" + "target": "com.amazonaws.qconnect#GetRecommendations" + }, + { + "target": "com.amazonaws.qconnect#NotifyRecommendationsReceived" + }, + { + "target": "com.amazonaws.qconnect#PutFeedback" + }, + { + "target": "com.amazonaws.qconnect#QueryAssistant" + }, + { + "target": "com.amazonaws.qconnect#RemoveAssistantAIAgent" + }, + { + "target": "com.amazonaws.qconnect#SearchSessions" + }, + { + "target": "com.amazonaws.qconnect#UpdateAssistantAIAgent" } ], "resources": [ { - "target": "com.amazonaws.qconnect#ContentAssociation" + "target": "com.amazonaws.qconnect#AIAgent" + }, + { + "target": "com.amazonaws.qconnect#AIPrompt" + }, + { + "target": "com.amazonaws.qconnect#AssistantAssociation" + }, + { + "target": "com.amazonaws.qconnect#Session" } ], "traits": { "aws.api#arn": { - "template": "content/{knowledgeBaseId}/{contentId}" + "template": "assistant/{assistantId}" }, + "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, - "com.amazonaws.qconnect#ContentAssociation": { + "com.amazonaws.qconnect#AssistantAssociation": { "type": "resource", "identifiers": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#UuidOrArn" - }, - "contentId": { + "assistantId": { "target": "com.amazonaws.qconnect#UuidOrArn" }, - "contentAssociationId": { + "assistantAssociationId": { "target": "com.amazonaws.qconnect#UuidOrArn" } }, "create": { - "target": "com.amazonaws.qconnect#CreateContentAssociation" + "target": "com.amazonaws.qconnect#CreateAssistantAssociation" }, "read": { - "target": "com.amazonaws.qconnect#GetContentAssociation" + "target": "com.amazonaws.qconnect#GetAssistantAssociation" }, "delete": { - "target": "com.amazonaws.qconnect#DeleteContentAssociation" + "target": "com.amazonaws.qconnect#DeleteAssistantAssociation" }, "list": { - "target": "com.amazonaws.qconnect#ListContentAssociations" + "target": "com.amazonaws.qconnect#ListAssistantAssociations" }, "traits": { "aws.api#arn": { - "template": "content-association/{knowledgeBaseId}/{contentId}/{contentAssociationId}" + "template": "association/{assistantId}/{assistantAssociationId}" }, + "aws.cloudformation#cfnResource": {}, "aws.iam#disableConditionKeyInference": {} } }, - "com.amazonaws.qconnect#ContentAssociationContents": { - "type": "union", - "members": { - "amazonConnectGuideAssociation": { - "target": "com.amazonaws.qconnect#AmazonConnectGuideAssociationData", - "traits": { - "smithy.api#documentation": "

The data of the step-by-step guide association.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The contents of a content association.

" - } - }, - "com.amazonaws.qconnect#ContentAssociationData": { + "com.amazonaws.qconnect#AssistantAssociationData": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", - "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

", - "smithy.api#required": {} - } - }, - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", - "smithy.api#required": {} - } - }, - "contentId": { + "assistantAssociationId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the content.

", + "smithy.api#documentation": "

The identifier of the assistant association.

", "smithy.api#required": {} } }, - "contentArn": { + "assistantAssociationArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assistant association.

", "smithy.api#required": {} } }, - "contentAssociationId": { + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, - "contentAssociationArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content association.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, "associationType": { - "target": "com.amazonaws.qconnect#ContentAssociationType", + "target": "com.amazonaws.qconnect#AssociationType", "traits": { "smithy.api#documentation": "

The type of association.

", "smithy.api#required": {} } }, "associationData": { - "target": "com.amazonaws.qconnect#ContentAssociationContents", + "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", "traits": { - "smithy.api#documentation": "

The content association.

", + "smithy.api#documentation": "

A union type that currently has a single argument, the knowledge base ID.

", "smithy.api#required": {} } }, @@ -799,70 +958,84 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the content association.

", + "smithy.api#documentation": "

Information about the assistant association.

", "smithy.api#references": [ { - "resource": "com.amazonaws.qconnect#ContentAssociation" + "resource": "com.amazonaws.qconnect#AssistantAssociation" } ] } }, - "com.amazonaws.qconnect#ContentAssociationSummary": { - "type": "structure", - "members": { + "com.amazonaws.qconnect#AssistantAssociationInputData": { + "type": "union", + "members": { "knowledgeBaseId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

" } - }, - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", + } + }, + "traits": { + "smithy.api#documentation": "

The data that is input into Amazon Q in Connect as a result of the assistant association.

" + } + }, + "com.amazonaws.qconnect#AssistantAssociationOutputData": { + "type": "union", + "members": { + "knowledgeBaseAssociation": { + "target": "com.amazonaws.qconnect#KnowledgeBaseAssociationData", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The knowledge base where output data is sent.

" } - }, - "contentId": { + } + }, + "traits": { + "smithy.api#documentation": "

The data that is output as a result of the assistant association.

" + } + }, + "com.amazonaws.qconnect#AssistantAssociationSummary": { + "type": "structure", + "members": { + "assistantAssociationId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the content.

", + "smithy.api#documentation": "

The identifier of the assistant association.

", "smithy.api#required": {} } }, - "contentArn": { + "assistantAssociationArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the assistant association.

", "smithy.api#required": {} } }, - "contentAssociationId": { + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, - "contentAssociationArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content association.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, "associationType": { - "target": "com.amazonaws.qconnect#ContentAssociationType", + "target": "com.amazonaws.qconnect#AssociationType", "traits": { "smithy.api#documentation": "

The type of association.

", "smithy.api#required": {} } }, "associationData": { - "target": "com.amazonaws.qconnect#ContentAssociationContents", + "target": "com.amazonaws.qconnect#AssistantAssociationOutputData", "traits": { - "smithy.api#documentation": "

The content association.

", + "smithy.api#documentation": "

The association data.

", "smithy.api#required": {} } }, @@ -874,332 +1047,1458 @@ } }, "traits": { - "smithy.api#documentation": "

Summary information about a content association.

", + "smithy.api#documentation": "

Summary information about the assistant association.

", "smithy.api#references": [ { - "resource": "com.amazonaws.qconnect#ContentAssociation" + "resource": "com.amazonaws.qconnect#AssistantAssociation" } ] } }, - "com.amazonaws.qconnect#ContentAssociationSummaryList": { + "com.amazonaws.qconnect#AssistantAssociationSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.qconnect#ContentAssociationSummary" + "target": "com.amazonaws.qconnect#AssistantAssociationSummary" } }, - "com.amazonaws.qconnect#ContentAssociationType": { + "com.amazonaws.qconnect#AssistantCapabilityConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.qconnect#AssistantCapabilityType", + "traits": { + "smithy.api#documentation": "

The type of Amazon Q in Connect assistant capability.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The capability configuration for an Amazon Q in Connect assistant.

" + } + }, + "com.amazonaws.qconnect#AssistantCapabilityType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "AMAZON_CONNECT_GUIDE", - "name": "AMAZON_CONNECT_GUIDE" + "value": "V1", + "name": "V1" + }, + { + "value": "V2", + "name": "V2" } ] } }, - "com.amazonaws.qconnect#ContentData": { + "com.amazonaws.qconnect#AssistantData": { "type": "structure", "members": { - "contentArn": { - "target": "com.amazonaws.qconnect#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", - "smithy.api#required": {} - } - }, - "contentId": { + "assistantId": { "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

The identifier of the content.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, - "knowledgeBaseArn": { + "assistantArn": { "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", - "smithy.api#required": {} - } - }, - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", - "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "

The name of the content.

", + "smithy.api#documentation": "

The name.

", "smithy.api#required": {} } }, - "revisionId": { - "target": "com.amazonaws.qconnect#NonEmptyString", + "type": { + "target": "com.amazonaws.qconnect#AssistantType", "traits": { - "smithy.api#documentation": "

The identifier of the content revision.

", + "smithy.api#documentation": "

The type of assistant.

", "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.qconnect#ContentTitle", + "status": { + "target": "com.amazonaws.qconnect#AssistantStatus", "traits": { - "smithy.api#documentation": "

The title of the content.

", + "smithy.api#documentation": "

The status of the assistant.

", "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.qconnect#ContentType", + "description": { + "target": "com.amazonaws.qconnect#Description", "traits": { - "smithy.api#documentation": "

The media type of the content.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The description.

" } }, - "status": { - "target": "com.amazonaws.qconnect#ContentStatus", + "tags": { + "target": "com.amazonaws.qconnect#Tags", "traits": { - "smithy.api#documentation": "

The status of the content.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } }, - "metadata": { - "target": "com.amazonaws.qconnect#ContentMetadata", + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

" } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "integrationConfiguration": { + "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant integration.

" } }, - "linkOutUri": { - "target": "com.amazonaws.qconnect#Uri", + "capabilityConfiguration": { + "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", "traits": { - "smithy.api#documentation": "

The URI of the content.

" + "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant capability.

" } }, - "url": { - "target": "com.amazonaws.qconnect#Url", + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", "traits": { - "smithy.api#documentation": "

The URL of the content.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is\n set on the Amazon Q in Connect Assistant.

" } - }, - "urlExpiry": { - "target": "smithy.api#Timestamp", + } + }, + "traits": { + "smithy.api#documentation": "

The assistant data.

" + } + }, + "com.amazonaws.qconnect#AssistantIntegrationConfiguration": { + "type": "structure", + "members": { + "topicIntegrationArn": { + "target": "com.amazonaws.qconnect#GenericArn", "traits": { - "smithy.api#documentation": "

The expiration time of the URL as an epoch timestamp.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "epoch-seconds" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

" } } }, "traits": { - "smithy.api#documentation": "

Information about the content.

", - "smithy.api#references": [ + "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant integration.

" + } + }, + "com.amazonaws.qconnect#AssistantList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AssistantSummary" + } + }, + "com.amazonaws.qconnect#AssistantStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ { - "resource": "com.amazonaws.qconnect#Content" + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" }, { - "resource": "com.amazonaws.qconnect#KnowledgeBase" + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" } ] } }, - "com.amazonaws.qconnect#ContentDataDetails": { + "com.amazonaws.qconnect#AssistantSummary": { "type": "structure", "members": { - "textData": { - "target": "com.amazonaws.qconnect#TextData", + "assistantId": { + "target": "com.amazonaws.qconnect#Uuid", "traits": { - "smithy.api#documentation": "

Details about the content text data.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } }, - "rankingData": { - "target": "com.amazonaws.qconnect#RankingData", + "assistantArn": { + "target": "com.amazonaws.qconnect#Arn", "traits": { - "smithy.api#documentation": "

Details about the content ranking data.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

Details about the content data.

" - } - }, - "com.amazonaws.qconnect#ContentFeedbackData": { - "type": "union", - "members": { - "generativeContentFeedbackData": { - "target": "com.amazonaws.qconnect#GenerativeContentFeedbackData", + }, + "name": { + "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "

Information about the feedback for a generative target type.

" + "smithy.api#documentation": "

The name of the assistant.

", + "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the feedback.

" - } - }, - "com.amazonaws.qconnect#ContentMetadata": { - "type": "map", + }, + "type": { + "target": "com.amazonaws.qconnect#AssistantType", + "traits": { + "smithy.api#documentation": "

The type of the assistant.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#AssistantStatus", + "traits": { + "smithy.api#documentation": "

The status of the assistant.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description of the assistant.

" + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow\n kms:Decrypt, kms:GenerateDataKey*, and\n kms:DescribeKey permissions to the connect.amazonaws.com service\n principal.

\n

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

" + } + }, + "integrationConfiguration": { + "target": "com.amazonaws.qconnect#AssistantIntegrationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant integration.

" + } + }, + "capabilityConfiguration": { + "target": "com.amazonaws.qconnect#AssistantCapabilityConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the Amazon Q in Connect assistant capability.

" + } + }, + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", + "traits": { + "smithy.api#documentation": "

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is\n set on the Amazon Q in Connect Assistant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about the assistant.

" + } + }, + "com.amazonaws.qconnect#AssistantType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AGENT", + "name": "AGENT" + } + ] + } + }, + "com.amazonaws.qconnect#AssociationConfiguration": { + "type": "structure", + "members": { + "associationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the association for this Association Configuration.

" + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#AIAgentAssociationConfigurationType", + "traits": { + "smithy.api#documentation": "

The type of the association for this Association Configuration.

" + } + }, + "associationConfigurationData": { + "target": "com.amazonaws.qconnect#AssociationConfigurationData", + "traits": { + "smithy.api#documentation": "

The data of the configuration for an Amazon Q in Connect Assistant Association.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for an Amazon Q in Connect Assistant Association.

" + } + }, + "com.amazonaws.qconnect#AssociationConfigurationData": { + "type": "union", + "members": { + "knowledgeBaseAssociationConfigurationData": { + "target": "com.amazonaws.qconnect#KnowledgeBaseAssociationConfigurationData", + "traits": { + "smithy.api#documentation": "

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant\n Association.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A typed union of the data of the configuration for an Amazon Q in Connect Assistant\n Association.

" + } + }, + "com.amazonaws.qconnect#AssociationConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#AssociationConfiguration" + } + }, + "com.amazonaws.qconnect#AssociationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KNOWLEDGE_BASE", + "name": "KNOWLEDGE_BASE" + } + ] + } + }, + "com.amazonaws.qconnect#BedrockFoundationModelConfigurationForParsing": { + "type": "structure", + "members": { + "modelArn": { + "target": "com.amazonaws.qconnect#BedrockModelArnForParsing", + "traits": { + "smithy.api#documentation": "

The ARN of the foundation model.

", + "smithy.api#required": {} + } + }, + "parsingPrompt": { + "target": "com.amazonaws.qconnect#ParsingPrompt", + "traits": { + "smithy.api#documentation": "

Instructions for interpreting the contents of a document.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for a foundation model used to parse documents for a data source.

" + } + }, + "com.amazonaws.qconnect#BedrockModelArnForParsing": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/anthropic.claude-3-haiku-20240307-v1:0$" + } + }, + "com.amazonaws.qconnect#Channel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#Channels": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#Channel" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#ChunkingConfiguration": { + "type": "structure", + "members": { + "chunkingStrategy": { + "target": "com.amazonaws.qconnect#ChunkingStrategy", + "traits": { + "smithy.api#documentation": "

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a\n data source that is returned when the knowledge base that it belongs to is queried. You have\n the following options for chunking your data. If you opt for NONE, then you may\n want to pre-process your files by splitting them up such that each file corresponds to a\n chunk.

", + "smithy.api#required": {} + } + }, + "fixedSizeChunkingConfiguration": { + "target": "com.amazonaws.qconnect#FixedSizeChunkingConfiguration", + "traits": { + "smithy.api#documentation": "

Configurations for when you choose fixed-size chunking. If you set the\n chunkingStrategy as NONE, exclude this field.

" + } + }, + "hierarchicalChunkingConfiguration": { + "target": "com.amazonaws.qconnect#HierarchicalChunkingConfiguration", + "traits": { + "smithy.api#documentation": "

Settings for hierarchical document chunking for a data source. Hierarchical chunking\n splits documents into layers of chunks where the first layer contains large chunks, and the\n second layer contains smaller chunks derived from the first layer.

" + } + }, + "semanticChunkingConfiguration": { + "target": "com.amazonaws.qconnect#SemanticChunkingConfiguration", + "traits": { + "smithy.api#documentation": "

Settings for semantic document chunking for a data source. Semantic chunking splits a\n document into smaller documents based on groups of similar content derived from the text with\n natural language processing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about how to chunk the documents in the data source. A chunk refers to an excerpt\n from a data source that is returned when the knowledge base that it belongs to is\n queried.

" + } + }, + "com.amazonaws.qconnect#ChunkingStrategy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FIXED_SIZE", + "name": "FIXED_SIZE" + }, + { + "value": "NONE", + "name": "NONE" + }, + { + "value": "HIERARCHICAL", + "name": "HIERARCHICAL" + }, + { + "value": "SEMANTIC", + "name": "SEMANTIC" + } + ] + } + }, + "com.amazonaws.qconnect#CitationSpan": { + "type": "structure", + "members": { + "beginOffsetInclusive": { + "target": "com.amazonaws.qconnect#CitationSpanOffset", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Where the text with a citation starts in the generated output.

" + } + }, + "endOffsetExclusive": { + "target": "com.amazonaws.qconnect#CitationSpanOffset", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Where the text with a citation ends in the generated output.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about where the text with a citation begins and ends in the generated\n output.

" + } + }, + "com.amazonaws.qconnect#CitationSpanOffset": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.qconnect#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.qconnect#Configuration": { + "type": "union", + "members": { + "connectConfiguration": { + "target": "com.amazonaws.qconnect#ConnectConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information of the Amazon Connect data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration information of the external data source.

" + } + }, + "com.amazonaws.qconnect#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource. For example, if you're using a Create API (such as\n CreateAssistant) that accepts name, a conflicting resource (usually with the\n same name) is being created or mutated.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.qconnect#ConnectConfiguration": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration information of the Amazon Connect data source.

" + } + }, + "com.amazonaws.qconnect#ContactAttributeKey": { + "type": "string" + }, + "com.amazonaws.qconnect#ContactAttributeKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContactAttributeKey" + }, + "traits": { + "smithy.api#sensitive": {}, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.qconnect#ContactAttributeValue": { + "type": "string" + }, + "com.amazonaws.qconnect#ContactAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.qconnect#ContactAttributeKey" + }, + "value": { + "target": "com.amazonaws.qconnect#ContactAttributeValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#Content": { + "type": "resource", + "identifiers": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateContent" + }, + "read": { + "target": "com.amazonaws.qconnect#GetContent" + }, + "update": { + "target": "com.amazonaws.qconnect#UpdateContent" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteContent" + }, + "list": { + "target": "com.amazonaws.qconnect#ListContents" + }, + "operations": [ + { + "target": "com.amazonaws.qconnect#GetContentSummary" + } + ], + "resources": [ + { + "target": "com.amazonaws.qconnect#ContentAssociation" + } + ], + "traits": { + "aws.api#arn": { + "template": "content/{knowledgeBaseId}/{contentId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#ContentAssociation": { + "type": "resource", + "identifiers": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateContentAssociation" + }, + "read": { + "target": "com.amazonaws.qconnect#GetContentAssociation" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteContentAssociation" + }, + "list": { + "target": "com.amazonaws.qconnect#ListContentAssociations" + }, + "traits": { + "aws.api#arn": { + "template": "content-association/{knowledgeBaseId}/{contentId}/{contentAssociationId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#ContentAssociationContents": { + "type": "union", + "members": { + "amazonConnectGuideAssociation": { + "target": "com.amazonaws.qconnect#AmazonConnectGuideAssociationData", + "traits": { + "smithy.api#documentation": "

The data of the step-by-step guide association.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The contents of a content association.

" + } + }, + "com.amazonaws.qconnect#ContentAssociationData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content.

", + "smithy.api#required": {} + } + }, + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", + "smithy.api#required": {} + } + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#required": {} + } + }, + "contentAssociationArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content association.

", + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#ContentAssociationType", + "traits": { + "smithy.api#documentation": "

The type of association.

", + "smithy.api#required": {} + } + }, + "associationData": { + "target": "com.amazonaws.qconnect#ContentAssociationContents", + "traits": { + "smithy.api#documentation": "

The content association.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the content association.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#ContentAssociation" + } + ] + } + }, + "com.amazonaws.qconnect#ContentAssociationSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content.

", + "smithy.api#required": {} + } + }, + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", + "smithy.api#required": {} + } + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#required": {} + } + }, + "contentAssociationArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content association.

", + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#ContentAssociationType", + "traits": { + "smithy.api#documentation": "

The type of association.

", + "smithy.api#required": {} + } + }, + "associationData": { + "target": "com.amazonaws.qconnect#ContentAssociationContents", + "traits": { + "smithy.api#documentation": "

The content association.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about a content association.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#ContentAssociation" + } + ] + } + }, + "com.amazonaws.qconnect#ContentAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContentAssociationSummary" + } + }, + "com.amazonaws.qconnect#ContentAssociationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AMAZON_CONNECT_GUIDE", + "name": "AMAZON_CONNECT_GUIDE" + } + ] + } + }, + "com.amazonaws.qconnect#ContentData": { + "type": "structure", + "members": { + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the content.

", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the content revision.

", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qconnect#ContentTitle", + "traits": { + "smithy.api#documentation": "

The title of the content.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#ContentType", + "traits": { + "smithy.api#documentation": "

The media type of the content.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#ContentStatus", + "traits": { + "smithy.api#documentation": "

The status of the content.

", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + }, + "linkOutUri": { + "target": "com.amazonaws.qconnect#Uri", + "traits": { + "smithy.api#documentation": "

The URI of the content.

" + } + }, + "url": { + "target": "com.amazonaws.qconnect#Url", + "traits": { + "smithy.api#documentation": "

The URL of the content.

", + "smithy.api#required": {} + } + }, + "urlExpiry": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The expiration time of the URL as an epoch timestamp.

", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "epoch-seconds" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the content.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#Content" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#ContentDataDetails": { + "type": "structure", + "members": { + "textData": { + "target": "com.amazonaws.qconnect#TextData", + "traits": { + "smithy.api#documentation": "

Details about the content text data.

", + "smithy.api#required": {} + } + }, + "rankingData": { + "target": "com.amazonaws.qconnect#RankingData", + "traits": { + "smithy.api#documentation": "

Details about the content ranking data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the content data.

" + } + }, + "com.amazonaws.qconnect#ContentFeedbackData": { + "type": "union", + "members": { + "generativeContentFeedbackData": { + "target": "com.amazonaws.qconnect#GenerativeContentFeedbackData", + "traits": { + "smithy.api#documentation": "

Information about the feedback for a generative target type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the feedback.

" + } + }, + "com.amazonaws.qconnect#ContentMetadata": { + "type": "map", "key": { "target": "com.amazonaws.qconnect#NonEmptyString" }, - "value": { - "target": "com.amazonaws.qconnect#NonEmptyString" + "value": { + "target": "com.amazonaws.qconnect#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.qconnect#ContentReference": { + "type": "structure", + "members": { + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

" + } + }, + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

" + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content.

" + } + }, + "sourceURL": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The web URL of the source content.

" + } + }, + "referenceType": { + "target": "com.amazonaws.qconnect#ReferenceType", + "traits": { + "smithy.api#documentation": "

The type of reference content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reference information about the content.

" + } + }, + "com.amazonaws.qconnect#ContentStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + } + ] + } + }, + "com.amazonaws.qconnect#ContentSummary": { + "type": "structure", + "members": { + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the content.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the content.

", + "smithy.api#required": {} + } + }, + "revisionId": { + "target": "com.amazonaws.qconnect#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The identifier of the revision of the content.

", + "smithy.api#required": {} + } + }, + "title": { + "target": "com.amazonaws.qconnect#ContentTitle", + "traits": { + "smithy.api#documentation": "

The title of the content.

", + "smithy.api#required": {} + } + }, + "contentType": { + "target": "com.amazonaws.qconnect#ContentType", + "traits": { + "smithy.api#documentation": "

The media type of the content.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#ContentStatus", + "traits": { + "smithy.api#documentation": "

The status of the content.

", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.qconnect#ContentMetadata", + "traits": { + "smithy.api#documentation": "

A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about the content.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#Content" + }, + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#ContentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContentSummary" + } + }, + "com.amazonaws.qconnect#ContentTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.qconnect#ContentType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + } + }, + "com.amazonaws.qconnect#CreateAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Q in Connect AI Agent.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateAIAgentRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the AI Agent.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.qconnect#AIAgentType", + "traits": { + "smithy.api#documentation": "

The type of the AI Agent.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the AI Agent.

", + "smithy.api#required": {} + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "

The visibility status of the AI Agent.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description of the AI Agent.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#CreateAIAgentResponse": { + "type": "structure", + "members": { + "aiAgent": { + "target": "com.amazonaws.qconnect#AIAgentData", + "traits": { + "smithy.api#documentation": "

The data of the created AI Agent.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#CreateAIAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAIAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAIAgentVersionResponse" }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" } + ], + "traits": { + "smithy.api#documentation": "

Creates and Amazon Q in Connect AI Agent version.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}/versions", + "method": "POST" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.qconnect#ContentReference": { + "com.amazonaws.qconnect#CreateAIAgentVersionRequest": { "type": "structure", "members": { - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

" + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

" + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI Agent.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "contentArn": { - "target": "com.amazonaws.qconnect#Arn", + "modifiedTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

" + "smithy.api#documentation": "

The modification time of the AI Agent should be tracked for version creation. This field\n should be specified to avoid version creation when simultaneous update to the underlying AI\n Agent are possible. The value should be the modifiedTime returned from the request to create\n or update an AI Agent so that version creation can fail if an update to the AI Agent post the\n specified modification time has been made.

" } }, - "contentId": { - "target": "com.amazonaws.qconnect#Uuid", + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", "traits": { - "smithy.api#documentation": "

The identifier of the content.

" + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} } } }, "traits": { - "smithy.api#documentation": "

Reference information about the content.

" - } - }, - "com.amazonaws.qconnect#ContentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" - }, - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" - }, - { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "UPDATE_FAILED", - "name": "UPDATE_FAILED" - } - ] + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#ContentSummary": { + "com.amazonaws.qconnect#CreateAIAgentVersionResponse": { "type": "structure", "members": { - "contentArn": { - "target": "com.amazonaws.qconnect#Arn", + "aiAgent": { + "target": "com.amazonaws.qconnect#AIAgentData", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the content.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The data of the AI Agent version.

" } }, - "contentId": { - "target": "com.amazonaws.qconnect#Uuid", + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", "traits": { - "smithy.api#documentation": "

The identifier of the content.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The version number of the AI Agent version.

" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#CreateAIPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAIPromptRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAIPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" }, - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Q in Connect AI Prompt.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateAIPromptRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", - "smithy.api#required": {} + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} } }, - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.qconnect#Name", "traits": { - "smithy.api#documentation": "

The name of the content.

", + "smithy.api#documentation": "

The name of the AI Prompt.

", "smithy.api#required": {} } }, - "revisionId": { - "target": "com.amazonaws.qconnect#NonEmptyString", + "type": { + "target": "com.amazonaws.qconnect#AIPromptType", "traits": { - "smithy.api#documentation": "

The identifier of the revision of the content.

", + "smithy.api#documentation": "

The type of this AI Prompt.

", "smithy.api#required": {} } }, - "title": { - "target": "com.amazonaws.qconnect#ContentTitle", + "templateConfiguration": { + "target": "com.amazonaws.qconnect#AIPromptTemplateConfiguration", "traits": { - "smithy.api#documentation": "

The title of the content.

", + "smithy.api#documentation": "

The configuration of the prompt template for this AI Prompt.

", "smithy.api#required": {} } }, - "contentType": { - "target": "com.amazonaws.qconnect#ContentType", + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", "traits": { - "smithy.api#documentation": "

The media type of the content.

", + "smithy.api#documentation": "

The visibility status of the AI Prompt.

", "smithy.api#required": {} } }, - "status": { - "target": "com.amazonaws.qconnect#ContentStatus", + "templateType": { + "target": "com.amazonaws.qconnect#AIPromptTemplateType", "traits": { - "smithy.api#documentation": "

The status of the content.

", + "smithy.api#documentation": "

The type of the prompt template for this AI Prompt.

", "smithy.api#required": {} } }, - "metadata": { - "target": "com.amazonaws.qconnect#ContentMetadata", + "modelId": { + "target": "com.amazonaws.qconnect#AIPromptModelIdentifier", "traits": { - "smithy.api#documentation": "

A key/value map to store attributes without affecting tagging or recommendations. \nFor example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

", + "smithy.api#documentation": "

The identifier of the model used for this AI Prompt. Model Ids supported are:\n CLAUDE_3_HAIKU_20240307_V1\n

", + "smithy.api#required": {} + } + }, + "apiFormat": { + "target": "com.amazonaws.qconnect#AIPromptAPIFormat", + "traits": { + "smithy.api#documentation": "

The API Format of the AI Prompt.

", "smithy.api#required": {} } }, @@ -1208,39 +2507,124 @@ "traits": { "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description of the AI Prompt.

" + } } }, "traits": { - "smithy.api#documentation": "

Summary information about the content.

", - "smithy.api#references": [ - { - "resource": "com.amazonaws.qconnect#Content" - }, - { - "resource": "com.amazonaws.qconnect#KnowledgeBase" + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#CreateAIPromptResponse": { + "type": "structure", + "members": { + "aiPrompt": { + "target": "com.amazonaws.qconnect#AIPromptData", + "traits": { + "smithy.api#documentation": "

The data of the AI Prompt.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#CreateAIPromptVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateAIPromptVersionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateAIPromptVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Q in Connect AI Prompt version.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}/versions", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#CreateAIPromptVersionRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI prompt.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "modifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The time the AI Prompt was last modified.

" + } + }, + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} } - ] - } - }, - "com.amazonaws.qconnect#ContentSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#ContentSummary" - } - }, - "com.amazonaws.qconnect#ContentTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#ContentType": { - "type": "string", + "com.amazonaws.qconnect#CreateAIPromptVersionResponse": { + "type": "structure", + "members": { + "aiPrompt": { + "target": "com.amazonaws.qconnect#AIPromptData", + "traits": { + "smithy.api#documentation": "

The data of the AI Prompt version.

" + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "

The version number of the AI Prompt version.

" + } + } + }, "traits": { - "smithy.api#pattern": "^(text/(plain|html|csv))|(application/(pdf|vnd\\.openxmlformats-officedocument\\.wordprocessingml\\.document))|(application/x\\.wisdom-json;source=(salesforce|servicenow|zendesk))$" + "smithy.api#output": {} } }, "com.amazonaws.qconnect#CreateAssistant": { @@ -1477,7 +2861,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an association between a content resource in a knowledge base and step-by-step\n guides. Step-by-step guides offer instructions to agents for resolving common\n customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step\n guides.

\n

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a\n recommendation to an agent based on the intent that it's detected, it also provides them with\n the option to start the step-by-step guide that you have associated with the content.

\n

Note the following limitations:

\n
    \n
  • \n

    You can create only one content association for each\n content resource in a knowledge base.

    \n
    • \n
  • \n

    You can associate a step-by-step guide with multiple content resources.

    \n
    • \n
\n

For more information, see Integrate Amazon Q in Connect with\n step-by-step guides in the Amazon Connect Administrator\n Guide.

", + "smithy.api#documentation": "

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving\n common customer issues. You create a content association to integrate Amazon Q in Connect and\n step-by-step guides.

\n

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a\n recommendation to an agent based on the intent that it's detected, it also provides them with\n the option to start the step-by-step guide that you have associated with the content.

\n

Note the following limitations:

\n
    \n
  • \n

    You can create only one content association for each content resource in a knowledge\n base.

    \n
    • \n
  • \n

    You can associate a step-by-step guide with multiple content resources.

    \n
    • \n
\n

For more information, see Integrate Amazon Q in Connect with\n step-by-step guides in the Amazon Connect Administrator\n Guide.

", "smithy.api#http": { "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations", "method": "POST" @@ -1685,6 +3069,12 @@ "smithy.api#documentation": "

Information about how to render the content.

" } }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.qconnect#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about how to ingest the documents in a data source.

" + } + }, "serverSideEncryptionConfiguration": { "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", "traits": { @@ -1917,94 +3307,380 @@ "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" } }, - "tagFilter": { - "target": "com.amazonaws.qconnect#TagFilter", - "traits": { - "smithy.api#documentation": "

An object that can be used to specify Tag conditions.

" - } + "tagFilter": { + "target": "com.amazonaws.qconnect#TagFilter", + "traits": { + "smithy.api#documentation": "

An object that can be used to specify Tag conditions.

" + } + }, + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", + "traits": { + "smithy.api#documentation": "

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that\n should be used by Amazon Q in Connect for this Session.

" + } + } + } + }, + "com.amazonaws.qconnect#CreateSessionResponse": { + "type": "structure", + "members": { + "session": { + "target": "com.amazonaws.qconnect#SessionData", + "traits": { + "smithy.api#documentation": "

The session.

" + } + } + } + }, + "com.amazonaws.qconnect#DataDetails": { + "type": "union", + "members": { + "contentData": { + "target": "com.amazonaws.qconnect#ContentDataDetails", + "traits": { + "smithy.api#documentation": "

Details about the content data.

" + } + }, + "generativeData": { + "target": "com.amazonaws.qconnect#GenerativeDataDetails", + "traits": { + "smithy.api#documentation": "

Details about the generative data.

" + } + }, + "intentDetectedData": { + "target": "com.amazonaws.qconnect#IntentDetectedDataDetails", + "traits": { + "smithy.api#documentation": "

Details about the intent data.

" + } + }, + "sourceContentData": { + "target": "com.amazonaws.qconnect#SourceContentDataDetails", + "traits": { + "smithy.api#documentation": "

Details about the content data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the data.

" + } + }, + "com.amazonaws.qconnect#DataReference": { + "type": "union", + "members": { + "contentReference": { + "target": "com.amazonaws.qconnect#ContentReference" + }, + "generativeReference": { + "target": "com.amazonaws.qconnect#GenerativeReference", + "traits": { + "smithy.api#documentation": "

Reference information about the generative content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reference data.

" + } + }, + "com.amazonaws.qconnect#DataSummary": { + "type": "structure", + "members": { + "reference": { + "target": "com.amazonaws.qconnect#DataReference", + "traits": { + "smithy.api#documentation": "

Reference information about the content.

", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.qconnect#DataDetails", + "traits": { + "smithy.api#documentation": "

Details about the data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of the data.

" + } + }, + "com.amazonaws.qconnect#DataSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#DataSummary" + } + }, + "com.amazonaws.qconnect#DeleteAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Q in Connect AI Agent.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAIAgentVersionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAIAgentVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Q in Connect AI Agent Version.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}/versions/{versionNumber}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentVersionRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "

The version number of the AI Agent version.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#DeleteAIAgentVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#DeleteAIPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAIPromptRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAIPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Q in Connect AI Prompt.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.qconnect#CreateSessionResponse": { + "com.amazonaws.qconnect#DeleteAIPromptRequest": { "type": "structure", "members": { - "session": { - "target": "com.amazonaws.qconnect#SessionData", - "traits": { - "smithy.api#documentation": "

The session.

" - } - } - } - }, - "com.amazonaws.qconnect#DataDetails": { - "type": "union", - "members": { - "contentData": { - "target": "com.amazonaws.qconnect#ContentDataDetails", - "traits": { - "smithy.api#documentation": "

Details about the content data.

" - } - }, - "generativeData": { - "target": "com.amazonaws.qconnect#GenerativeDataDetails", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

Details about the generative data.

" + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "sourceContentData": { - "target": "com.amazonaws.qconnect#SourceContentDataDetails", + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "

Details about the content data.

" + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Details about the data.

" + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#DataReference": { - "type": "union", - "members": { - "contentReference": { - "target": "com.amazonaws.qconnect#ContentReference" + "com.amazonaws.qconnect#DeleteAIPromptResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#DeleteAIPromptVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteAIPromptVersionRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteAIPromptVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" }, - "generativeReference": { - "target": "com.amazonaws.qconnect#GenerativeReference", - "traits": { - "smithy.api#documentation": "

Reference information about the generative content.

" - } + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" } - }, + ], "traits": { - "smithy.api#documentation": "

Reference data.

" + "smithy.api#documentation": "

Delete and Amazon Q in Connect AI Prompt version.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}/versions/{versionNumber}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.qconnect#DataSummary": { + "com.amazonaws.qconnect#DeleteAIPromptVersionRequest": { "type": "structure", "members": { - "reference": { - "target": "com.amazonaws.qconnect#DataReference", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

Reference information about the content.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "details": { - "target": "com.amazonaws.qconnect#DataDetails", + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "

Details about the data.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI prompt.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "

The version number of the AI Prompt version to be deleted.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Summary of the data.

" + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#DataSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#DataSummary" + "com.amazonaws.qconnect#DeleteAIPromptVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.qconnect#DeleteAssistant": { @@ -2491,6 +4167,12 @@ "smithy.api#documentation": "

The configuration information of the external data source.

" } }, + "com.amazonaws.qconnect#FailureReason": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#NonEmptyString" + } + }, "com.amazonaws.qconnect#Filter": { "type": "structure", "members": { @@ -2548,6 +4230,35 @@ ] } }, + "com.amazonaws.qconnect#FixedSizeChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens to include in a chunk.

", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "overlapPercentage": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The percentage of overlap between adjacent chunks of a data source.

", + "smithy.api#range": { + "min": 1, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations for when you choose fixed-size chunking. If you set the\n chunkingStrategy as NONE, exclude this field.

" + } + }, "com.amazonaws.qconnect#GenerativeContentFeedbackData": { "type": "structure", "members": { @@ -2560,66 +4271,216 @@ } }, "traits": { - "smithy.api#documentation": "

The feedback information for a generative target type.

" + "smithy.api#documentation": "

The feedback information for a generative target type.

" + } + }, + "com.amazonaws.qconnect#GenerativeDataDetails": { + "type": "structure", + "members": { + "completion": { + "target": "com.amazonaws.qconnect#SensitiveString", + "traits": { + "smithy.api#documentation": "

The LLM response.

", + "smithy.api#required": {} + } + }, + "references": { + "target": "com.amazonaws.qconnect#DataSummaryList", + "traits": { + "smithy.api#documentation": "

The references used to generative the LLM response.

", + "smithy.api#required": {} + } + }, + "rankingData": { + "target": "com.amazonaws.qconnect#RankingData", + "traits": { + "smithy.api#documentation": "

Details about the generative content ranking data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about generative data.

" + } + }, + "com.amazonaws.qconnect#GenerativeReference": { + "type": "structure", + "members": { + "modelId": { + "target": "com.amazonaws.qconnect#LlmModelId", + "traits": { + "smithy.api#documentation": "

The identifier of the LLM model.

" + } + }, + "generationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the LLM model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Reference information about generative content.

" + } + }, + "com.amazonaws.qconnect#GenericArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" + } + }, + "com.amazonaws.qconnect#GetAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets an Amazon Q in Connect AI Agent.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetAIAgentRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier).\n Can be either the ID or the ARN. URLs cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#GetAIAgentResponse": { + "type": "structure", + "members": { + "aiAgent": { + "target": "com.amazonaws.qconnect#AIAgentData", + "traits": { + "smithy.api#documentation": "

The data of the AI Agent.

" + } + }, + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", + "traits": { + "smithy.api#documentation": "

The version number of the AI Agent version (returned if an AI Agent version was specified\n via use of a qualifier for the aiAgentId on the request).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#GetAIPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetAIPromptRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetAIPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets and Amazon Q in Connect AI Prompt.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}", + "method": "GET" + }, + "smithy.api#readonly": {} } }, - "com.amazonaws.qconnect#GenerativeDataDetails": { + "com.amazonaws.qconnect#GetAIPromptRequest": { "type": "structure", "members": { - "completion": { - "target": "com.amazonaws.qconnect#SensitiveString", - "traits": { - "smithy.api#documentation": "

The LLM response.

", - "smithy.api#required": {} - } - }, - "references": { - "target": "com.amazonaws.qconnect#DataSummaryList", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

The references used to generative the LLM response.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "rankingData": { - "target": "com.amazonaws.qconnect#RankingData", + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "

Details about the generative content ranking data.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI prompt.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Details about generative data.

" + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#GenerativeReference": { + "com.amazonaws.qconnect#GetAIPromptResponse": { "type": "structure", "members": { - "modelId": { - "target": "com.amazonaws.qconnect#LlmModelId", + "aiPrompt": { + "target": "com.amazonaws.qconnect#AIPromptData", "traits": { - "smithy.api#documentation": "

The identifier of the LLM model.

" + "smithy.api#documentation": "

The data of the AI Prompt.

" } }, - "generationId": { - "target": "com.amazonaws.qconnect#Uuid", + "versionNumber": { + "target": "com.amazonaws.qconnect#Version", "traits": { - "smithy.api#documentation": "

The identifier of the LLM model.

" + "smithy.api#documentation": "

The version number of the AI Prompt version (returned if an AI Prompt version was\n specified via use of a qualifier for the aiPromptId on the request).

" } } }, "traits": { - "smithy.api#documentation": "

Reference information about generative content.

" - } - }, - "com.amazonaws.qconnect#GenericArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" + "smithy.api#output": {} } }, "com.amazonaws.qconnect#GetAssistant": { @@ -3315,6 +5176,62 @@ "target": "com.amazonaws.qconnect#NonEmptyString" } }, + "com.amazonaws.qconnect#HierarchicalChunkingConfiguration": { + "type": "structure", + "members": { + "levelConfigurations": { + "target": "com.amazonaws.qconnect#HierarchicalChunkingLevelConfigurations", + "traits": { + "smithy.api#documentation": "

Token settings for each layer.

", + "smithy.api#required": {} + } + }, + "overlapTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of tokens to repeat across chunks in the same layer.

", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for hierarchical document chunking for a data source. Hierarchical chunking\n splits documents into layers of chunks where the first layer contains large chunks, and the\n second layer contains smaller chunks derived from the first layer.

" + } + }, + "com.amazonaws.qconnect#HierarchicalChunkingLevelConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens that a chunk can contain in this layer.

", + "smithy.api#range": { + "min": 1, + "max": 8192 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Token settings for each layer.

" + } + }, + "com.amazonaws.qconnect#HierarchicalChunkingLevelConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#HierarchicalChunkingLevelConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, "com.amazonaws.qconnect#Highlight": { "type": "structure", "members": { @@ -3571,6 +5488,43 @@ ] } }, + "com.amazonaws.qconnect#IntentDetectedDataDetails": { + "type": "structure", + "members": { + "intent": { + "target": "com.amazonaws.qconnect#SensitiveString", + "traits": { + "smithy.api#documentation": "

The detected intent.

", + "smithy.api#required": {} + } + }, + "intentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the detected intent.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the detected intent.

" + } + }, + "com.amazonaws.qconnect#IntentInputData": { + "type": "structure", + "members": { + "intentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q intent.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Amazon Q intent.

" + } + }, "com.amazonaws.qconnect#KnowledgeBase": { "type": "resource", "identifiers": { @@ -3635,6 +5589,29 @@ "aws.iam#disableConditionKeyInference": {} } }, + "com.amazonaws.qconnect#KnowledgeBaseAssociationConfigurationData": { + "type": "structure", + "members": { + "contentTagFilter": { + "target": "com.amazonaws.qconnect#TagFilter" + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

" + } + }, + "overrideKnowledgeBaseSearchType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseSearchType", + "traits": { + "smithy.api#documentation": "

The search type to be used against the Knowledge Base for this request. The values can be\n SEMANTIC which uses vector embeddings or HYBRID which use vector\n embeddings and raw text

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect\n Assistant Association.

" + } + }, "com.amazonaws.qconnect#KnowledgeBaseAssociationData": { "type": "structure", "members": { @@ -3649,13 +5626,168 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

" } - } - }, + } + }, + "traits": { + "smithy.api#documentation": "

Association information about the knowledge base.

" + } + }, + "com.amazonaws.qconnect#KnowledgeBaseData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.qconnect#Name", + "traits": { + "smithy.api#documentation": "

The name of the knowledge base.

", + "smithy.api#required": {} + } + }, + "knowledgeBaseType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseType", + "traits": { + "smithy.api#documentation": "

The type of knowledge base.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.qconnect#KnowledgeBaseStatus", + "traits": { + "smithy.api#documentation": "

The status of the knowledge base.

", + "smithy.api#required": {} + } + }, + "lastContentModificationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

An epoch timestamp indicating the most recent content modification inside the knowledge\n base. If no content exists in a knowledge base, this value is unset.

", + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "vectorIngestionConfiguration": { + "target": "com.amazonaws.qconnect#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about how to ingest the documents in a data source.

" + } + }, + "sourceConfiguration": { + "target": "com.amazonaws.qconnect#SourceConfiguration", + "traits": { + "smithy.api#documentation": "

Source configuration information about the knowledge base.

" + } + }, + "renderingConfiguration": { + "target": "com.amazonaws.qconnect#RenderingConfiguration", + "traits": { + "smithy.api#documentation": "

Information about how to render the content.

" + } + }, + "serverSideEncryptionConfiguration": { + "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect.

\n

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description.

" + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + } + }, + "ingestionStatus": { + "target": "com.amazonaws.qconnect#SyncStatus", + "traits": { + "smithy.api#documentation": "

Status of ingestion on data source.

" + } + }, + "ingestionFailureReasons": { + "target": "com.amazonaws.qconnect#FailureReason", + "traits": { + "smithy.api#documentation": "

List of failure reasons on ingestion per file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the knowledge base.

", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#KnowledgeBase" + } + ] + } + }, + "com.amazonaws.qconnect#KnowledgeBaseList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#KnowledgeBaseSummary" + } + }, + "com.amazonaws.qconnect#KnowledgeBaseSearchType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HYBRID", + "name": "HYBRID" + }, + { + "value": "SEMANTIC", + "name": "SEMANTIC" + } + ] + } + }, + "com.amazonaws.qconnect#KnowledgeBaseStatus": { + "type": "string", "traits": { - "smithy.api#documentation": "

Association information about the knowledge base.

" + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] } }, - "com.amazonaws.qconnect#KnowledgeBaseData": { + "com.amazonaws.qconnect#KnowledgeBaseSummary": { "type": "structure", "members": { "knowledgeBaseId": { @@ -3689,21 +5821,20 @@ "status": { "target": "com.amazonaws.qconnect#KnowledgeBaseStatus", "traits": { - "smithy.api#documentation": "

The status of the knowledge base.

", + "smithy.api#documentation": "

The status of the knowledge base summary.

", "smithy.api#required": {} } }, - "lastContentModificationTime": { - "target": "smithy.api#Timestamp", + "sourceConfiguration": { + "target": "com.amazonaws.qconnect#SourceConfiguration", "traits": { - "smithy.api#documentation": "

An epoch timestamp indicating the most recent content modification inside the knowledge\n base. If no content exists in a knowledge base, this value is unset.

", - "smithy.api#timestampFormat": "epoch-seconds" + "smithy.api#documentation": "

Configuration information about the external data source.

" } }, - "sourceConfiguration": { - "target": "com.amazonaws.qconnect#SourceConfiguration", + "vectorIngestionConfiguration": { + "target": "com.amazonaws.qconnect#VectorIngestionConfiguration", "traits": { - "smithy.api#documentation": "

Source configuration information about the knowledge base.

" + "smithy.api#documentation": "

Contains details about how to ingest the documents in a data source.

" } }, "renderingConfiguration": { @@ -3721,7 +5852,7 @@ "description": { "target": "com.amazonaws.qconnect#Description", "traits": { - "smithy.api#documentation": "

The description.

" + "smithy.api#documentation": "

The description of the knowledge base.

" } }, "tags": { @@ -3732,7 +5863,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the knowledge base.

", + "smithy.api#documentation": "

Summary information about the knowledge base.

", "smithy.api#references": [ { "resource": "com.amazonaws.qconnect#KnowledgeBase" @@ -3740,147 +5871,436 @@ ] } }, - "com.amazonaws.qconnect#KnowledgeBaseList": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#KnowledgeBaseSummary" - } - }, - "com.amazonaws.qconnect#KnowledgeBaseStatus": { + "com.amazonaws.qconnect#KnowledgeBaseType": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "CREATE_IN_PROGRESS", - "name": "CREATE_IN_PROGRESS" - }, - { - "value": "CREATE_FAILED", - "name": "CREATE_FAILED" + "value": "EXTERNAL", + "name": "EXTERNAL" }, { - "value": "ACTIVE", - "name": "ACTIVE" + "value": "CUSTOM", + "name": "CUSTOM" }, { - "value": "DELETE_IN_PROGRESS", - "name": "DELETE_IN_PROGRESS" + "value": "QUICK_RESPONSES", + "name": "QUICK_RESPONSES" }, { - "value": "DELETE_FAILED", - "name": "DELETE_FAILED" + "value": "MESSAGE_TEMPLATES", + "name": "MESSAGE_TEMPLATES" }, { - "value": "DELETED", - "name": "DELETED" + "value": "MANAGED", + "name": "MANAGED" } ] } }, - "com.amazonaws.qconnect#KnowledgeBaseSummary": { + "com.amazonaws.qconnect#LanguageCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 5 + } + } + }, + "com.amazonaws.qconnect#ListAIAgentVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAIAgentVersionsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAIAgentVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List AI Agent versions.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}/versions", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "aiAgentVersionSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAIAgentVersionsRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI Agent for which versions are to be\n listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "

The origin of the AI Agent versions to be listed. SYSTEM for a default AI\n Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI\n Agent creation APIs.

", + "smithy.api#httpQuery": "origin" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#ListAIAgentVersionsResponse": { + "type": "structure", + "members": { + "aiAgentVersionSummaries": { + "target": "com.amazonaws.qconnect#AIAgentVersionSummariesList", + "traits": { + "smithy.api#documentation": "

The summaries of AI Agent versions.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#ListAIAgents": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAIAgentsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAIAgentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists AI Agents.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "aiAgentSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAIAgentsRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "origin": { + "target": "com.amazonaws.qconnect#Origin", + "traits": { + "smithy.api#documentation": "

The origin of the AI Agents to be listed. SYSTEM for a default AI Agent\n created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent\n creation APIs.

", + "smithy.api#httpQuery": "origin" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#ListAIAgentsResponse": { + "type": "structure", + "members": { + "aiAgentSummaries": { + "target": "com.amazonaws.qconnect#AIAgentSummaryList", + "traits": { + "smithy.api#documentation": "

The summaries of AI Agents.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#ListAIPromptVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAIPromptVersionsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAIPromptVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists AI Prompt versions.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}/versions", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "aiPromptVersionSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAIPromptVersionsRequest": { "type": "structure", "members": { - "knowledgeBaseId": { - "target": "com.amazonaws.qconnect#Uuid", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

The identifier of the knowledge base.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "knowledgeBaseArn": { - "target": "com.amazonaws.qconnect#Arn", + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the knowledge base.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI prompt for which versions are to be\n listed.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.qconnect#Name", + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", "traits": { - "smithy.api#documentation": "

The name of the knowledge base.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" } }, - "knowledgeBaseType": { - "target": "com.amazonaws.qconnect#KnowledgeBaseType", + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", "traits": { - "smithy.api#documentation": "

The type of knowledge base.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" } }, - "status": { - "target": "com.amazonaws.qconnect#KnowledgeBaseStatus", + "origin": { + "target": "com.amazonaws.qconnect#Origin", "traits": { - "smithy.api#documentation": "

The status of the knowledge base summary.

", + "smithy.api#documentation": "

The origin of the AI Prompt versions to be listed. SYSTEM for a default AI\n Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI\n Agent creation APIs.

", + "smithy.api#httpQuery": "origin" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#ListAIPromptVersionsResponse": { + "type": "structure", + "members": { + "aiPromptVersionSummaries": { + "target": "com.amazonaws.qconnect#AIPromptVersionSummariesList", + "traits": { + "smithy.api#documentation": "

The summaries of the AI Prompt versions.

", "smithy.api#required": {} } }, - "sourceConfiguration": { - "target": "com.amazonaws.qconnect#SourceConfiguration", + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", "traits": { - "smithy.api#documentation": "

Configuration information about the external data source.

" + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

" } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#ListAIPrompts": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListAIPromptsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListAIPromptsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" }, - "renderingConfiguration": { - "target": "com.amazonaws.qconnect#RenderingConfiguration", + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the AI Prompts available on the Amazon Q in Connect assistant.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "aiPromptSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListAIPromptsRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

Information about how to render the content.

" + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.qconnect#ServerSideEncryptionConfiguration", + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", "traits": { - "smithy.api#documentation": "

The configuration information for the customer managed key used for encryption.

\n

This KMS key must have a policy that allows kms:CreateGrant,\n kms:DescribeKey, kms:Decrypt, and\n kms:GenerateDataKey* permissions to the IAM identity using the\n key to invoke Amazon Q in Connect.

\n

For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for\n your instance.

" + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" } }, - "description": { - "target": "com.amazonaws.qconnect#Description", + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", "traits": { - "smithy.api#documentation": "

The description of the knowledge base.

" + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" } }, - "tags": { - "target": "com.amazonaws.qconnect#Tags", + "origin": { + "target": "com.amazonaws.qconnect#Origin", "traits": { - "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource.

" + "smithy.api#documentation": "

The origin of the AI Prompts to be listed. SYSTEM for a default AI Agent\n created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent\n creation APIs.

", + "smithy.api#httpQuery": "origin" } } }, "traits": { - "smithy.api#documentation": "

Summary information about the knowledge base.

", - "smithy.api#references": [ - { - "resource": "com.amazonaws.qconnect#KnowledgeBase" - } - ] + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#KnowledgeBaseType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "EXTERNAL", - "name": "EXTERNAL" - }, - { - "value": "CUSTOM", - "name": "CUSTOM" - }, - { - "value": "QUICK_RESPONSES", - "name": "QUICK_RESPONSES" + "com.amazonaws.qconnect#ListAIPromptsResponse": { + "type": "structure", + "members": { + "aiPromptSummaries": { + "target": "com.amazonaws.qconnect#AIPromptSummaryList", + "traits": { + "smithy.api#documentation": "

The summaries of the AI Prompts.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.

" } - ] - } - }, - "com.amazonaws.qconnect#LanguageCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 5 } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.qconnect#ListAssistantAssociations": { @@ -4492,6 +6912,40 @@ } } }, + "com.amazonaws.qconnect#ManagedSourceConfiguration": { + "type": "union", + "members": { + "webCrawlerConfiguration": { + "target": "com.amazonaws.qconnect#WebCrawlerConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration data for web crawler data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Source configuration for managed resources.

" + } + }, + "com.amazonaws.qconnect#ManualSearchAIAgentConfiguration": { + "type": "structure", + "members": { + "answerGenerationAIPromptId": { + "target": "com.amazonaws.qconnect#UuidWithQualifier", + "traits": { + "smithy.api#documentation": "

The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI\n Agent.

" + } + }, + "associationConfigurations": { + "target": "com.amazonaws.qconnect#AssociationConfigurationList", + "traits": { + "smithy.api#documentation": "

The association configurations for overriding behavior on this AI Agent.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for the MANUAL_SEARCH AI Agent type.

" + } + }, "com.amazonaws.qconnect#MaxResults": { "type": "integer", "traits": { @@ -4520,6 +6974,16 @@ } } }, + "com.amazonaws.qconnect#NonEmptySensitiveString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.qconnect#NonEmptyString": { "type": "string", "traits": { @@ -4660,26 +7124,97 @@ } }, "traits": { - "smithy.api#documentation": "

A list of conditions which would be applied together with an OR\n condition.

" + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR\n condition.

" + } + }, + "com.amazonaws.qconnect#OrConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#OrCondition" + } + }, + "com.amazonaws.qconnect#Order": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] + } + }, + "com.amazonaws.qconnect#Origin": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SYSTEM", + "name": "SYSTEM" + }, + { + "value": "CUSTOMER", + "name": "CUSTOMER" + } + ] + } + }, + "com.amazonaws.qconnect#ParsingConfiguration": { + "type": "structure", + "members": { + "parsingStrategy": { + "target": "com.amazonaws.qconnect#ParsingStrategy", + "traits": { + "smithy.api#documentation": "

The parsing strategy for the data source.

", + "smithy.api#required": {} + } + }, + "bedrockFoundationModelConfiguration": { + "target": "com.amazonaws.qconnect#BedrockFoundationModelConfigurationForParsing", + "traits": { + "smithy.api#documentation": "

Settings for a foundation model used to parse documents for a data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for parsing document contents. By default, the service converts the contents of\n each document into text before splitting it into chunks. To improve processing of PDF files\n with tables and images, you can configure the data source to convert the pages of text into\n images and use a model to describe the contents of each page.

" + } + }, + "com.amazonaws.qconnect#ParsingPrompt": { + "type": "structure", + "members": { + "parsingPromptText": { + "target": "com.amazonaws.qconnect#ParsingPromptText", + "traits": { + "smithy.api#documentation": "

Instructions for interpreting the contents of a document.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Instructions for interpreting the contents of a document.

" } }, - "com.amazonaws.qconnect#OrConditions": { - "type": "list", - "member": { - "target": "com.amazonaws.qconnect#OrCondition" + "com.amazonaws.qconnect#ParsingPromptText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } } }, - "com.amazonaws.qconnect#Order": { + "com.amazonaws.qconnect#ParsingStrategy": { "type": "string", "traits": { "smithy.api#enum": [ { - "value": "ASC", - "name": "ASC" - }, - { - "value": "DESC", - "name": "DESC" + "value": "BEDROCK_FOUNDATION_MODEL", + "name": "BEDROCK_FOUNDATION_MODEL" } ] } @@ -4881,8 +7416,7 @@ "queryText": { "target": "com.amazonaws.qconnect#QueryText", "traits": { - "smithy.api#documentation": "

The text to search for.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The text to search for.

" } }, "nextToken": { @@ -4908,6 +7442,18 @@ "traits": { "smithy.api#documentation": "

Information about how to query content.

" } + }, + "queryInputData": { + "target": "com.amazonaws.qconnect#QueryInputData", + "traits": { + "smithy.api#documentation": "

Information about the query.

" + } + }, + "overrideKnowledgeBaseSearchType": { + "target": "com.amazonaws.qconnect#KnowledgeBaseSearchType", + "traits": { + "smithy.api#documentation": "

The search type to be used against the Knowledge Base for this request. The values can be\n SEMANTIC which uses vector embeddings or HYBRID which use vector\n embeddings and raw text.

" + } } } }, @@ -5006,6 +7552,26 @@ "smithy.api#documentation": "

The condition for the query.

" } }, + "com.amazonaws.qconnect#QueryInputData": { + "type": "union", + "members": { + "queryTextInputData": { + "target": "com.amazonaws.qconnect#QueryTextInputData", + "traits": { + "smithy.api#documentation": "

Input information for the query.

" + } + }, + "intentInputData": { + "target": "com.amazonaws.qconnect#IntentInputData", + "traits": { + "smithy.api#documentation": "

Input information for the intent.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Input information for the query.

" + } + }, "com.amazonaws.qconnect#QueryRecommendationTriggerData": { "type": "structure", "members": { @@ -5028,6 +7594,10 @@ "value": "KNOWLEDGE_CONTENT", "name": "KNOWLEDGE_CONTENT" }, + { + "value": "INTENT_ANSWER", + "name": "INTENT_ANSWER" + }, { "value": "GENERATIVE_ANSWER", "name": "GENERATIVE_ANSWER" @@ -5045,11 +7615,26 @@ "type": "string", "traits": { "smithy.api#length": { - "max": 1024 + "max": 512 }, "smithy.api#sensitive": {} } }, + "com.amazonaws.qconnect#QueryTextInputData": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.qconnect#QueryText", + "traits": { + "smithy.api#documentation": "

The text to search for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the text to search for.

" + } + }, "com.amazonaws.qconnect#QuickResponse": { "type": "resource", "identifiers": { @@ -6030,6 +8615,25 @@ { "value": "GENERATIVE_ANSWER", "name": "GENERATIVE_ANSWER" + }, + { + "value": "DETECTED_INTENT", + "name": "DETECTED_INTENT" + } + ] + } + }, + "com.amazonaws.qconnect#ReferenceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "WEB_CRAWLER", + "name": "WEB_CRAWLER" + }, + { + "value": "KNOWLEDGE_BASE", + "name": "KNOWLEDGE_BASE" } ] } @@ -6077,6 +8681,69 @@ } } }, + "com.amazonaws.qconnect#RemoveAssistantAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#RemoveAssistantAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#RemoveAssistantAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect\n Assistant.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagentConfiguration", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#RemoveAssistantAIAgentRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentType": { + "target": "com.amazonaws.qconnect#AIAgentType", + "traits": { + "smithy.api#documentation": "

The type of the AI Agent being removed for use by default from the Amazon Q in Connect\n Assistant.

", + "smithy.api#httpQuery": "aiAgentType", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#RemoveAssistantAIAgentResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#RemoveKnowledgeBaseTemplateUri": { "type": "operation", "input": { @@ -6209,6 +8876,54 @@ "smithy.api#documentation": "

Information about the result.

" } }, + "com.amazonaws.qconnect#RuntimeSessionData": { + "type": "structure", + "members": { + "key": { + "target": "com.amazonaws.qconnect#NonEmptySensitiveString", + "traits": { + "smithy.api#documentation": "

The key of the data stored on the session.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.qconnect#RuntimeSessionDataValue", + "traits": { + "smithy.api#documentation": "

The value of the data stored on the session.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The list of key-value pairs that are stored on the session.

" + } + }, + "com.amazonaws.qconnect#RuntimeSessionDataList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#RuntimeSessionData" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.qconnect#RuntimeSessionDataValue": { + "type": "union", + "members": { + "stringValue": { + "target": "com.amazonaws.qconnect#NonEmptySensitiveString", + "traits": { + "smithy.api#documentation": "

The string value of the data stored on the session.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A union type that specifies the data stored on the session.

" + } + }, "com.amazonaws.qconnect#SearchContent": { "type": "operation", "input": { @@ -6497,6 +9212,72 @@ } } }, + "com.amazonaws.qconnect#SeedUrl": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.qconnect#WebUrl", + "traits": { + "smithy.api#documentation": "

URL for crawling

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A URL for crawling.

" + } + }, + "com.amazonaws.qconnect#SeedUrls": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#SeedUrl" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.qconnect#SemanticChunkingConfiguration": { + "type": "structure", + "members": { + "maxTokens": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens that a chunk can contain.

", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "bufferSize": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The buffer size.

", + "smithy.api#range": { + "min": 0, + "max": 1 + }, + "smithy.api#required": {} + } + }, + "breakpointPercentileThreshold": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The dissimilarity threshold for splitting chunks.

", + "smithy.api#range": { + "min": 50, + "max": 99 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Settings for semantic document chunking for a data source. Semantic chunking splits a\n document into smaller documents based on groups of similar content derived from the text with\n natural language processing.

" + } + }, "com.amazonaws.qconnect#SensitiveString": { "type": "string", "traits": { @@ -6549,6 +9330,11 @@ "update": { "target": "com.amazonaws.qconnect#UpdateSession" }, + "operations": [ + { + "target": "com.amazonaws.qconnect#UpdateSessionData" + } + ], "traits": { "aws.api#arn": { "template": "session/{assistantId}/{sessionId}" @@ -6603,12 +9389,29 @@ "traits": { "smithy.api#documentation": "

An object that can be used to specify Tag conditions.

" } + }, + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", + "traits": { + "smithy.api#documentation": "

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that\n should be used by Amazon Q in Connect for this Session.

" + } } }, "traits": { "smithy.api#documentation": "

Information about the session.

" } }, + "com.amazonaws.qconnect#SessionDataNamespace": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Custom", + "name": "Custom" + } + ] + } + }, "com.amazonaws.qconnect#SessionIntegrationConfiguration": { "type": "structure", "members": { @@ -6682,6 +9485,12 @@ "traits": { "smithy.api#documentation": "

Configuration information for Amazon AppIntegrations to automatically ingest content.

" } + }, + "managedSourceConfiguration": { + "target": "com.amazonaws.qconnect#ManagedSourceConfiguration", + "traits": { + "smithy.api#documentation": "

Source configuration for managed resources.

" + } } }, "traits": { @@ -6718,6 +9527,12 @@ "smithy.api#documentation": "

Details about the source content ranking data.

", "smithy.api#required": {} } + }, + "citationSpan": { + "target": "com.amazonaws.qconnect#CitationSpan", + "traits": { + "smithy.api#documentation": "

Contains information about where the text with a citation begins and ends in the generated output.

" + } } }, "traits": { @@ -6899,24 +9714,78 @@ "traits": { "smithy.api#documentation": "

The configuration information of the external source that the resource data are imported\n from.

" } - } - }, - "traits": { - "smithy.api#input": {} + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#StartImportJobResponse": { + "type": "structure", + "members": { + "importJob": { + "target": "com.amazonaws.qconnect#ImportJobData", + "traits": { + "smithy.api#documentation": "

The import job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#Status": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "DELETE_IN_PROGRESS", + "name": "DELETE_IN_PROGRESS" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "DELETED", + "name": "DELETED" + } + ] } }, - "com.amazonaws.qconnect#StartImportJobResponse": { - "type": "structure", - "members": { - "importJob": { - "target": "com.amazonaws.qconnect#ImportJobData", - "traits": { - "smithy.api#documentation": "

The import job.

" - } - } - }, + "com.amazonaws.qconnect#SyncStatus": { + "type": "string", "traits": { - "smithy.api#output": {} + "smithy.api#enum": [ + { + "value": "SYNC_FAILED", + "name": "SYNC_FAILED" + }, + { + "value": "SYNCING_IN_PROGRESS", + "name": "SYNCING_IN_PROGRESS" + }, + { + "value": "SYNC_SUCCESS", + "name": "SYNC_SUCCESS" + }, + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + } + ] } }, "com.amazonaws.qconnect#TagCondition": { @@ -7070,6 +9939,16 @@ ] } }, + "com.amazonaws.qconnect#TextAIPrompt": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.qconnect#TextData": { "type": "structure", "members": { @@ -7084,6 +9963,21 @@ "smithy.api#documentation": "

Details about the source content text data.

" } }, + "com.amazonaws.qconnect#TextFullAIPromptEditTemplateConfiguration": { + "type": "structure", + "members": { + "text": { + "target": "com.amazonaws.qconnect#TextAIPrompt", + "traits": { + "smithy.api#documentation": "

The YAML text for the AI Prompt template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a prompt template that supports full textual prompt configuration\n using a YAML prompt.

" + } + }, "com.amazonaws.qconnect#ThrottlingException": { "type": "structure", "members": { @@ -7108,71 +10002,338 @@ } } }, - "com.amazonaws.qconnect#TooManyTagsException": { + "com.amazonaws.qconnect#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The specified resource name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Q in Connect throws this exception if you have too many tags in your tag set.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.qconnect#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.qconnect#TagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.qconnect#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.qconnect#UpdateAIAgent": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateAIAgentRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateAIAgentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an AI Agent.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiagents/{aiAgentId}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#UpdateAIAgentRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiAgentId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI Agent.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "

The visbility status of the Amazon Q in Connect AI Agent.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the Amazon Q in Connect AI Agent.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description of the Amazon Q in Connect AI Agent.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateAIAgentResponse": { + "type": "structure", + "members": { + "aiAgent": { + "target": "com.amazonaws.qconnect#AIAgentData", + "traits": { + "smithy.api#documentation": "

The data of the updated Amazon Q in Connect AI Agent.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.qconnect#UpdateAIPrompt": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateAIPromptRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateAIPromptResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an AI Prompt.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/aiprompts/{aiPromptId}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#UpdateAIPromptRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the AWS SDK populates this field. For more information about\n idempotency, see Making retries safe with idempotent APIs.

", + "smithy.api#idempotencyToken": {} + } + }, + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "aiPromptId": { + "target": "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect AI Prompt.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "visibilityStatus": { + "target": "com.amazonaws.qconnect#VisibilityStatus", + "traits": { + "smithy.api#documentation": "

The visibility status of the Amazon Q in Connect AI prompt.

", + "smithy.api#required": {} + } + }, + "templateConfiguration": { + "target": "com.amazonaws.qconnect#AIPromptTemplateConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the prompt template for this AI Prompt.

" + } + }, + "description": { + "target": "com.amazonaws.qconnect#Description", + "traits": { + "smithy.api#documentation": "

The description of the Amazon Q in Connect AI Prompt.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateAIPromptResponse": { "type": "structure", "members": { - "message": { - "target": "smithy.api#String" - }, - "resourceName": { - "target": "smithy.api#String", + "aiPrompt": { + "target": "com.amazonaws.qconnect#AIPromptData", "traits": { - "smithy.api#documentation": "

The specified resource name.

" + "smithy.api#documentation": "

The data of the updated Amazon Q in Connect AI Prompt.

" } } }, "traits": { - "smithy.api#documentation": "

Amazon Q in Connect throws this exception if you have too many tags in your tag set.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#output": {} } }, - "com.amazonaws.qconnect#UntagResource": { + "com.amazonaws.qconnect#UpdateAssistantAIAgent": { "type": "operation", "input": { - "target": "com.amazonaws.qconnect#UntagResourceRequest" + "target": "com.amazonaws.qconnect#UpdateAssistantAIAgentRequest" }, "output": { - "target": "com.amazonaws.qconnect#UntagResourceResponse" + "target": "com.amazonaws.qconnect#UpdateAssistantAIAgentResponse" }, "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, { "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified resource.

", + "smithy.api#documentation": "

Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect\n Assistant.

", "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "DELETE" - }, - "smithy.api#idempotent": {} + "uri": "/assistants/{assistantId}/aiagentConfiguration", + "method": "POST" + } } }, - "com.amazonaws.qconnect#UntagResourceRequest": { + "com.amazonaws.qconnect#UpdateAssistantAIAgentRequest": { "type": "structure", "members": { - "resourceArn": { - "target": "com.amazonaws.qconnect#Arn", + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "tagKeys": { - "target": "com.amazonaws.qconnect#TagKeyList", + "aiAgentType": { + "target": "com.amazonaws.qconnect#AIAgentType", "traits": { - "smithy.api#documentation": "

The tag keys.

", - "smithy.api#httpQuery": "tagKeys", + "smithy.api#documentation": "

The type of the AI Agent being updated for use by default on the Amazon Q in Connect\n Assistant.

", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationData", + "traits": { + "smithy.api#documentation": "

The configuration of the AI Agent being updated for use by default on the Amazon Q in\n Connect Assistant.

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.qconnect#UntagResourceResponse": { + "com.amazonaws.qconnect#UpdateAssistantAIAgentResponse": { "type": "structure", - "members": {} + "members": { + "assistant": { + "target": "com.amazonaws.qconnect#AssistantData" + } + }, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.qconnect#UpdateContent": { "type": "operation", @@ -7500,6 +10661,106 @@ } } }, + "com.amazonaws.qconnect#UpdateSessionData": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#UpdateSessionDataRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#UpdateSessionDataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the data stored on an Amazon Q in Connect Session.

", + "smithy.api#http": { + "uri": "/assistants/{assistantId}/sessions/{sessionId}/data", + "method": "PATCH" + } + } + }, + "com.amazonaws.qconnect#UpdateSessionDataRequest": { + "type": "structure", + "members": { + "assistantId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs\n cannot contain the ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the\n ARN.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.qconnect#SessionDataNamespace", + "traits": { + "smithy.api#documentation": "

The namespace into which the session data is stored. Supported namespaces are:\n Custom

" + } + }, + "data": { + "target": "com.amazonaws.qconnect#RuntimeSessionDataList", + "traits": { + "smithy.api#documentation": "

The data stored on the Amazon Q in Connect Session.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#UpdateSessionDataResponse": { + "type": "structure", + "members": { + "sessionArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the session.

", + "smithy.api#required": {} + } + }, + "sessionId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "

The identifier of the session.

", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.qconnect#SessionDataNamespace", + "traits": { + "smithy.api#documentation": "

The namespace into which the session data is stored. Supported namespaces are:\n Custom

", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.qconnect#RuntimeSessionDataList", + "traits": { + "smithy.api#documentation": "

Data stored in the session.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#UpdateSessionRequest": { "type": "structure", "members": { @@ -7530,6 +10791,12 @@ "traits": { "smithy.api#documentation": "

An object that can be used to specify Tag conditions.

" } + }, + "aiAgentConfiguration": { + "target": "com.amazonaws.qconnect#AIAgentConfigurationMap", + "traits": { + "smithy.api#documentation": "

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that\n should be used by Amazon Q in Connect for this Session.

" + } } }, "traits": { @@ -7575,6 +10842,43 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.qconnect#UrlConfiguration": { + "type": "structure", + "members": { + "seedUrls": { + "target": "com.amazonaws.qconnect#SeedUrls", + "traits": { + "smithy.api#documentation": "

List of URLs for crawling.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the URL/URLs for the web content that you want to crawl. You should\n be authorized to crawl the URLs.

" + } + }, + "com.amazonaws.qconnect#UrlFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#UrlFilterPattern" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.qconnect#UrlFilterPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.qconnect#Uuid": { "type": "string", "traits": { @@ -7587,6 +10891,18 @@ "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" } }, + "com.amazonaws.qconnect#UuidOrArnOrEitherWithQualifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$" + } + }, + "com.amazonaws.qconnect#UuidWithQualifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$" + } + }, "com.amazonaws.qconnect#ValidationException": { "type": "structure", "members": { @@ -7600,6 +10916,49 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.qconnect#VectorIngestionConfiguration": { + "type": "structure", + "members": { + "chunkingConfiguration": { + "target": "com.amazonaws.qconnect#ChunkingConfiguration", + "traits": { + "smithy.api#documentation": "

Details about how to chunk the documents in the data source. A chunk refers to an excerpt\n from a data source that is returned when the knowledge base that it belongs to is\n queried.

" + } + }, + "parsingConfiguration": { + "target": "com.amazonaws.qconnect#ParsingConfiguration", + "traits": { + "smithy.api#documentation": "

A custom parser for data source documents.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about how to ingest the documents in a data source.

" + } + }, + "com.amazonaws.qconnect#Version": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.qconnect#VisibilityStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SAVED", + "name": "SAVED" + }, + { + "value": "PUBLISHED", + "name": "PUBLISHED" + } + ] + } + }, "com.amazonaws.qconnect#WaitTimeSeconds": { "type": "integer", "traits": { @@ -7610,6 +10969,84 @@ } } }, + "com.amazonaws.qconnect#WebCrawlerConfiguration": { + "type": "structure", + "members": { + "urlConfiguration": { + "target": "com.amazonaws.qconnect#UrlConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the URL/URLs for the web content that you want to crawl. You should\n be authorized to crawl the URLs.

", + "smithy.api#required": {} + } + }, + "crawlerLimits": { + "target": "com.amazonaws.qconnect#WebCrawlerLimits", + "traits": { + "smithy.api#documentation": "

The configuration of crawl limits for the web URLs.

" + } + }, + "inclusionFilters": { + "target": "com.amazonaws.qconnect#UrlFilterList", + "traits": { + "smithy.api#documentation": "

A list of one or more inclusion regular expression patterns to include certain URLs. If\n you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion\n filter takes precedence and the web content of the URL isn’t crawled.

" + } + }, + "exclusionFilters": { + "target": "com.amazonaws.qconnect#UrlFilterList", + "traits": { + "smithy.api#documentation": "

A list of one or more exclusion regular expression patterns to exclude certain URLs. If\n you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion\n filter takes precedence and the web content of the URL isn’t crawled.

" + } + }, + "scope": { + "target": "com.amazonaws.qconnect#WebScopeType", + "traits": { + "smithy.api#documentation": "

The scope of what is crawled for your URLs. You can choose to crawl only web pages that\n belong to the same host or primary domain. For example, only web pages that contain the seed\n URL https://docs.aws.amazon.com/bedrock/latest/userguide/ and no other domains.\n You can choose to include sub domains in addition to the host or primary domain. For example,\n web pages that contain aws.amazon.com can also include sub domain\n docs.aws.amazon.com.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details for the web data source.

" + } + }, + "com.amazonaws.qconnect#WebCrawlerLimits": { + "type": "structure", + "members": { + "rateLimit": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Rate of web URLs retrieved per minute.

", + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of crawl limits for the web URLs.

" + } + }, + "com.amazonaws.qconnect#WebScopeType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "HOST_ONLY", + "name": "HOST_ONLY" + }, + { + "value": "SUBDOMAINS", + "name": "SUBDOMAINS" + } + ] + } + }, + "com.amazonaws.qconnect#WebUrl": { + "type": "string", + "traits": { + "smithy.api#pattern": "^https?://[A-Za-z0-9][^\\s]*$" + } + }, "com.amazonaws.qconnect#WisdomService": { "type": "service", "version": "2020-10-19", @@ -7643,7 +11080,7 @@ }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "\n

\n Powered by Amazon Bedrock: Amazon Web Services implements automated abuse\n detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of\n the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of\n artificial intelligence (AI).

\n \n

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced\n evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact\n center agents resolve customer issues quickly and accurately.

\n

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational\n analytics and natural language understanding (NLU). It then provides agents with immediate,\n real-time generative responses and suggested actions, and links to relevant documents and\n articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer\n customer requests.

\n

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.

\n

For more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.

", + "smithy.api#documentation": "\n \n

\n Powered by Amazon Bedrock: Amazon Web Services implements automated abuse\n detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of\n the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of\n artificial intelligence (AI).

\n \n

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced\n evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact\n center agents resolve customer issues quickly and accurately.

\n

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational\n analytics and natural language understanding (NLU). It then provides agents with immediate,\n real-time generative responses and suggested actions, and links to relevant documents and\n articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer\n customer requests.

\n

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or\n manage content by uploading custom files.

\n

For more information, see Use Amazon Q in Connect for generative AI\n powered agent assistance in real-time in the Amazon Connect\n Administrator Guide.

", "smithy.api#title": "Amazon Q Connect", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk/aws-models/quicksight.json b/codegen/sdk/aws-models/quicksight.json index 2a69f098a82..2c804a9d4c0 100644 --- a/codegen/sdk/aws-models/quicksight.json +++ b/codegen/sdk/aws-models/quicksight.json @@ -1456,6 +1456,12 @@ "traits": { "smithy.api#documentation": "

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

" } + }, + "Folders": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobFolderOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that controls how Folder resources are parameterized in the returned CloudFormation template.

" + } } }, "traits": { @@ -1841,6 +1847,69 @@ "target": "com.amazonaws.quicksight#AssetBundleExportJobError" } }, + "com.amazonaws.quicksight#AssetBundleExportJobFolderOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific Folder resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobFolderPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of Folder resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific Folder resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobFolderOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobFolderOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobFolderPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "PARENT_FOLDER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ParentFolderArn" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobFolderPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobFolderPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties": { "type": "structure", "members": { @@ -2700,6 +2769,109 @@ "target": "com.amazonaws.quicksight#AssetBundleImportJobError" } }, + "com.amazonaws.quicksight#AssetBundleImportJobFolderOverrideParameters": { + "type": "structure", + "members": { + "FolderId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder that you want to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the folder.

" + } + }, + "ParentFolderArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single folder that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobFolderOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobFolderOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobFolderOverridePermissions": { + "type": "structure", + "members": { + "FolderIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions" + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of folder IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobFolderOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobFolderOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobFolderOverrideTags": { + "type": "structure", + "members": { + "FolderIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the folders that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of folder IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobFolderOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobFolderOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters": { "type": "structure", "members": { @@ -2750,6 +2922,12 @@ "traits": { "smithy.api#documentation": "

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

" } + }, + "Folders": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobFolderOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any Folder resources that are present in the asset bundle that is imported.

" + } } }, "traits": { @@ -2788,6 +2966,12 @@ "traits": { "smithy.api#documentation": "

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

" } + }, + "Folders": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobFolderOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions for the folders that you want to apply overrides to.

" + } } }, "traits": { @@ -2832,6 +3016,12 @@ "traits": { "smithy.api#documentation": "

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

" } + }, + "Folders": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobFolderOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.

" + } } }, "traits": { @@ -17925,7 +18115,7 @@ } }, "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" } @@ -18162,6 +18352,19 @@ "traits": { "smithy.api#documentation": "

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

\n

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

" } + }, + "IncludeFolderMemberships": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The include folder memberships flag.

" + } + }, + "IncludeFolderMembers": { + "target": "com.amazonaws.quicksight#IncludeFolderMembers", + "traits": { + "smithy.api#documentation": "

A setting that determines whether folder members are included.

" + } } }, "traits": { @@ -18582,7 +18785,7 @@ } }, "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "

A structure that contains the permissions for the dashboard.

" } @@ -20450,6 +20653,87 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeQPersonalizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeQPersonalizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeQPersonalizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a personalization configuration.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/q-personalization-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeQPersonalizationConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeQPersonalizationConfigurationResponse": { + "type": "structure", + "members": { + "PersonalizationMode": { + "target": "com.amazonaws.quicksight#PersonalizationMode", + "traits": { + "smithy.api#documentation": "

A value that indicates whether personalization is enabled or not.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeRefreshSchedule": { "type": "operation", "input": { @@ -21002,7 +21286,7 @@ } }, "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" } @@ -21306,7 +21590,7 @@ } }, "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "

A list of resource permissions set on the theme.

" } @@ -27646,6 +27930,29 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.quicksight#IncludeFolderMembers": { + "type": "enum", + "members": { + "RECURSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECURSE" + } + }, + "ONE_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_LEVEL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.quicksight#IncrementalRefresh": { "type": "structure", "members": { @@ -36483,6 +36790,23 @@ } } }, + "com.amazonaws.quicksight#PersonalizationMode": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.quicksight#PhysicalTable": { "type": "union", "members": { @@ -38319,6 +38643,9 @@ { "target": "com.amazonaws.quicksight#DescribeNamespace" }, + { + "target": "com.amazonaws.quicksight#DescribeQPersonalizationConfiguration" + }, { "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" }, @@ -38508,6 +38835,9 @@ { "target": "com.amazonaws.quicksight#StartDashboardSnapshotJob" }, + { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobSchedule" + }, { "target": "com.amazonaws.quicksight#TagResource" }, @@ -38574,6 +38904,9 @@ { "target": "com.amazonaws.quicksight#UpdatePublicSharingSettings" }, + { + "target": "com.amazonaws.quicksight#UpdateQPersonalizationConfiguration" + }, { "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" }, @@ -41223,6 +41556,12 @@ { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, @@ -41260,6 +41599,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "RestoreToFolders": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that determines if the analysis will be restored to folders that it previously resided in. A True value restores analysis back to all folders that it previously resided in. A False value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to True.

", + "smithy.api#httpQuery": "restore-to-folders" + } } }, "traits": { @@ -41294,6 +41641,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" } + }, + "RestorationFailedFolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

A list of folder arns thatthe analysis failed to be restored to.

" + } } }, "traits": { @@ -45243,6 +45596,19 @@ "traits": { "smithy.api#documentation": "

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

" } + }, + "IncludeFolderMemberships": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of.

" + } + }, + "IncludeFolderMembers": { + "target": "com.amazonaws.quicksight#IncludeFolderMembers", + "traits": { + "smithy.api#documentation": "

A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.

" + } } }, "traits": { @@ -45542,6 +45908,100 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#StartDashboardSnapshotJobSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.

\n

Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.

\n

For more information, see Scheduling and sending Amazon QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the Amazon QuickSight User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#StartDashboardSnapshotJobScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you want to start a snapshot job schedule for.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the Schedules pane of the dashboard that the schedule is configured for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#StartDashboardSnapshotJobScheduleResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#StatePersistenceConfigurations": { "type": "structure", "members": { @@ -48937,6 +49397,20 @@ "target": "com.amazonaws.quicksight#TopicColumn" } }, + "com.amazonaws.quicksight#TopicConfigOptions": { + "type": "structure", + "members": { + "QBusinessInsightsEnabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Enables Amazon Q Business Insights for a Topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for a Topic.

" + } + }, "com.amazonaws.quicksight#TopicConstantValue": { "type": "structure", "members": { @@ -49022,6 +49496,12 @@ "traits": { "smithy.api#documentation": "

The data sets that the topic is associated with.

" } + }, + "ConfigOptions": { + "target": "com.amazonaws.quicksight#TopicConfigOptions", + "traits": { + "smithy.api#documentation": "

Configuration options for a Topic.

" + } } }, "traits": { @@ -51452,7 +51932,7 @@ } }, "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" } @@ -51826,7 +52306,7 @@ } }, "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "

Information about the permissions on the dashboard.

" } @@ -53441,6 +53921,97 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateQPersonalizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateQPersonalizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateQPersonalizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a personalization configuration.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/q-personalization-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateQPersonalizationConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PersonalizationMode": { + "target": "com.amazonaws.quicksight#PersonalizationMode", + "traits": { + "smithy.api#documentation": "

An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateQPersonalizationConfigurationResponse": { + "type": "structure", + "members": { + "PersonalizationMode": { + "target": "com.amazonaws.quicksight#PersonalizationMode", + "traits": { + "smithy.api#documentation": "

The personalization mode that is used for the personalization configuration.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateRefreshSchedule": { "type": "operation", "input": { @@ -53973,7 +54544,7 @@ } }, "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" } @@ -54339,7 +54910,7 @@ } }, "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "

The resulting list of resource permissions for the theme.

" } diff --git a/codegen/sdk/aws-models/rds-data.json b/codegen/sdk/aws-models/rds-data.json index 16cdd4cdd46..4f627530b2d 100644 --- a/codegen/sdk/aws-models/rds-data.json +++ b/codegen/sdk/aws-models/rds-data.json @@ -267,7 +267,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a SQL transaction.

\n \n

A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24\n hours.

\n

A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's\n committed, it's rolled back automatically.

\n

DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate\n ExecuteStatement call with continueAfterTimeout enabled.

\n ", + "smithy.api#documentation": "

Starts a SQL transaction.

\n \n

A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24\n hours.

\n

A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's\n committed, it's rolled back automatically.

\n

For Aurora MySQL, DDL statements inside a transaction cause an implicit commit. We recommend that you run each MySQL DDL statement in a separate\n ExecuteStatement call with continueAfterTimeout enabled.

\n ", "smithy.api#http": { "code": 200, "method": "POST", @@ -661,7 +661,7 @@ "message": "The ExecuteSql API is deprecated, please use the ExecuteStatement API.", "since": "2019-03-21" }, - "smithy.api#documentation": "

Runs one or more SQL statements.

\n \n

This operation isn't supported for Aurora PostgreSQL Serverless v2 and provisioned DB clusters, and for Aurora Serverless v1 DB clusters, \n the operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

\n ", + "smithy.api#documentation": "

Runs one or more SQL statements.

\n \n

This operation isn't supported for Aurora Serverless v2 and provisioned DB clusters.\n For Aurora Serverless v1 DB clusters, the operation is deprecated.\n Use the BatchExecuteStatement or ExecuteStatement operation.

\n ", "smithy.api#http": { "code": 200, "method": "POST", @@ -1115,7 +1115,7 @@ }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "RDS Data API\n

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these\n statements, you use the RDS Data API (Data API).

\n

Data API is available with the following types of Aurora databases:

\n
    \n
  • \n

    Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned

    \n
    • \n
  • \n

    Aurora MySQL - Serverless v1 only

    \n
    • \n
\n

For more information about the Data API, see\n Using RDS Data API\n in the Amazon Aurora User Guide.

", + "smithy.api#documentation": "RDS Data API\n

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these\n statements, you use the RDS Data API (Data API).

\n

Data API is available with the following types of Aurora databases:

\n
    \n
  • \n

    Aurora PostgreSQL - Serverless v2, provisioned, and Serverless v1

    \n
    • \n
  • \n

    Aurora MySQL - Serverless v2, provisioned, and Serverless v1

    \n
    • \n
\n

For more information about the Data API, see\n Using RDS Data API\n in the Amazon Aurora User Guide.

", "smithy.api#title": "AWS RDS DataService", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index ac11e3e4703..0a50d4fb3ca 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -2982,6 +2982,23 @@ "smithy.api#documentation": "

This data type is used as a response element in the ModifyDBCluster operation and \n contains changes that will be applied during the next maintenance window.

" } }, + "com.amazonaws.rds#ClusterScalabilityType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "standard" + } + }, + "LIMITLESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "limitless" + } + } + } + }, "com.amazonaws.rds#ConnectionPoolConfiguration": { "type": "structure", "members": { @@ -4307,7 +4324,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see IAM Database\n Authentication in the Amazon Aurora User Guide or\n IAM database\n authentication for MariaDB, MySQL, and PostgreSQL in the Amazon\n RDS User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "BacktrackWindow": { @@ -4463,6 +4480,12 @@ "smithy.api#documentation": "

The network type of the DB cluster.

\n

The network type is determined by the DBSubnetGroup specified for the DB cluster. \n A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 \n protocols (DUAL).

\n

For more information, see \n Working with a DB instance in a VPC in the \n Amazon Aurora User Guide.\n

\n

Valid for Cluster Type: Aurora DB clusters only

\n

Valid Values: IPV4 | DUAL\n

" } }, + "ClusterScalabilityType": { + "target": "com.amazonaws.rds#ClusterScalabilityType", + "traits": { + "smithy.api#documentation": "

Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database.\n When set to standard (the default), the cluster uses normal DB instance creation.

\n

Valid for: Aurora DB clusters only

\n \n

You can't modify this setting after you create the DB cluster.

\n " + } + }, "DBSystemId": { "target": "com.amazonaws.rds#String", "traits": { @@ -6090,6 +6113,9 @@ { "target": "com.amazonaws.rds#MaxDBShardGroupLimitReached" }, + { + "target": "com.amazonaws.rds#NetworkTypeNotSupported" + }, { "target": "com.amazonaws.rds#UnsupportedDBEngineVersionFault" } @@ -6142,6 +6168,9 @@ "traits": { "smithy.api#documentation": "

Specifies whether the DB shard group is publicly accessible.

\n

When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from \n within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. \n Access to the DB shard group is ultimately controlled by the security group it uses. \n That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.

\n

When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.

\n

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

\n

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.

    \n
    • \n
  • \n

    If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.

    \n
    • \n
\n

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

\n
    \n
  • \n

    If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.

    \n
    • \n
  • \n

    If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.

    \n
    • \n
" } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" } }, "traits": { @@ -7535,6 +7564,12 @@ "smithy.api#documentation": "

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

\n

This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, + "ClusterScalabilityType": { + "target": "com.amazonaws.rds#ClusterScalabilityType", + "traits": { + "smithy.api#documentation": "

The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database.\n When set to standard (the default), the cluster uses normal DB instance creation.

" + } + }, "CertificateDetails": { "target": "com.amazonaws.rds#CertificateDetails" }, @@ -11140,6 +11175,9 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the DB shard group.

" } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" } } }, @@ -12723,7 +12761,7 @@ "target": "com.amazonaws.rds#DBShardGroupIdentifier", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Teh name of the DB shard group to delete.

", + "smithy.api#documentation": "

The name of the DB shard group to delete.

", "smithy.api#required": {} } } @@ -15907,7 +15945,7 @@ "DBShardGroupIdentifier": { "target": "com.amazonaws.rds#DBShardGroupIdentifier", "traits": { - "smithy.api#documentation": "

The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified, \n information for only the specific DB shard group is returned. This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DB shard group identifier.

    \n
    • \n
" + "smithy.api#documentation": "

The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. \n This parameter isn't case-sensitive.

\n

Constraints:

\n
    \n
  • \n

    If supplied, must match an existing DB shard group identifier.

    \n
    • \n
" } }, "Filters": { @@ -21616,7 +21654,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for Cluster Type: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see IAM Database\n Authentication in the Amazon Aurora User Guide or\n IAM database\n authentication for MariaDB, MySQL, and PostgreSQL in the Amazon\n RDS User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "BacktrackWindow": { @@ -21736,7 +21774,7 @@ "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Multi-AZ DB clusters only

" + "smithy.api#documentation": "

Specifies whether to turn on Performance Insights for the DB cluster.

\n

For more information, see \n Using Amazon Performance Insights in the Amazon RDS User Guide.

\n

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

" } }, "PerformanceInsightsKMSKeyId": { @@ -27263,7 +27301,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see IAM Database\n Authentication in the Amazon Aurora User Guide or\n IAM database\n authentication for MariaDB, MySQL, and PostgreSQL in the Amazon\n RDS User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "BacktrackWindow": { @@ -27586,7 +27624,7 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see \n \n IAM Database Authentication in the Amazon Aurora User Guide.

\n

Valid for: Aurora DB clusters only

" + "smithy.api#documentation": "

Specifies whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping isn't\n enabled.

\n

For more information, see IAM Database\n Authentication in the Amazon Aurora User Guide or\n IAM database\n authentication for MariaDB, MySQL, and PostgreSQL in the Amazon\n RDS User Guide.

\n

Valid for: Aurora DB clusters and Multi-AZ DB clusters

" } }, "BacktrackWindow": { @@ -30601,7 +30639,7 @@ "target": "com.amazonaws.rds#BlueGreenDeploymentIdentifier", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The unique identifier of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment identifier.

    \n
    • \n
", + "smithy.api#documentation": "

The resource ID of the blue/green deployment.

\n

Constraints:

\n
    \n
  • \n

    Must match an existing blue/green deployment resource ID.

    \n
    • \n
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/redshift.json b/codegen/sdk/aws-models/redshift.json index 3c33c7abb7a..673acc0057a 100644 --- a/codegen/sdk/aws-models/redshift.json +++ b/codegen/sdk/aws-models/redshift.json @@ -2814,7 +2814,7 @@ "target": "com.amazonaws.redshift#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The node type to be provisioned for the cluster. For information about node types,\n go to Working with\n Clusters in the Amazon Redshift Cluster Management Guide.

\n

Valid Values: \n dc2.large | dc2.8xlarge | \n ra3.xlplus | ra3.4xlarge | ra3.16xlarge\n

", + "smithy.api#documentation": "

The node type to be provisioned for the cluster. For information about node types,\n go to Working with\n Clusters in the Amazon Redshift Cluster Management Guide.

\n

Valid Values: \n dc2.large | dc2.8xlarge | \n ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge\n

", "smithy.api#required": {} } }, @@ -3814,6 +3814,103 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#CreateIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#CreateIntegrationMessage" + }, + "output": { + "target": "com.amazonaws.redshift#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#IntegrationAlreadyExistsFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationQuotaExceededFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationSourceNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationTargetNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.redshift#InvalidTagFault" + }, + { + "target": "com.amazonaws.redshift#TagLimitExceededFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a zero-ETL integration with Amazon Redshift.

" + } + }, + "com.amazonaws.redshift#CreateIntegrationMessage": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database to use as the source for replication.

", + "smithy.api#required": {} + } + }, + "TargetArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

", + "smithy.api#required": {} + } + }, + "IntegrationName": { + "target": "com.amazonaws.redshift#IntegrationName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The name of the integration.

", + "smithy.api#required": {} + } + }, + "KMSKeyId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

An Key Management Service (KMS) key identifier for the key to use to\n encrypt the integration. If you don't specify an encryption key, the default\n Amazon Web Services owned key is used.

" + } + }, + "TagList": { + "target": "com.amazonaws.redshift#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.redshift#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

An optional set of non-secret key–value pairs that contains additional contextual\n information about the data. For more information, see Encryption\n context in the Amazon Web Services Key Management Service Developer\n Guide.

\n

You can only include this parameter if you specify the KMSKeyId parameter.

" + } + }, + "Description": { + "target": "com.amazonaws.redshift#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A description of the integration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.redshift#CreateRedshiftIdcApplication": { "type": "operation", "input": { @@ -5252,6 +5349,48 @@ "smithy.api#input": {} } }, + "com.amazonaws.redshift#DeleteIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DeleteIntegrationMessage" + }, + "output": { + "target": "com.amazonaws.redshift#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationConflictStateFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a zero-ETL integration with Amazon Redshift.

" + } + }, + "com.amazonaws.redshift#DeleteIntegrationMessage": { + "type": "structure", + "members": { + "IntegrationArn": { + "target": "com.amazonaws.redshift#IntegrationArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the integration to delete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.redshift#DeletePartner": { "type": "operation", "input": { @@ -7216,6 +7355,135 @@ "smithy.api#input": {} } }, + "com.amazonaws.redshift#DescribeIntegrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DescribeIntegrationsMessage" + }, + "output": { + "target": "com.amazonaws.redshift#IntegrationsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Describes one or more zero-ETL integrations with Amazon Redshift.

", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Integrations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.redshift#DescribeIntegrationsFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.redshift#DescribeIntegrationsFilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the type of integration filter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.redshift#DescribeIntegrationsFilterValueList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies the values to filter on.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of elements to filter the returned integrations.

" + } + }, + "com.amazonaws.redshift#DescribeIntegrationsFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#DescribeIntegrationsFilter", + "traits": { + "smithy.api#xmlName": "DescribeIntegrationsFilter" + } + } + }, + "com.amazonaws.redshift#DescribeIntegrationsFilterName": { + "type": "enum", + "members": { + "INTEGRATION_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "integration-arn" + } + }, + "SOURCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "source-arn" + } + }, + "SOURCE_TYPES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "source-types" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "status" + } + } + } + }, + "com.amazonaws.redshift#DescribeIntegrationsFilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.redshift#DescribeIntegrationsMessage": { + "type": "structure", + "members": { + "IntegrationArn": { + "target": "com.amazonaws.redshift#IntegrationArn", + "traits": { + "smithy.api#documentation": "

The unique identifier of the integration.

" + } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.

\n

Default: 100\n

\n

Constraints: minimum 20, maximum 100.

" + } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

An optional pagination token provided by a previous DescribeIntegrations\n request. If this parameter is specified, the response includes only records beyond the\n marker, up to the value specified by MaxRecords.

" + } + }, + "Filters": { + "target": "com.amazonaws.redshift#DescribeIntegrationsFilterList", + "traits": { + "smithy.api#documentation": "

A filter that specifies one or more resources to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.redshift#DescribeLoggingStatus": { "type": "operation", "input": { @@ -8117,7 +8385,7 @@ "ResourceType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The type of resource with which you want to view tags. Valid resource types are:

\n
    \n
  • \n

    Cluster

    \n
    • \n
  • \n

    CIDR/IP

    \n
    • \n
  • \n

    EC2 security group

    \n
    • \n
  • \n

    Snapshot

    \n
    • \n
  • \n

    Cluster security group

    \n
    • \n
  • \n

    Subnet group

    \n
    • \n
  • \n

    HSM connection

    \n
    • \n
  • \n

    HSM certificate

    \n
    • \n
  • \n

    Parameter group

    \n
    • \n
  • \n

    Snapshot copy grant

    \n
    • \n
\n

For more information about Amazon Redshift resource types and constructing ARNs, go to\n Specifying Policy Elements: Actions, Effects, Resources, and Principals in\n the Amazon Redshift Cluster Management Guide.

" + "smithy.api#documentation": "

The type of resource with which you want to view tags. Valid resource types are:

\n
    \n
  • \n

    Cluster

    \n
    • \n
  • \n

    CIDR/IP

    \n
    • \n
  • \n

    EC2 security group

    \n
    • \n
  • \n

    Snapshot

    \n
    • \n
  • \n

    Cluster security group

    \n
    • \n
  • \n

    Subnet group

    \n
    • \n
  • \n

    HSM connection

    \n
    • \n
  • \n

    HSM certificate

    \n
    • \n
  • \n

    Parameter group

    \n
    • \n
  • \n

    Snapshot copy grant

    \n
    • \n
  • \n

    Integration (zero-ETL integration)

    \n \n

    To describe the tags associated with an integration, don't specify ResourceType, \n instead specify the ResourceName of the integration.

    \n     \n
    • \n
\n

For more information about Amazon Redshift resource types and constructing ARNs, go to\n Specifying Policy Elements: Actions, Effects, Resources, and Principals in\n the Amazon Redshift Cluster Management Guide.

" } }, "MaxRecords": { @@ -8226,6 +8494,16 @@ "smithy.api#input": {} } }, + "com.amazonaws.redshift#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^.*$" + } + }, "com.amazonaws.redshift#DisableLogging": { "type": "operation", "input": { @@ -8506,9 +8784,9 @@ } }, "S3KeyPrefix": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#S3KeyPrefixValue", "traits": { - "smithy.api#documentation": "

The prefix applied to the log file names.

\n

Constraints:

\n
    \n
  • \n

    Cannot exceed 512 characters

    \n
    • \n
  • \n

    Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash\n (\\), or control characters. The hexadecimal codes for invalid characters are:

    \n
      \n
    • \n

      x00 to x20

      \n
      • \n
    • \n

      x22

      \n
      • \n
    • \n

      x27

      \n
      • \n
    • \n

      x5c

      \n
      • \n
    • \n

      x7f or larger

      \n
      • \n
    \n
    • \n
" + "smithy.api#documentation": "

The prefix applied to the log file names.

\n

Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: \n underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (\\),\n hyphen (-), at symbol (@).

" } }, "LogDestinationType": { @@ -8630,6 +8908,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#EncryptionContextMap": { + "type": "map", + "key": { + "target": "com.amazonaws.redshift#String" + }, + "value": { + "target": "com.amazonaws.redshift#String" + } + }, "com.amazonaws.redshift#Endpoint": { "type": "structure", "members": { @@ -10172,6 +10459,148 @@ "com.amazonaws.redshift#IntegerOptional": { "type": "integer" }, + "com.amazonaws.redshift#Integration": { + "type": "structure", + "members": { + "IntegrationArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the integration.

" + } + }, + "IntegrationName": { + "target": "com.amazonaws.redshift#IntegrationName", + "traits": { + "smithy.api#documentation": "

The name of the integration.

" + } + }, + "SourceArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the database used as the source for\n replication.

" + } + }, + "TargetArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

" + } + }, + "Status": { + "target": "com.amazonaws.redshift#ZeroETLIntegrationStatus", + "traits": { + "smithy.api#documentation": "

The current status of the integration.

" + } + }, + "Errors": { + "target": "com.amazonaws.redshift#IntegrationErrorList", + "traits": { + "smithy.api#documentation": "

Any errors associated with the integration.

" + } + }, + "CreateTime": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "

The time (UTC) when the integration was created.

" + } + }, + "Description": { + "target": "com.amazonaws.redshift#Description", + "traits": { + "smithy.api#documentation": "

The description of the integration.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

The Key Management Service (KMS) key identifier for the key used to\n encrypt the integration.

" + } + }, + "AdditionalEncryptionContext": { + "target": "com.amazonaws.redshift#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "

The encryption context for the integration. For more information, \n see Encryption context in the Amazon Web Services Key Management Service Developer\n Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.redshift#TagList", + "traits": { + "smithy.api#documentation": "

The list of tags associated with the integration.

" + } + } + } + }, + "com.amazonaws.redshift#IntegrationAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The integration you are trying to create already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshift#IntegrationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:redshift:[a-z0-9\\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.redshift#IntegrationConflictOperationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationConflictOperationFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A conflicting conditional operation is currently in progress against this resource.\n This typically occurs when there are multiple requests being made to the same resource at the same time,\n and these requests conflict with each other.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshift#IntegrationConflictStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationConflictStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The integration is in an invalid state and can't perform the requested operation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshift#IntegrationDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + }, + "smithy.api#pattern": "^.*$" + } + }, "com.amazonaws.redshift#IntegrationError": { "type": "structure", "members": { @@ -10203,6 +10632,25 @@ } } }, + "com.amazonaws.redshift#IntegrationList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#Integration", + "traits": { + "smithy.api#xmlName": "Integration" + } + } + }, + "com.amazonaws.redshift#IntegrationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, "com.amazonaws.redshift#IntegrationNotFoundFault": { "type": "structure", "members": { @@ -10220,6 +10668,77 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.redshift#IntegrationQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

You can't create any more zero-ETL integrations because the quota has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshift#IntegrationSourceNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationSourceNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified integration source can't be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.redshift#IntegrationTargetNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "IntegrationTargetNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

The specified integration target can't be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.redshift#IntegrationsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "

A value that indicates the starting point for the next set of response records in a subsequent request. \n If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. \n If the Marker field is empty, all response records have been retrieved for the request.

" + } + }, + "Integrations": { + "target": "com.amazonaws.redshift#IntegrationList", + "traits": { + "smithy.api#documentation": "

List of integrations that are described.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.redshift#InvalidAuthenticationProfileRequestFault": { "type": "structure", "members": { @@ -10934,7 +11453,7 @@ } }, "S3KeyPrefix": { - "target": "com.amazonaws.redshift#String", + "target": "com.amazonaws.redshift#S3KeyPrefixValue", "traits": { "smithy.api#documentation": "

The prefix applied to the log file names.

" } @@ -11453,7 +11972,7 @@ "NodeType": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "

The new node type of the cluster. If you specify a new node type, you must also\n specify the number of nodes parameter.

\n

\nFor more information about resizing clusters, go to \nResizing Clusters in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.

\n

Valid Values: \n dc2.large | dc2.8xlarge | \n ra3.xlplus | ra3.4xlarge | ra3.16xlarge\n

" + "smithy.api#documentation": "

The new node type of the cluster. If you specify a new node type, you must also\n specify the number of nodes parameter.

\n

\nFor more information about resizing clusters, go to \nResizing Clusters in Amazon Redshift \nin the Amazon Redshift Cluster Management Guide.

\n

Valid Values: \n dc2.large | dc2.8xlarge | \n ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge\n

" } }, "NumberOfNodes": { @@ -12110,6 +12629,63 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#ModifyIntegration": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#ModifyIntegrationMessage" + }, + "output": { + "target": "com.amazonaws.redshift#Integration" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#IntegrationAlreadyExistsFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationConflictOperationFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationConflictStateFault" + }, + { + "target": "com.amazonaws.redshift#IntegrationNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies a zero-ETL integration with Amazon Redshift.

" + } + }, + "com.amazonaws.redshift#ModifyIntegrationMessage": { + "type": "structure", + "members": { + "IntegrationArn": { + "target": "com.amazonaws.redshift#IntegrationArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The unique identifier of the integration to modify.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.redshift#IntegrationDescription", + "traits": { + "smithy.api#documentation": "

A new description for the integration.

" + } + }, + "IntegrationName": { + "target": "com.amazonaws.redshift#IntegrationName", + "traits": { + "smithy.api#documentation": "

A new name for the integration.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.redshift#ModifyRedshiftIdcApplication": { "type": "operation", "input": { @@ -13754,6 +14330,9 @@ { "target": "com.amazonaws.redshift#CreateHsmConfiguration" }, + { + "target": "com.amazonaws.redshift#CreateIntegration" + }, { "target": "com.amazonaws.redshift#CreateRedshiftIdcApplication" }, @@ -13808,6 +14387,9 @@ { "target": "com.amazonaws.redshift#DeleteHsmConfiguration" }, + { + "target": "com.amazonaws.redshift#DeleteIntegration" + }, { "target": "com.amazonaws.redshift#DeletePartner" }, @@ -13904,6 +14486,9 @@ { "target": "com.amazonaws.redshift#DescribeInboundIntegrations" }, + { + "target": "com.amazonaws.redshift#DescribeIntegrations" + }, { "target": "com.amazonaws.redshift#DescribeLoggingStatus" }, @@ -14027,6 +14612,9 @@ { "target": "com.amazonaws.redshift#ModifyEventSubscription" }, + { + "target": "com.amazonaws.redshift#ModifyIntegration" + }, { "target": "com.amazonaws.redshift#ModifyRedshiftIdcApplication" }, @@ -15789,7 +16377,7 @@ } ], "traits": { - "smithy.api#documentation": "

Changes the size of the cluster. You can change the cluster's type, or change the\n number or type of nodes. The default behavior is to use the elastic resize method. With\n an elastic resize, your cluster is available for read and write operations more quickly\n than with the classic resize method.

\n

Elastic resize operations have the following restrictions:

\n
    \n
  • \n

    You can only resize clusters of the following types:

    \n
      \n
    • \n

      dc2.large

      \n
      • \n
    • \n

      dc2.8xlarge

      \n
      • \n
    • \n

      ra3.xlplus

      \n
      • \n
    • \n

      ra3.4xlarge

      \n
      • \n
    • \n

      ra3.16xlarge

      \n
      • \n
    \n
    • \n
  • \n

    The type of nodes that you add must match the node type for the\n cluster.

    \n
    • \n
" + "smithy.api#documentation": "

Changes the size of the cluster. You can change the cluster's type, or change the\n number or type of nodes. The default behavior is to use the elastic resize method. With\n an elastic resize, your cluster is available for read and write operations more quickly\n than with the classic resize method.

\n

Elastic resize operations have the following restrictions:

\n
    \n
  • \n

    You can only resize clusters of the following types:

    \n
      \n
    • \n

      dc2.large

      \n
      • \n
    • \n

      dc2.8xlarge

      \n
      • \n
    • \n

      ra3.large

      \n
      • \n
    • \n

      ra3.xlplus

      \n
      • \n
    • \n

      ra3.4xlarge

      \n
      • \n
    • \n

      ra3.16xlarge

      \n
      • \n
    \n
    • \n
  • \n

    The type of nodes that you add must match the node type for the\n cluster.

    \n
    • \n
" } }, "com.amazonaws.redshift#ResizeClusterMessage": { @@ -16912,6 +17500,16 @@ "smithy.api#output": {} } }, + "com.amazonaws.redshift#S3KeyPrefixValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" + } + }, "com.amazonaws.redshift#SNSInvalidTopicFault": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/resiliencehub.json b/codegen/sdk/aws-models/resiliencehub.json index fd69f005fae..e15e88b48c5 100644 --- a/codegen/sdk/aws-models/resiliencehub.json +++ b/codegen/sdk/aws-models/resiliencehub.json @@ -319,30 +319,38 @@ } }, "com.amazonaws.resiliencehub#AlarmType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Metric", - "name": "METRIC" - }, - { - "value": "Composite", - "name": "COMPOSITE" - }, - { - "value": "Canary", - "name": "CANARY" - }, - { - "value": "Logs", - "name": "LOGS" - }, - { - "value": "Event", - "name": "EVENT" + "type": "enum", + "members": { + "METRIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Metric" + } + }, + "COMPOSITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Composite" + } + }, + "CANARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Canary" + } + }, + "LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Logs" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Event" } - ] + } } }, "com.amazonaws.resiliencehub#App": { @@ -459,6 +467,12 @@ "traits": { "smithy.api#documentation": "

Recovery Point Objective (RPO) in seconds.

" } + }, + "awsApplicationArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.

" + } } }, "traits": { @@ -582,7 +596,7 @@ "summary": { "target": "com.amazonaws.resiliencehub#AssessmentSummary", "traits": { - "smithy.api#documentation": "

Indicates a concise summary that provides an overview of the Resilience Hub assessment.

" + "smithy.api#documentation": "

Indicates the AI-generated summary for the Resilience Hub assessment, providing a concise overview that highlights the top risks and recommendations.

\n \n

This property is available only in the US East (N. Virginia) Region.

\n " } } }, @@ -591,18 +605,20 @@ } }, "com.amazonaws.resiliencehub#AppAssessmentScheduleType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Disabled", - "name": "DISABLED" - }, - { - "value": "Daily", - "name": "DAILY" + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Disabled" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Daily" } - ] + } } }, "com.amazonaws.resiliencehub#AppAssessmentSummary": { @@ -707,34 +723,44 @@ } }, "com.amazonaws.resiliencehub#AppComplianceStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PolicyBreached", - "name": "POLICY_BREACHED" - }, - { - "value": "PolicyMet", - "name": "POLICY_MET" - }, - { - "value": "NotAssessed", - "name": "NOT_ASSESSED" - }, - { - "value": "ChangesDetected", - "name": "CHANGES_DETECTED" - }, - { - "value": "NotApplicable", - "name": "NOT_APPLICABLE" - }, - { - "value": "MissingPolicy", - "name": "MISSING_POLICY" + "type": "enum", + "members": { + "POLICY_BREACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PolicyBreached" + } + }, + "POLICY_MET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PolicyMet" + } + }, + "NOT_ASSESSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotAssessed" + } + }, + "CHANGES_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangesDetected" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotApplicable" + } + }, + "MISSING_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingPolicy" } - ] + } } }, "com.amazonaws.resiliencehub#AppComponent": { @@ -828,22 +854,26 @@ } }, "com.amazonaws.resiliencehub#AppDriftStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NotChecked", - "name": "NOT_CHECKED" - }, - { - "value": "NotDetected", - "name": "NOT_DETECTED" - }, - { - "value": "Detected", - "name": "DETECTED" + "type": "enum", + "members": { + "NOT_CHECKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotChecked" + } + }, + "NOT_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotDetected" } - ] + }, + "DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Detected" + } + } } }, "com.amazonaws.resiliencehub#AppInputSource": { @@ -899,18 +929,20 @@ } }, "com.amazonaws.resiliencehub#AppStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "ACTIVE" - }, - { - "value": "Deleting", - "name": "DELETING" + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" } - ] + } } }, "com.amazonaws.resiliencehub#AppSummary": { @@ -991,6 +1023,12 @@ "traits": { "smithy.api#documentation": "

Recovery Point Objective (RPO) in seconds.

" } + }, + "awsApplicationArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.

" + } } }, "traits": { @@ -1074,18 +1112,20 @@ } }, "com.amazonaws.resiliencehub#AssessmentInvoker": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "User", - "name": "USER" - }, - { - "value": "System", - "name": "SYSTEM" + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "User" + } + }, + "SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "System" } - ] + } } }, "com.amazonaws.resiliencehub#AssessmentRiskRecommendation": { @@ -1121,26 +1161,32 @@ } }, "com.amazonaws.resiliencehub#AssessmentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "INPROGRESS" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Success", - "name": "SUCCESS" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + } } }, "com.amazonaws.resiliencehub#AssessmentStatusList": { @@ -2400,8 +2446,7 @@ "item": { "target": "com.amazonaws.resiliencehub#UpdateRecommendationStatusItem", "traits": { - "smithy.api#documentation": "

The operational recommendation item.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The operational recommendation item.

" } }, "excluded": { @@ -2510,26 +2555,32 @@ } }, "com.amazonaws.resiliencehub#ComplianceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PolicyBreached", - "name": "POLICY_BREACHED" - }, - { - "value": "PolicyMet", - "name": "POLICY_MET" - }, - { - "value": "NotApplicable", - "name": "NOT_APPLICABLE" - }, - { - "value": "MissingPolicy", - "name": "MISSING_POLICY" + "type": "enum", + "members": { + "POLICY_BREACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PolicyBreached" + } + }, + "POLICY_MET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PolicyMet" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotApplicable" + } + }, + "MISSING_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingPolicy" } - ] + } } }, "com.amazonaws.resiliencehub#ComponentCompliancesList": { @@ -2651,34 +2702,44 @@ } }, "com.amazonaws.resiliencehub#ConfigRecommendationOptimizationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LeastCost", - "name": "LEAST_COST" - }, - { - "value": "LeastChange", - "name": "LEAST_CHANGE" - }, - { - "value": "BestAZRecovery", - "name": "BEST_AZ_RECOVERY" - }, - { - "value": "LeastErrors", - "name": "LEAST_ERRORS" - }, - { - "value": "BestAttainable", - "name": "BEST_ATTAINABLE" - }, - { - "value": "BestRegionRecovery", - "name": "BEST_REGION_RECOVERY" + "type": "enum", + "members": { + "LEAST_COST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LeastCost" + } + }, + "LEAST_CHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LeastChange" + } + }, + "BEST_AZ_RECOVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BestAZRecovery" } - ] + }, + "LEAST_ERRORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LeastErrors" + } + }, + "BEST_ATTAINABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BestAttainable" + } + }, + "BEST_REGION_RECOVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BestRegionRecovery" + } + } } }, "com.amazonaws.resiliencehub#ConflictException": { @@ -2737,26 +2798,32 @@ } }, "com.amazonaws.resiliencehub#CostFrequency": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Hourly", - "name": "HOURLY" - }, - { - "value": "Daily", - "name": "DAILY" - }, - { - "value": "Monthly", - "name": "MONTHLY" - }, - { - "value": "Yearly", - "name": "YEARLY" + "type": "enum", + "members": { + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hourly" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Daily" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Monthly" + } + }, + "YEARLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Yearly" } - ] + } } }, "com.amazonaws.resiliencehub#CreateApp": { @@ -2851,6 +2918,12 @@ "traits": { "smithy.api#documentation": "

The list of events you would like to subscribe and get notification for. Currently,\n Resilience Hub supports only Drift detected and\n Scheduled assessment failure events notification.

" } + }, + "awsApplicationArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.

" + } } } }, @@ -3335,22 +3408,26 @@ } }, "com.amazonaws.resiliencehub#DataLocationConstraint": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AnyLocation", - "name": "ANY_LOCATION" - }, - { - "value": "SameContinent", - "name": "SAME_CONTINENT" - }, - { - "value": "SameCountry", - "name": "SAME_COUNTRY" + "type": "enum", + "members": { + "ANY_LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AnyLocation" + } + }, + "SAME_CONTINENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SameContinent" } - ] + }, + "SAME_COUNTRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SameCountry" + } + } } }, "com.amazonaws.resiliencehub#DeleteApp": { @@ -4579,7 +4656,13 @@ "errorMessage": { "target": "com.amazonaws.resiliencehub#String500", "traits": { - "smithy.api#documentation": "

The returned error message for the request.

" + "smithy.api#documentation": "

The error message returned for the resource request.

" + } + }, + "errorDetails": { + "target": "com.amazonaws.resiliencehub#ErrorDetailList", + "traits": { + "smithy.api#documentation": "

List of errors that were encountered while importing resources.

" } } } @@ -4726,22 +4809,26 @@ } }, "com.amazonaws.resiliencehub#DifferenceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NotEqual", - "name": "NOT_EQUAL" - }, - { - "value": "Added", - "name": "ADDED" - }, - { - "value": "Removed", - "name": "REMOVED" + "type": "enum", + "members": { + "NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotEqual" + } + }, + "ADDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Added" + } + }, + "REMOVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Removed" } - ] + } } }, "com.amazonaws.resiliencehub#DisruptionCompliance": { @@ -4836,26 +4923,32 @@ } }, "com.amazonaws.resiliencehub#DisruptionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Software", - "name": "SOFTWARE" - }, - { - "value": "Hardware", - "name": "HARDWARE" - }, - { - "value": "AZ", - "name": "AZ" - }, - { - "value": "Region", - "name": "REGION" + "type": "enum", + "members": { + "SOFTWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Software" + } + }, + "HARDWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hardware" + } + }, + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Region" } - ] + } } }, "com.amazonaws.resiliencehub#DocumentName": { @@ -4874,37 +4967,43 @@ } }, "com.amazonaws.resiliencehub#DriftStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "NotChecked", - "name": "NOT_CHECKED" - }, - { - "value": "NotDetected", - "name": "NOT_DETECTED" - }, - { - "value": "Detected", - "name": "DETECTED" + "type": "enum", + "members": { + "NOT_CHECKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotChecked" + } + }, + "NOT_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotDetected" + } + }, + "DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Detected" } - ] + } } }, "com.amazonaws.resiliencehub#DriftType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ApplicationCompliance", - "name": "APPLICATION_COMPLIANCE" - }, - { - "value": "AppComponentResiliencyComplianceStatus", - "name": "APP_COMPONENT_RESILIENCY_COMPLIANCE_STATUS" + "type": "enum", + "members": { + "APPLICATION_COMPLIANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApplicationCompliance" } - ] + }, + "APP_COMPONENT_RESILIENCY_COMPLIANCE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AppComponentResiliencyComplianceStatus" + } + } } }, "com.amazonaws.resiliencehub#EksNamespace": { @@ -5012,36 +5111,62 @@ "smithy.api#pattern": "^\\S{1,50}$" } }, - "com.amazonaws.resiliencehub#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 + "com.amazonaws.resiliencehub#ErrorDetail": { + "type": "structure", + "members": { + "errorMessage": { + "target": "com.amazonaws.resiliencehub#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Provides additional information about the error.

" + } } + }, + "traits": { + "smithy.api#documentation": "

Indicates the error that was encountered while importing a resource.

" } }, - "com.amazonaws.resiliencehub#EstimatedCostTier": { + "com.amazonaws.resiliencehub#ErrorDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.resiliencehub#ErrorDetail" + } + }, + "com.amazonaws.resiliencehub#ErrorMessage": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "L1", - "name": "L1" - }, - { - "value": "L2", - "name": "L2" - }, - { - "value": "L3", - "name": "L3" - }, - { - "value": "L4", - "name": "L4" + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.resiliencehub#EstimatedCostTier": { + "type": "enum", + "members": { + "L1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "L1" + } + }, + "L2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "L2" + } + }, + "L3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "L3" + } + }, + "L4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "L4" } - ] + } } }, "com.amazonaws.resiliencehub#EventSubscription": { @@ -5085,37 +5210,43 @@ } }, "com.amazonaws.resiliencehub#EventType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ScheduledAssessmentFailure", - "name": "SCHEDULED_ASSESSMENT_FAILURE" - }, - { - "value": "DriftDetected", - "name": "DRIFT_DETECTED" + "type": "enum", + "members": { + "SCHEDULED_ASSESSMENT_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ScheduledAssessmentFailure" + } + }, + "DRIFT_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DriftDetected" } - ] + } } }, "com.amazonaws.resiliencehub#ExcludeRecommendationReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AlreadyImplemented", - "name": "ALREADY_IMPLEMENTED" - }, - { - "value": "NotRelevant", - "name": "NOT_RELEVANT" - }, - { - "value": "ComplexityOfImplementation", - "name": "COMPLEXITY_OF_IMPLEMENTATION" + "type": "enum", + "members": { + "ALREADY_IMPLEMENTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AlreadyImplemented" + } + }, + "NOT_RELEVANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotRelevant" } - ] + }, + "COMPLEXITY_OF_IMPLEMENTATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ComplexityOfImplementation" + } + } } }, "com.amazonaws.resiliencehub#FailedGroupingRecommendationEntries": { @@ -5271,18 +5402,20 @@ } }, "com.amazonaws.resiliencehub#GroupingRecommendationConfidenceLevel": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "HIGH", - "value": "High" - }, - { - "name": "MEDIUM", - "value": "Medium" + "type": "enum", + "members": { + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "High" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium" } - ] + } } }, "com.amazonaws.resiliencehub#GroupingRecommendationList": { @@ -5292,45 +5425,55 @@ } }, "com.amazonaws.resiliencehub#GroupingRecommendationRejectionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "DISTINCT_BUSINESS_PURPOSE", - "value": "DistinctBusinessPurpose" - }, - { - "name": "SEPARATE_DATA_CONCERN", - "value": "SeparateDataConcern" - }, - { - "name": "DISTINCT_USER_GROUP_HANDLING", - "value": "DistinctUserGroupHandling" - }, - { - "name": "OTHER", - "value": "Other" + "type": "enum", + "members": { + "DISTINCT_BUSINESS_PURPOSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DistinctBusinessPurpose" + } + }, + "SEPARATE_DATA_CONCERN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SeparateDataConcern" } - ] + }, + "DISTINCT_USER_GROUP_HANDLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DistinctUserGroupHandling" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Other" + } + } } }, "com.amazonaws.resiliencehub#GroupingRecommendationStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ACCEPTED", - "value": "Accepted" - }, - { - "name": "REJECTED", - "value": "Rejected" - }, - { - "name": "PENDING_DECISION", - "value": "PendingDecision" + "type": "enum", + "members": { + "ACCEPTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Accepted" } - ] + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + }, + "PENDING_DECISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PendingDecision" + } + } } }, "com.amazonaws.resiliencehub#GroupingResource": { @@ -5383,30 +5526,38 @@ } }, "com.amazonaws.resiliencehub#HaArchitecture": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MultiSite", - "name": "MULTI_SITE" - }, - { - "value": "WarmStandby", - "name": "WARM_STANDBY" - }, - { - "value": "PilotLight", - "name": "PILOT_LIGHT" - }, - { - "value": "BackupAndRestore", - "name": "BACKUP_AND_RESTORE" - }, - { - "value": "NoRecoveryPlan", - "name": "NO_RECOVERY_PLAN" + "type": "enum", + "members": { + "MULTI_SITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MultiSite" + } + }, + "WARM_STANDBY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WarmStandby" + } + }, + "PILOT_LIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PilotLight" + } + }, + "BACKUP_AND_RESTORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BackupAndRestore" + } + }, + "NO_RECOVERY_PLAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoRecoveryPlan" } - ] + } } }, "com.amazonaws.resiliencehub#IamRoleArn": { @@ -5679,7 +5830,7 @@ } ], "traits": { - "smithy.api#documentation": "

List of compliance drifts that were detected while running an assessment.

", + "smithy.api#documentation": "

Indicates the list of compliance drifts that were detected while running an\n assessment.

", "smithy.api#http": { "method": "POST", "uri": "/list-app-assessment-compliance-drifts", @@ -6668,6 +6819,13 @@ "smithy.api#documentation": "

The application list is sorted based on the values of\n lastAppComplianceEvaluationTime field. By default, application list is sorted\n in ascending order. To sort the application list in descending order, set this field to\n True.

", "smithy.api#httpQuery": "reverseOrder" } + }, + "awsApplicationArn": { + "target": "com.amazonaws.resiliencehub#Arn", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of Resource Groups group that is integrated with an AppRegistry application. For more information about ARNs, \nsee \n Amazon Resource Names (ARNs) in the \n Amazon Web Services General Reference guide.

", + "smithy.api#httpQuery": "awsApplicationArn" + } } } }, @@ -7471,33 +7629,37 @@ } }, "com.amazonaws.resiliencehub#PermissionModelType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "LegacyIAMUser", - "name": "LEGACY_IAM_USER" - }, - { - "value": "RoleBased", - "name": "ROLE_BASED" + "type": "enum", + "members": { + "LEGACY_IAM_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LegacyIAMUser" + } + }, + "ROLE_BASED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RoleBased" } - ] + } } }, "com.amazonaws.resiliencehub#PhysicalIdentifierType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Arn", - "name": "ARN" - }, - { - "value": "Native", - "name": "NATIVE" + "type": "enum", + "members": { + "ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Arn" + } + }, + "NATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Native" } - ] + } } }, "com.amazonaws.resiliencehub#PhysicalResource": { @@ -7773,26 +7935,32 @@ } }, "com.amazonaws.resiliencehub#RecommendationComplianceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "BreachedUnattainable", - "name": "BREACHED_UNATTAINABLE" - }, - { - "value": "BreachedCanMeet", - "name": "BREACHED_CAN_MEET" - }, - { - "value": "MetCanImprove", - "name": "MET_CAN_IMPROVE" - }, - { - "value": "MissingPolicy", - "name": "MISSING_POLICY" + "type": "enum", + "members": { + "BREACHED_UNATTAINABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BreachedUnattainable" } - ] + }, + "BREACHED_CAN_MEET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BreachedCanMeet" + } + }, + "MET_CAN_IMPROVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MetCanImprove" + } + }, + "MISSING_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissingPolicy" + } + } } }, "com.amazonaws.resiliencehub#RecommendationDisruptionCompliance": { @@ -7899,26 +8067,32 @@ } }, "com.amazonaws.resiliencehub#RecommendationStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Implemented", - "name": "IMPLEMENTED" - }, - { - "value": "Inactive", - "name": "INACTIVE" - }, - { - "value": "NotImplemented", - "name": "NOT_IMPLEMENTED" - }, - { - "value": "Excluded", - "name": "EXCLUDED" + "type": "enum", + "members": { + "IMPLEMENTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Implemented" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Inactive" + } + }, + "NOT_IMPLEMENTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotImplemented" + } + }, + "EXCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Excluded" } - ] + } } }, "com.amazonaws.resiliencehub#RecommendationTemplate": { @@ -8026,26 +8200,32 @@ } }, "com.amazonaws.resiliencehub#RecommendationTemplateStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Success", - "name": "SUCCESS" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + } } }, "com.amazonaws.resiliencehub#RecommendationTemplateStatusList": { @@ -8274,22 +8454,26 @@ } }, "com.amazonaws.resiliencehub#RenderRecommendationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Alarm", - "name": "ALARM" - }, - { - "value": "Sop", - "name": "SOP" - }, - { - "value": "Test", - "name": "TEST" + "type": "enum", + "members": { + "ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Alarm" + } + }, + "SOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sop" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Test" } - ] + } } }, "com.amazonaws.resiliencehub#RenderRecommendationTypeList": { @@ -8373,34 +8557,44 @@ } }, "com.amazonaws.resiliencehub#ResiliencyPolicyTier": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "MissionCritical", - "name": "MISSION_CRITICAL" - }, - { - "value": "Critical", - "name": "CRITICAL" - }, - { - "value": "Important", - "name": "IMPORTANT" - }, - { - "value": "CoreServices", - "name": "CORE_SERVICES" - }, - { - "value": "NonCritical", - "name": "NON_CRITICAL" - }, - { - "value": "NotApplicable", - "name": "NOT_APPLICABLE" + "type": "enum", + "members": { + "MISSION_CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MissionCritical" + } + }, + "CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Critical" + } + }, + "IMPORTANT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Important" + } + }, + "CORE_SERVICES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CoreServices" + } + }, + "NON_CRITICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NonCritical" + } + }, + "NOT_APPLICABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotApplicable" } - ] + } } }, "com.amazonaws.resiliencehub#ResiliencyScore": { @@ -8433,26 +8627,32 @@ } }, "com.amazonaws.resiliencehub#ResiliencyScoreType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Compliance", - "name": "COMPLIANCE" - }, - { - "value": "Test", - "name": "TEST" - }, - { - "value": "Alarm", - "name": "ALARM" - }, - { - "value": "Sop", - "name": "SOP" + "type": "enum", + "members": { + "COMPLIANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Compliance" + } + }, + "TEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Test" + } + }, + "ALARM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Alarm" } - ] + }, + "SOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sop" + } + } } }, "com.amazonaws.resiliencehub#ResolveAppVersionResources": { @@ -8667,41 +8867,49 @@ } }, "com.amazonaws.resiliencehub#ResourceImportStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "PENDING", - "value": "Pending" - }, - { - "name": "IN_PROGRESS", - "value": "InProgress" - }, - { - "name": "FAILED", - "value": "Failed" - }, - { - "name": "SUCCESS", - "value": "Success" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" } - ] + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" + } + } } }, "com.amazonaws.resiliencehub#ResourceImportStrategyType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AddOnly", - "name": "ADD_ONLY" - }, - { - "value": "ReplaceAll", - "name": "REPLACE_ALL" + "type": "enum", + "members": { + "ADD_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddOnly" } - ] + }, + "REPLACE_ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReplaceAll" + } + } } }, "com.amazonaws.resiliencehub#ResourceMapping": { @@ -8769,34 +8977,44 @@ } }, "com.amazonaws.resiliencehub#ResourceMappingType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CfnStack", - "name": "CFN_STACK" - }, - { - "value": "Resource", - "name": "RESOURCE" - }, - { - "value": "AppRegistryApp", - "name": "APP_REGISTRY_APP" - }, - { - "value": "ResourceGroup", - "name": "RESOURCE_GROUP" - }, - { - "value": "Terraform", - "name": "TERRAFORM" - }, - { - "value": "EKS", - "name": "EKS" + "type": "enum", + "members": { + "CFN_STACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CfnStack" + } + }, + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Resource" } - ] + }, + "APP_REGISTRY_APP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AppRegistryApp" + } + }, + "RESOURCE_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceGroup" + } + }, + "TERRAFORM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Terraform" + } + }, + "EKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS" + } + } } }, "com.amazonaws.resiliencehub#ResourceNotFoundException": { @@ -8825,41 +9043,49 @@ } }, "com.amazonaws.resiliencehub#ResourceResolutionStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Pending", - "name": "PENDING" - }, - { - "value": "InProgress", - "name": "IN_PROGRESS" - }, - { - "value": "Failed", - "name": "FAILED" - }, - { - "value": "Success", - "name": "SUCCESS" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" } - ] + } } }, "com.amazonaws.resiliencehub#ResourceSourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AppTemplate", - "name": "APP_TEMPLATE" - }, - { - "value": "Discovered", - "name": "DISCOVERED" + "type": "enum", + "members": { + "APP_TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AppTemplate" + } + }, + "DISCOVERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Discovered" } - ] + } } }, "com.amazonaws.resiliencehub#ResourceType": { @@ -8869,26 +9095,32 @@ } }, "com.amazonaws.resiliencehub#ResourcesGroupingRecGenStatusType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "PENDING", - "value": "Pending" - }, - { - "name": "IN_PROGRESS", - "value": "InProgress" - }, - { - "name": "FAILED", - "value": "Failed" - }, - { - "name": "SUCCESS", - "value": "Success" + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Success" } - ] + } } }, "com.amazonaws.resiliencehub#RetryAfterSeconds": { @@ -9062,14 +9294,14 @@ } }, "com.amazonaws.resiliencehub#SopServiceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SSM", - "name": "SSM" + "type": "enum", + "members": { + "SSM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSM" } - ] + } } }, "com.amazonaws.resiliencehub#SpecReferenceId": { @@ -9421,18 +9653,20 @@ } }, "com.amazonaws.resiliencehub#TemplateFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CfnYaml", - "name": "CFN_YAML" - }, - { - "value": "CfnJson", - "name": "CFN_JSON" + "type": "enum", + "members": { + "CFN_YAML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CfnYaml" } - ] + }, + "CFN_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CfnJson" + } + } } }, "com.amazonaws.resiliencehub#TerraformSource": { @@ -9544,45 +9778,55 @@ } }, "com.amazonaws.resiliencehub#TestRisk": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Small", - "name": "SMALL" - }, - { - "value": "Medium", - "name": "MEDIUM" - }, - { - "value": "High", - "name": "HIGH" + "type": "enum", + "members": { + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Small" } - ] + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Medium" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "High" + } + } } }, "com.amazonaws.resiliencehub#TestType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Software", - "name": "SOFTWARE" - }, - { - "value": "Hardware", - "name": "HARDWARE" - }, - { - "value": "AZ", - "name": "AZ" - }, - { - "value": "Region", - "name": "REGION" + "type": "enum", + "members": { + "SOFTWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Software" } - ] + }, + "HARDWARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Hardware" + } + }, + "AZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AZ" + } + }, + "REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Region" + } + } } }, "com.amazonaws.resiliencehub#ThrottlingException": { @@ -9781,7 +10025,7 @@ "permissionModel": { "target": "com.amazonaws.resiliencehub#PermissionModel", "traits": { - "smithy.api#documentation": "

Defines the roles and credentials that Resilience Hub would use while creating\n an\n application, importing its resources, and running an assessment.

" + "smithy.api#documentation": "

Defines the roles and credentials that Resilience Hub would use while creating an\n application, importing its resources, and running an assessment.

" } }, "eventSubscriptions": { @@ -10172,8 +10416,7 @@ "item": { "target": "com.amazonaws.resiliencehub#UpdateRecommendationStatusItem", "traits": { - "smithy.api#documentation": "

The operational recommendation item.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The operational recommendation item.

" } }, "excluded": { diff --git a/codegen/sdk/aws-models/resource-groups.json b/codegen/sdk/aws-models/resource-groups.json index e129ed3ecaf..dd96ff942b7 100644 --- a/codegen/sdk/aws-models/resource-groups.json +++ b/codegen/sdk/aws-models/resource-groups.json @@ -55,10 +55,38 @@ "smithy.api#documentation": "

The Resource Groups settings for this Amazon Web Services account.

" } }, + "com.amazonaws.resourcegroups#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-zA-Z0-9]{22,26}$" + } + }, + "com.amazonaws.resourcegroups#ApplicationTag": { + "type": "map", + "key": { + "target": "com.amazonaws.resourcegroups#ApplicationTagKey" + }, + "value": { + "target": "com.amazonaws.resourcegroups#ApplicationArn" + } + }, + "com.amazonaws.resourcegroups#ApplicationTagKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^awsApplication$" + } + }, "com.amazonaws.resourcegroups#Ardi": { "type": "service", "version": "2017-11-27", "operations": [ + { + "target": "com.amazonaws.resourcegroups#CancelTagSyncTask" + }, { "target": "com.amazonaws.resourcegroups#CreateGroup" }, @@ -80,21 +108,33 @@ { "target": "com.amazonaws.resourcegroups#GetTags" }, + { + "target": "com.amazonaws.resourcegroups#GetTagSyncTask" + }, { "target": "com.amazonaws.resourcegroups#GroupResources" }, + { + "target": "com.amazonaws.resourcegroups#ListGroupingStatuses" + }, { "target": "com.amazonaws.resourcegroups#ListGroupResources" }, { "target": "com.amazonaws.resourcegroups#ListGroups" }, + { + "target": "com.amazonaws.resourcegroups#ListTagSyncTasks" + }, { "target": "com.amazonaws.resourcegroups#PutGroupConfiguration" }, { "target": "com.amazonaws.resourcegroups#SearchResources" }, + { + "target": "com.amazonaws.resourcegroups#StartTagSyncTask" + }, { "target": "com.amazonaws.resourcegroups#Tag" }, @@ -126,7 +166,7 @@ "name": "resource-groups" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service\n databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A\n resource group is a collection of resources that match the resource types specified in a\n query, and share one or more tags or portions of tags. You can create a group of\n resources based on their roles in your cloud infrastructure, lifecycle stages, regions,\n application layers, or virtually any criteria. Resource Groups enable you to automate management\n tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in\n Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in\n Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member\n resources.

\n

To create a resource group, build a resource query, and specify tags that identify the\n criteria that members of the group have in common. Tags are key-value pairs.

\n

For more information about Resource Groups, see the Resource Groups User Guide.

\n

Resource Groups uses a REST-compliant API that you can use to perform the following types of\n operations.

\n
    \n
  • \n

    Create, Read, Update, and Delete (CRUD) operations on resource groups and\n resource query entities

    \n
    • \n
  • \n

    Applying, editing, and removing tags from resource groups

    \n
    • \n
  • \n

    Resolving resource group member ARNs so they can be returned as search\n results

    \n
    • \n
  • \n

    Getting data about resources that are members of a group

    \n
    • \n
  • \n

    Searching Amazon Web Services resources based on a resource query

    \n
    • \n
", + "smithy.api#documentation": "

Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service\n databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A\n resource group is a collection of resources that match the resource types specified in a\n query, and share one or more tags or portions of tags. You can create a group of\n resources based on their roles in your cloud infrastructure, lifecycle stages, regions,\n application layers, or virtually any criteria. Resource Groups enable you to automate management\n tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in\n Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in\n Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member\n resources.

\n

To create a resource group, build a resource query, and specify tags that identify the\n criteria that members of the group have in common. Tags are key-value pairs.

\n

For more information about Resource Groups, see the Resource Groups User Guide.

\n

Resource Groups uses a REST-compliant API that you can use to perform the following types of\n operations.

\n
    \n
  • \n

    Create, Read, Update, and Delete (CRUD) operations on resource groups and\n resource query entities

    \n
    • \n
  • \n

    Applying, editing, and removing tags from resource groups

    \n
    • \n
  • \n

    Resolving resource group member Amazon resource names (ARN)s so they can be returned as search\n results

    \n
    • \n
  • \n

    Getting data about resources that are members of a group

    \n
    • \n
  • \n

    Searching Amazon Web Services resources based on a resource query

    \n
    • \n
", "smithy.api#title": "AWS Resource Groups", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1147,6 +1187,58 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.resourcegroups#CancelTagSyncTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.resourcegroups#CancelTagSyncTaskInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.resourcegroups#BadRequestException" + }, + { + "target": "com.amazonaws.resourcegroups#ForbiddenException" + }, + { + "target": "com.amazonaws.resourcegroups#InternalServerErrorException" + }, + { + "target": "com.amazonaws.resourcegroups#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.resourcegroups#TooManyRequestsException" + }, + { + "target": "com.amazonaws.resourcegroups#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels the specified tag-sync task.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:CancelTagSyncTask on the application group

    \n
    • \n
  • \n

    \n resource-groups:DeleteGroup\n

    \n
    • \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/cancel-tag-sync-task", + "code": 200 + } + } + }, + "com.amazonaws.resourcegroups#CancelTagSyncTaskInput": { + "type": "structure", + "members": { + "TaskArn": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the tag-sync task.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.resourcegroups#CreateGroup": { "type": "operation", "input": { @@ -1185,7 +1277,7 @@ "type": "structure", "members": { "Name": { - "target": "com.amazonaws.resourcegroups#GroupName", + "target": "com.amazonaws.resourcegroups#CreateGroupName", "traits": { "smithy.api#documentation": "

The name of the group, which is the identifier of the group in other operations. You\n can't change the name of a resource group after you create it. A resource group name can\n consist of letters, numbers, hyphens, periods, and underscores. The name cannot start\n with AWS, aws, or any other possible capitalization; these are\n reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services\n account.

", "smithy.api#required": {} @@ -1214,12 +1306,40 @@ "traits": { "smithy.api#documentation": "

A configuration associates the resource group with an Amazon Web Services service and specifies how\n the service can interact with the resources in the group. A configuration is an array of\n GroupConfigurationItem elements. For details about the syntax of\n service configurations, see Service configurations for Resource Groups.

\n \n

A resource group can contain either a Configuration or a\n ResourceQuery, but not both.

\n " } + }, + "Criticality": { + "target": "com.amazonaws.resourcegroups#Criticality", + "traits": { + "smithy.api#documentation": "

The critical rank of the application group on a scale of 1 to 10, with a \n rank of 1 being the most critical, and a rank of 10 being least critical.

" + } + }, + "Owner": { + "target": "com.amazonaws.resourcegroups#Owner", + "traits": { + "smithy.api#documentation": "

A name, email address or other identifier for the person or group \n who is considered as the owner of this application group within your organization.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.resourcegroups#DisplayName", + "traits": { + "smithy.api#documentation": "

The name of the application group, which you can change at any time.

" + } } }, "traits": { "smithy.api#input": {} } }, + "com.amazonaws.resourcegroups#CreateGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\.-]+$" + } + }, "com.amazonaws.resourcegroups#CreateGroupOutput": { "type": "structure", "members": { @@ -1252,6 +1372,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#Criticality": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.resourcegroups#DeleteGroup": { "type": "operation", "input": { @@ -1302,9 +1431,9 @@ } }, "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group to delete.

" + "smithy.api#documentation": "

The name or the Amazon resource name (ARN) of the resource group to delete.

" } } }, @@ -1336,6 +1465,16 @@ "smithy.api#pattern": "^[\\sa-zA-Z0-9_\\.-]*$" } }, + "com.amazonaws.resourcegroups#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 300 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, "com.amazonaws.resourcegroups#ErrorCode": { "type": "string", "traits": { @@ -1360,7 +1499,7 @@ "ResourceArn": { "target": "com.amazonaws.resourcegroups#ResourceArn", "traits": { - "smithy.api#documentation": "

The ARN of the resource that failed to be added or removed.

" + "smithy.api#documentation": "

The Amazon resource name (ARN) of the resource that failed to be added or removed.

" } }, "ErrorMessage": { @@ -1527,7 +1666,7 @@ "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group for which you want to retrive the service\n configuration.

" + "smithy.api#documentation": "

The name or the Amazon resource name (ARN) of the resource group for which you want to retrive the service\n configuration.

" } } }, @@ -1562,9 +1701,9 @@ } }, "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group to retrieve.

" + "smithy.api#documentation": "

The name or the Amazon resource name (ARN) of the resource group to retrieve.

" } } }, @@ -1638,7 +1777,7 @@ "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group to query.

" + "smithy.api#documentation": "

The name or the Amazon resource name (ARN) of the resource group to query.

" } } }, @@ -1660,6 +1799,123 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#GetTagSyncTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.resourcegroups#GetTagSyncTaskInput" + }, + "output": { + "target": "com.amazonaws.resourcegroups#GetTagSyncTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.resourcegroups#BadRequestException" + }, + { + "target": "com.amazonaws.resourcegroups#ForbiddenException" + }, + { + "target": "com.amazonaws.resourcegroups#InternalServerErrorException" + }, + { + "target": "com.amazonaws.resourcegroups#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.resourcegroups#NotFoundException" + }, + { + "target": "com.amazonaws.resourcegroups#TooManyRequestsException" + }, + { + "target": "com.amazonaws.resourcegroups#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a specified tag-sync task.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:GetTagSyncTask on the application group

    \n
    • \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/get-tag-sync-task", + "code": 200 + } + } + }, + "com.amazonaws.resourcegroups#GetTagSyncTaskInput": { + "type": "structure", + "members": { + "TaskArn": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the tag-sync task.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resourcegroups#GetTagSyncTaskOutput": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.resourcegroups#GroupArnV2", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the application group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the application group.

" + } + }, + "TaskArn": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the tag-sync task.

" + } + }, + "TagKey": { + "target": "com.amazonaws.resourcegroups#TagKey", + "traits": { + "smithy.api#documentation": "

The tag key.

" + } + }, + "TagValue": { + "target": "com.amazonaws.resourcegroups#TagValue", + "traits": { + "smithy.api#documentation": "

The tag value.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.resourcegroups#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the role assumed by Resource Groups to tag and untag resources on your behalf.

\n

For more information about this role, review Tag-sync required permissions. \n

" + } + }, + "Status": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the tag-sync task.

\n

Valid values include:

\n
    \n
  • \n

    \n ACTIVE - The tag-sync task is actively managing resources in \n the application by adding or removing the awsApplication tag from resources \n when they are tagged or untagged with the specified tag key-value pair. \n

    \n
    • \n
  • \n

    \n ERROR - The tag-sync task is not actively managing resources \n in the application. Review the ErrorMessage for more information about \n resolving the error. \n

    \n
    • \n
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.resourcegroups#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The specific error message in cases where the tag-sync task status\n is ERROR.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.resourcegroups#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the tag-sync task was created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resourcegroups#GetTags": { "type": "operation", "input": { @@ -1689,7 +1945,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of tags that are associated with a resource group, specified by an\n ARN.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:GetTags\n

    \n
    • \n
", + "smithy.api#documentation": "

Returns a list of tags that are associated with a resource group, specified by an\n Amazon resource name (ARN).

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:GetTags\n

    \n
    • \n
", "smithy.api#http": { "method": "GET", "uri": "/resources/{Arn}/tags", @@ -1701,9 +1957,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "

The ARN of the resource group whose tags you want to retrieve.

", + "smithy.api#documentation": "

The Amazon resource name (ARN) of the resource group whose tags you want to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1717,9 +1973,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "

The ARN of the tagged resource group.

" + "smithy.api#documentation": "

TheAmazon resource name (ARN) of the tagged resource group.

" } }, "Tags": { @@ -1737,9 +1993,9 @@ "type": "structure", "members": { "GroupArn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "

The ARN of the resource group.

", + "smithy.api#documentation": "

The Amazon resource name (ARN) of the resource group.

", "smithy.api#required": {} } }, @@ -1755,6 +2011,30 @@ "traits": { "smithy.api#documentation": "

The description of the resource group.

" } + }, + "Criticality": { + "target": "com.amazonaws.resourcegroups#Criticality", + "traits": { + "smithy.api#documentation": "

The critical rank of the application group on a scale of 1 to 10, with a \n rank of 1 being the most critical, and a rank of 10 being least critical.

" + } + }, + "Owner": { + "target": "com.amazonaws.resourcegroups#Owner", + "traits": { + "smithy.api#documentation": "

A name, email address or other identifier for the person or group \n who is considered as the owner of this application group within your organization.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.resourcegroups#DisplayName", + "traits": { + "smithy.api#documentation": "

The name of the application group, which you can change at any time.

" + } + }, + "ApplicationTag": { + "target": "com.amazonaws.resourcegroups#ApplicationTag", + "traits": { + "smithy.api#documentation": "

A tag that defines the application group membership. This tag is only supported \n for application groups.

" + } } }, "traits": { @@ -1768,7 +2048,17 @@ "min": 12, "max": 1600 }, - "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,300}$" + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})$" + } + }, + "com.amazonaws.resourcegroups#GroupArnV2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})$" } }, "com.amazonaws.resourcegroups#GroupConfiguration": { @@ -1961,6 +2251,24 @@ "traits": { "smithy.api#enumValue": "configuration-type" } + }, + "Owner": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "owner" + } + }, + "DisplayName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "display-name" + } + }, + "Criticality": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "criticality" + } } } }, @@ -1969,9 +2277,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 128 + "max": 300 }, - "smithy.api#pattern": "^AWS::(AllSupported|[a-zA-Z0-9]+::[a-zA-Z0-9]+)$" + "smithy.api#pattern": "^AWS::(AllSupported|[a-zA-Z0-9]+::[a-zA-Z0-9]+)|[\\s\\p{L}0-9_\\.-]*$" } }, "com.amazonaws.resourcegroups#GroupFilterValues": { @@ -1998,7 +2306,31 @@ "GroupArn": { "target": "com.amazonaws.resourcegroups#GroupArn", "traits": { - "smithy.api#documentation": "

The ARN of the resource group.

" + "smithy.api#documentation": "

The Amazon resource name (ARN) of the resource group.

" + } + }, + "Description": { + "target": "com.amazonaws.resourcegroups#Description", + "traits": { + "smithy.api#documentation": "

The description of the application group.

" + } + }, + "Criticality": { + "target": "com.amazonaws.resourcegroups#Criticality", + "traits": { + "smithy.api#documentation": "

The critical rank of the application group on a scale of 1 to 10, with a \n rank of 1 being the most critical, and a rank of 10 being least critical.

" + } + }, + "Owner": { + "target": "com.amazonaws.resourcegroups#Owner", + "traits": { + "smithy.api#documentation": "

A name, email address or other identifier for the person or group \n who is considered as the owner of this group within your organization.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.resourcegroups#DisplayName", + "traits": { + "smithy.api#documentation": "

The name of the application group, which you can change at any time.

" } } }, @@ -2080,7 +2412,7 @@ "min": 1, "max": 300 }, - "smithy.api#pattern": "^[a-zA-Z0-9_\\.-]+$" + "smithy.api#pattern": "^[a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}$" } }, "com.amazonaws.resourcegroups#GroupParameterList": { @@ -2140,7 +2472,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified resources to the specified group.

\n \n

You can use this operation with only resource groups that are configured with the\n following types:

\n
    \n
  • \n

    \n AWS::EC2::HostManagement\n

    \n
    • \n
  • \n

    \n AWS::EC2::CapacityReservationPool\n

    \n
    • \n
\n

Other resource group type and resource types aren't currently supported by this\n operation.

\n \n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:GroupResources\n

    \n
    • \n
", + "smithy.api#documentation": "

Adds the specified resources to the specified group.

\n \n

You can only use this operation with the following groups:

\n
    \n
  • \n

    \n AWS::EC2::HostManagement\n

    \n
    • \n
  • \n

    \n AWS::EC2::CapacityReservationPool\n

    \n
    • \n
  • \n

    \n AWS::ResourceGroups::ApplicationGroup\n

    \n
    • \n
\n

Other resource group types and resource types are not currently supported by this\n operation.

\n \n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:GroupResources\n

    \n
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/group-resources", @@ -2152,16 +2484,16 @@ "type": "structure", "members": { "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group to add resources to.

", + "smithy.api#documentation": "

The name or the Amazon resource name (ARN) of the resource group to add resources to.

", "smithy.api#required": {} } }, "ResourceArns": { "target": "com.amazonaws.resourcegroups#ResourceArnList", "traits": { - "smithy.api#documentation": "

The list of ARNs of the resources to be added to the group.

", + "smithy.api#documentation": "

The list of Amazon resource names (ARNs) of the resources to be added to the group.

", "smithy.api#required": {} } } @@ -2176,19 +2508,19 @@ "Succeeded": { "target": "com.amazonaws.resourcegroups#ResourceArnList", "traits": { - "smithy.api#documentation": "

A list of ARNs of the resources that this operation successfully added to the\n group.

" + "smithy.api#documentation": "

A list of Amazon resource names (ARNs) of the resources that this operation successfully added to the\n group.

" } }, "Failed": { "target": "com.amazonaws.resourcegroups#FailedResourceList", "traits": { - "smithy.api#documentation": "

A list of ARNs of any resources that this operation failed to add to the group.

" + "smithy.api#documentation": "

A list of Amazon resource names (ARNs) of any resources that this operation failed to add to the group.

" } }, "Pending": { "target": "com.amazonaws.resourcegroups#PendingResourceList", "traits": { - "smithy.api#documentation": "

A list of ARNs of any resources that this operation is still in the process adding to\n the group. These pending additions continue asynchronously. You can check the status of\n pending additions by using the \n ListGroupResources\n \n operation, and checking the Resources array in the response and the\n Status field of each object in that array.

" + "smithy.api#documentation": "

A list of Amazon resource names (ARNs) of any resources that this operation is still in the process adding to\n the group. These pending additions continue asynchronously. You can check the status of\n pending additions by using the \n ListGroupResources\n \n operation, and checking the Resources array in the response and the\n Status field of each object in that array.

" } } }, @@ -2203,16 +2535,122 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "^(arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/)?[a-zA-Z0-9_\\.-]{1,300}$" + "smithy.api#pattern": "^[a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}|arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})$" } }, - "com.amazonaws.resourcegroups#InternalServerErrorException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.resourcegroups#ErrorMessage" - } - }, + "com.amazonaws.resourcegroups#GroupStringV2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}|arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/([a-zA-Z0-9_\\.-]{1,300}|[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})$" + } + }, + "com.amazonaws.resourcegroups#GroupingStatus": { + "type": "enum", + "members": { + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + } + } + }, + "com.amazonaws.resourcegroups#GroupingStatusesItem": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.resourcegroups#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of a resource.

" + } + }, + "Action": { + "target": "com.amazonaws.resourcegroups#GroupingType", + "traits": { + "smithy.api#documentation": "

Describes the resource grouping action with values of \n GROUP or UNGROUP.

" + } + }, + "Status": { + "target": "com.amazonaws.resourcegroups#GroupingStatus", + "traits": { + "smithy.api#documentation": "

Describes the resource grouping status with values of \n SUCCESS, FAILED, IN_PROGRESS, \n or SKIPPED.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.resourcegroups#ErrorMessage", + "traits": { + "smithy.api#documentation": "

A message that explains the ErrorCode.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.resourcegroups#ErrorCode", + "traits": { + "smithy.api#documentation": "

Specifies the error code that was raised.

" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.resourcegroups#timestamp", + "traits": { + "smithy.api#documentation": "

A timestamp of when the status was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The information about a grouping or ungrouping resource action.

" + } + }, + "com.amazonaws.resourcegroups#GroupingStatusesList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#GroupingStatusesItem" + } + }, + "com.amazonaws.resourcegroups#GroupingType": { + "type": "enum", + "members": { + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" + } + }, + "UNGROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNGROUP" + } + } + } + }, + "com.amazonaws.resourcegroups#InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.resourcegroups#ErrorMessage" + } + }, "traits": { "smithy.api#documentation": "

An internal error occurred while processing the request. Try again later.

", "smithy.api#error": "server", @@ -2251,7 +2689,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of ARNs of the resources that are members of a specified resource\n group.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:ListGroupResources\n

    \n
    • \n
  • \n

    \n cloudformation:DescribeStacks\n

    \n
    • \n
  • \n

    \n cloudformation:ListStackResources\n

    \n
    • \n
  • \n

    \n tag:GetResources\n

    \n
    • \n
", + "smithy.api#documentation": "

Returns a list of Amazon resource names (ARNs) of the resources that are members of a specified resource\n group.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:ListGroupResources\n

    \n
    • \n
  • \n

    \n cloudformation:DescribeStacks\n

    \n
    • \n
  • \n

    \n cloudformation:ListStackResources\n

    \n
    • \n
  • \n

    \n tag:GetResources\n

    \n
    • \n
", "smithy.api#http": { "method": "POST", "uri": "/list-group-resources", @@ -2278,9 +2716,9 @@ } }, "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group

" + "smithy.api#documentation": "

The name or the Amazon resource name (ARN) of the resource group.

" } }, "Filters": { @@ -2364,6 +2802,168 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#ListGroupingStatuses": { + "type": "operation", + "input": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesInput" + }, + "output": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.resourcegroups#BadRequestException" + }, + { + "target": "com.amazonaws.resourcegroups#ForbiddenException" + }, + { + "target": "com.amazonaws.resourcegroups#InternalServerErrorException" + }, + { + "target": "com.amazonaws.resourcegroups#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.resourcegroups#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the status of the last grouping or ungrouping action for \n each resource in the specified application group.

", + "smithy.api#http": { + "method": "POST", + "uri": "/list-grouping-statuses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupingStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter. Filter names are case-sensitive.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilterValues", + "traits": { + "smithy.api#documentation": "

One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter name and value pair that is used to obtain more specific results from the list of grouping statuses.

" + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilter" + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilterName": { + "type": "enum", + "members": { + "Status": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "status" + } + }, + "ResourceArn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "resource-arn" + } + } + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilterValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "^SUCCESS|FAILED|IN_PROGRESS|SKIPPED|arn:aws(-[a-z]+)*:[a-z0-9\\-]*:([a-z]{2}(-[a-z]+)+-\\d{1})?:([0-9]{12})?:.+$" + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesInput": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.resourcegroups#GroupStringV2", + "traits": { + "smithy.api#documentation": "

The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.resourcegroups#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of resources and their statuses returned in the \n response.

" + } + }, + "Filters": { + "target": "com.amazonaws.resourcegroups#ListGroupingStatusesFilterList", + "traits": { + "smithy.api#documentation": "

The filter name and value pair that is used to return more \n specific results from a list of resources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the \n value provided by a previous call's NextToken response to indicate \n where the output should continue from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resourcegroups#ListGroupingStatusesOutput": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.resourcegroups#GroupStringV2", + "traits": { + "smithy.api#documentation": "

The application group identifier, expressed as an Amazon resource name (ARN) or the application group name.

" + } + }, + "GroupingStatuses": { + "target": "com.amazonaws.resourcegroups#GroupingStatusesList", + "traits": { + "smithy.api#documentation": "

Returns details about the grouping or ungrouping status of the \n resources in the specified application group.

" + } + }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. \n Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. \n You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resourcegroups#ListGroups": { "type": "operation", "input": { @@ -2410,7 +3010,7 @@ "Filters": { "target": "com.amazonaws.resourcegroups#GroupFilterList", "traits": { - "smithy.api#documentation": "

Filters, formatted as GroupFilter objects, that you want to apply to\n a ListGroups operation.

\n
    \n
  • \n

    \n resource-type - Filter the results to include only those resource groups that have the specified\n resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would\n return any resource group with a ResourceTypeFilter that includes\n AWS::EC2::Instance.

    \n
    • \n
  • \n

    \n configuration-type - Filter the results to include only those\n groups that have the specified configuration types attached. The current\n supported values are:

    \n
      \n
    • \n

      \n AWS::AppRegistry::Application\n

      \n
      • \n
    • \n

      \n AWS::AppRegistry::ApplicationResourceGroups\n

      \n
      • \n
    • \n

      \n AWS::CloudFormation::Stack\n

      \n
      • \n
    • \n

      \n AWS::EC2::CapacityReservationPool\n

      \n
      • \n
    • \n

      \n AWS::EC2::HostManagement\n

      \n
      • \n
    • \n

      \n AWS::NetworkFirewall::RuleGroup\n

      \n
      • \n
    \n
    • \n
" + "smithy.api#documentation": "

Filters, formatted as GroupFilter objects, that you want to apply to\n a ListGroups operation.

\n
    \n
  • \n

    \n resource-type - Filter the results to include only those resource groups that have the specified\n resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would\n return any resource group with a ResourceTypeFilter that includes\n AWS::EC2::Instance.

    \n
    • \n
  • \n

    \n configuration-type - Filter the results to include only those\n groups that have the specified configuration types attached. The current\n supported values are:

    \n
      \n
    • \n

      \n AWS::ResourceGroups::ApplicationGroup\n

      \n
      • \n
    • \n

      \n AWS::AppRegistry::Application\n

      \n
      • \n
    • \n

      \n AWS::AppRegistry::ApplicationResourceGroups\n

      \n
      • \n
    • \n

      \n AWS::CloudFormation::Stack\n

      \n
      • \n
    • \n

      \n AWS::EC2::CapacityReservationPool\n

      \n
      • \n
    • \n

      \n AWS::EC2::HostManagement\n

      \n
      • \n
    • \n

      \n AWS::NetworkFirewall::RuleGroup\n

      \n
      • \n
    \n
    • \n
" } }, "MaxResults": { @@ -2461,6 +3061,121 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#ListTagSyncTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.resourcegroups#ListTagSyncTasksInput" + }, + "output": { + "target": "com.amazonaws.resourcegroups#ListTagSyncTasksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.resourcegroups#BadRequestException" + }, + { + "target": "com.amazonaws.resourcegroups#ForbiddenException" + }, + { + "target": "com.amazonaws.resourcegroups#InternalServerErrorException" + }, + { + "target": "com.amazonaws.resourcegroups#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.resourcegroups#TooManyRequestsException" + }, + { + "target": "com.amazonaws.resourcegroups#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of tag-sync tasks.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:ListTagSyncTasks with the group passed in the filters as the resource \n or * if using no filters

    \n
    • \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/list-tag-sync-tasks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TagSyncTasks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.resourcegroups#ListTagSyncTasksFilter": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.resourcegroups#GroupArnV2", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the application group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the application group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns tag-sync tasks filtered by the Amazon resource name (ARN) or name of a \n specified application group.

" + } + }, + "com.amazonaws.resourcegroups#ListTagSyncTasksFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#ListTagSyncTasksFilter" + } + }, + "com.amazonaws.resourcegroups#ListTagSyncTasksInput": { + "type": "structure", + "members": { + "Filters": { + "target": "com.amazonaws.resourcegroups#ListTagSyncTasksFilterList", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) or name of the application group for which you want to return a \n list of tag-sync tasks.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.resourcegroups#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be included in the response.

" + } + }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the \n value provided by a previous call's NextToken response to indicate \n where the output should continue from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resourcegroups#ListTagSyncTasksOutput": { + "type": "structure", + "members": { + "TagSyncTasks": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskList", + "traits": { + "smithy.api#documentation": "

A list of tag-sync tasks and information about each task.

" + } + }, + "NextToken": { + "target": "com.amazonaws.resourcegroups#NextToken", + "traits": { + "smithy.api#documentation": "

If present, indicates that more output is available than is included in the current response. \n Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. \n You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resourcegroups#MaxResults": { "type": "integer", "traits": { @@ -2506,6 +3221,16 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.resourcegroups#Owner": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 300 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, "com.amazonaws.resourcegroups#PendingResource": { "type": "structure", "members": { @@ -2569,7 +3294,7 @@ "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { - "smithy.api#documentation": "

The name or ARN of the resource group with the configuration that you want to\n update.

" + "smithy.api#documentation": "

The name or Amazon resource name (ARN) of the resource group with the configuration that you want to\n update.

" } }, "Configuration": { @@ -2767,7 +3492,7 @@ "ResourceArn": { "target": "com.amazonaws.resourcegroups#ResourceArn", "traits": { - "smithy.api#documentation": "

The ARN of a resource.

" + "smithy.api#documentation": "

The Amazon resource name (ARN) of a resource.

" } }, "ResourceType": { @@ -2793,7 +3518,7 @@ "Type": { "target": "com.amazonaws.resourcegroups#QueryType", "traits": { - "smithy.api#documentation": "

The type of the query to perform. This can have one of two values:

\n
    \n
  • \n

    \n \n CLOUDFORMATION_STACK_1_0:\n Specifies that you\n want the group to contain the members of an CloudFormation stack. The Query\n contains a StackIdentifier element with an ARN for a CloudFormation\n stack.

    \n
    • \n
  • \n

    \n \n TAG_FILTERS_1_0:\n Specifies that you want the\n group to include resource that have tags that match the query.

    \n
    • \n
", + "smithy.api#documentation": "

The type of the query to perform. This can have one of two values:

\n
    \n
  • \n

    \n \n CLOUDFORMATION_STACK_1_0:\n Specifies that you\n want the group to contain the members of an CloudFormation stack. The Query\n contains a StackIdentifier element with an Amazon resource name (ARN) for a CloudFormation\n stack.

    \n
    • \n
  • \n

    \n \n TAG_FILTERS_1_0:\n Specifies that you want the\n group to include resource that have tags that match the query.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -2840,6 +3565,16 @@ "smithy.api#pattern": "^AWS::[a-zA-Z0-9]+::\\w+$" } }, + "com.amazonaws.resourcegroups#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + } + }, "com.amazonaws.resourcegroups#SearchResources": { "type": "operation", "input": { @@ -2936,6 +3671,126 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#StartTagSyncTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.resourcegroups#StartTagSyncTaskInput" + }, + "output": { + "target": "com.amazonaws.resourcegroups#StartTagSyncTaskOutput" + }, + "errors": [ + { + "target": "com.amazonaws.resourcegroups#BadRequestException" + }, + { + "target": "com.amazonaws.resourcegroups#ForbiddenException" + }, + { + "target": "com.amazonaws.resourcegroups#InternalServerErrorException" + }, + { + "target": "com.amazonaws.resourcegroups#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.resourcegroups#NotFoundException" + }, + { + "target": "com.amazonaws.resourcegroups#TooManyRequestsException" + }, + { + "target": "com.amazonaws.resourcegroups#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an \n application.

\n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:StartTagSyncTask on the application group

    \n
    • \n
  • \n

    \n resource-groups:CreateGroup\n

    \n
    • \n
  • \n

    \n iam:PassRole on the role provided in the request

    \n
    • \n
", + "smithy.api#http": { + "method": "POST", + "uri": "/start-tag-sync-task", + "code": 200 + } + } + }, + "com.amazonaws.resourcegroups#StartTagSyncTaskInput": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.resourcegroups#GroupStringV2", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.

", + "smithy.api#required": {} + } + }, + "TagKey": { + "target": "com.amazonaws.resourcegroups#TagKey", + "traits": { + "smithy.api#documentation": "

The tag key. Resources tagged with this tag key-value pair will be added to \n the application. If a resource with this tag is later untagged, the tag-sync task removes\n the resource from the application.

", + "smithy.api#required": {} + } + }, + "TagValue": { + "target": "com.amazonaws.resourcegroups#TagValue", + "traits": { + "smithy.api#documentation": "

The tag value. Resources tagged with this tag key-value pair will be added to \n the application. If a resource with this tag is later untagged, the tag-sync task removes\n the resource from the application.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.resourcegroups#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.resourcegroups#StartTagSyncTaskOutput": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.resourcegroups#GroupArnV2", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the application group for which you want to add or remove resources.

" + } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the application group to onboard and sync resources.

" + } + }, + "TaskArn": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the new tag-sync task.

" + } + }, + "TagKey": { + "target": "com.amazonaws.resourcegroups#TagKey", + "traits": { + "smithy.api#documentation": "

The tag key of the tag-sync task.

" + } + }, + "TagValue": { + "target": "com.amazonaws.resourcegroups#TagValue", + "traits": { + "smithy.api#documentation": "

The tag value of the tag-sync task.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.resourcegroups#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.resourcegroups#Tag": { "type": "operation", "input": { @@ -2965,7 +3820,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds tags to a resource group with the specified ARN. Existing tags on a resource\n group are not changed if they are not specified in the request parameters.

\n \n

Do not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.

\n \n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:Tag\n

    \n
    • \n
", + "smithy.api#documentation": "

Adds tags to a resource group with the specified Amazon resource name (ARN). Existing tags on a resource\n group are not changed if they are not specified in the request parameters.

\n \n

Do not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.

\n \n

\n Minimum permissions\n

\n

To run this command, you must have the following permissions:

\n
    \n
  • \n

    \n resource-groups:Tag\n

    \n
    • \n
", "smithy.api#http": { "method": "PUT", "uri": "/resources/{Arn}/tags", @@ -2977,9 +3832,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "

The ARN of the resource group to which to add tags.

", + "smithy.api#documentation": "

The Amazon resource name (ARN) of the resource group to which to add tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3016,9 +3871,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "

The ARN of the tagged resource.

" + "smithy.api#documentation": "

The Amazon resource name (ARN) of the tagged resource.

" } }, "Tags": { @@ -3032,6 +3887,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.resourcegroups#TagSyncTaskArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1600 + }, + "smithy.api#pattern": "^arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}(-[a-z]+)+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26}/tag-sync-task/[a-z0-9]{26}$" + } + }, + "com.amazonaws.resourcegroups#TagSyncTaskItem": { + "type": "structure", + "members": { + "GroupArn": { + "target": "com.amazonaws.resourcegroups#GroupArnV2", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the application group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.resourcegroups#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the application group.

" + } + }, + "TaskArn": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the tag-sync task.

" + } + }, + "TagKey": { + "target": "com.amazonaws.resourcegroups#TagKey", + "traits": { + "smithy.api#documentation": "

The tag key.

" + } + }, + "TagValue": { + "target": "com.amazonaws.resourcegroups#TagValue", + "traits": { + "smithy.api#documentation": "

The tag value.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.resourcegroups#RoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.

" + } + }, + "Status": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskStatus", + "traits": { + "smithy.api#documentation": "

The status of the tag-sync task.

\n

Valid values include:

\n
    \n
  • \n

    \n ACTIVE - The tag-sync task is actively managing resources in \n the application by adding or removing the awsApplication tag from resources \n when they are tagged or untagged with the specified tag key-value pair. \n

    \n
    • \n
  • \n

    \n ERROR - The tag-sync task is not actively managing resources \n in the application. Review the ErrorMessage for more information about \n resolving the error. \n

    \n
    • \n
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.resourcegroups#ErrorMessage", + "traits": { + "smithy.api#documentation": "

The specific error message in cases where the tag-sync task status\n is Error.

" + } + }, + "CreatedAt": { + "target": "com.amazonaws.resourcegroups#timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp of when the tag-sync task was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the tag-sync task.

" + } + }, + "com.amazonaws.resourcegroups#TagSyncTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.resourcegroups#TagSyncTaskItem" + } + }, + "com.amazonaws.resourcegroups#TagSyncTaskStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + } + } + }, "com.amazonaws.resourcegroups#TagValue": { "type": "string", "traits": { @@ -3118,16 +4068,16 @@ "type": "structure", "members": { "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group from which to remove the resources.

", + "smithy.api#documentation": "

The name or the Amazon resource name (ARN) of the resource group from which to remove the resources.

", "smithy.api#required": {} } }, "ResourceArns": { "target": "com.amazonaws.resourcegroups#ResourceArnList", "traits": { - "smithy.api#documentation": "

The ARNs of the resources to be removed from the group.

", + "smithy.api#documentation": "

The Amazon resource names (ARNs) of the resources to be removed from the group.

", "smithy.api#required": {} } } @@ -3203,9 +4153,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "

The ARN of the resource group from which to remove tags. The command removed both the\n specified keys and any values associated with those keys.

", + "smithy.api#documentation": "

The Amazon resource name (ARN) of the resource group from which to remove tags. The command removed both the\n specified keys and any values associated with those keys.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3226,9 +4176,9 @@ "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.resourcegroups#GroupArn", + "target": "com.amazonaws.resourcegroups#GroupArnV2", "traits": { - "smithy.api#documentation": "

The ARN of the resource group from which tags have been removed.

" + "smithy.api#documentation": "

The Amazon resource name (ARN) of the resource group from which tags have been removed.

" } }, "Keys": { @@ -3282,7 +4232,7 @@ "GroupLifecycleEventsDesiredStatus": { "target": "com.amazonaws.resourcegroups#GroupLifecycleEventsDesiredStatus", "traits": { - "smithy.api#documentation": "

Specifies whether you want to turn group lifecycle events on or off.

" + "smithy.api#documentation": "

Specifies whether you want to turn group lifecycle events on or off.

\n

You can't turn on group lifecycle events if your resource groups quota is greater than 2,000.

" } } }, @@ -3354,9 +4304,9 @@ } }, "Group": { - "target": "com.amazonaws.resourcegroups#GroupString", + "target": "com.amazonaws.resourcegroups#GroupStringV2", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group to modify.

" + "smithy.api#documentation": "

The name or the ARN of the resource group to update.

" } }, "Description": { @@ -3364,6 +4314,24 @@ "traits": { "smithy.api#documentation": "

The new description that you want to update the resource group with. Descriptions can\n contain letters, numbers, hyphens, underscores, periods, and spaces.

" } + }, + "Criticality": { + "target": "com.amazonaws.resourcegroups#Criticality", + "traits": { + "smithy.api#documentation": "

The critical rank of the application group on a scale of 1 to 10, with a \n rank of 1 being the most critical, and a rank of 10 being least critical.

" + } + }, + "Owner": { + "target": "com.amazonaws.resourcegroups#Owner", + "traits": { + "smithy.api#documentation": "

A name, email address or other identifier for the person or group \n who is considered as the owner of this application group within your organization.

" + } + }, + "DisplayName": { + "target": "com.amazonaws.resourcegroups#DisplayName", + "traits": { + "smithy.api#documentation": "

The name of the application group, which you can change at any time.

" + } } }, "traits": { @@ -3436,7 +4404,7 @@ "Group": { "target": "com.amazonaws.resourcegroups#GroupString", "traits": { - "smithy.api#documentation": "

The name or the ARN of the resource group to query.

" + "smithy.api#documentation": "

The name or the Amazon resource name (ARN) of the resource group to query.

" } }, "ResourceQuery": { @@ -3464,6 +4432,9 @@ "traits": { "smithy.api#output": {} } + }, + "com.amazonaws.resourcegroups#timestamp": { + "type": "timestamp" } } } diff --git a/codegen/sdk/aws-models/robomaker.json b/codegen/sdk/aws-models/robomaker.json index dcdd2970fab..bce47bd0a1c 100644 --- a/codegen/sdk/aws-models/robomaker.json +++ b/codegen/sdk/aws-models/robomaker.json @@ -94,7 +94,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes one or more worlds in a batch operation.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Deletes one or more worlds in a batch operation.

", "smithy.api#http": { "method": "POST", "uri": "/batchDeleteWorlds", @@ -154,7 +154,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes one or more simulation jobs.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes one or more simulation jobs.

", "smithy.api#http": { "method": "POST", "uri": "/batchDescribeSimulationJob", @@ -255,7 +255,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Cancels the specified deployment job.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Cancels the specified deployment job.

", "smithy.api#http": { "method": "POST", "uri": "/cancelDeploymentJob", @@ -314,7 +314,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the specified simulation job.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Cancels the specified simulation job.

", "smithy.api#http": { "method": "POST", "uri": "/cancelSimulationJob", @@ -345,7 +345,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels a simulation job batch. When you cancel a simulation job batch, you are also\n cancelling all of the active simulation jobs created as part of the batch.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Cancels a simulation job batch. When you cancel a simulation job batch, you are also\n cancelling all of the active simulation jobs created as part of the batch.

", "smithy.api#http": { "method": "POST", "uri": "/cancelSimulationJobBatch", @@ -420,7 +420,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the specified export job.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Cancels the specified export job.

", "smithy.api#http": { "method": "POST", "uri": "/cancelWorldExportJob", @@ -473,7 +473,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the specified world generator job.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Cancels the specified world generator job.

", "smithy.api#http": { "method": "POST", "uri": "/cancelWorldGenerationJob", @@ -646,7 +646,7 @@ "smithy.api#deprecated": { "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Deploys a specific version of a robot application to robots in a fleet.

\n \n

This API is no longer supported and will throw an error if used.

\n \n

The robot application must have a numbered applicationVersion for\n consistency reasons. To create a new version, use\n CreateRobotApplicationVersion or see Creating a Robot Application Version.

\n \n

After 90 days, deployment jobs expire and will be deleted. They will no longer be\n accessible.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.

\n \n

Deploys a specific version of a robot application to robots in a fleet.

\n

The robot application must have a numbered applicationVersion for\n consistency reasons. To create a new version, use CreateRobotApplicationVersion or see \n Creating a Robot Application Version.\n

\n \n

After 90 days, deployment jobs expire and will be deleted. They will no longer be\n accessible.

\n ", "smithy.api#http": { "method": "POST", "uri": "/createDeploymentJob", @@ -790,7 +790,7 @@ "smithy.api#deprecated": { "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Creates a fleet, a logical group of robots running the same robot application.

\n \n

This API is no longer supported and will throw an error if used.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.

\n \n

Creates a fleet, a logical group of robots running the same robot application.

", "smithy.api#http": { "method": "POST", "uri": "/createFleet", @@ -886,7 +886,7 @@ "smithy.api#deprecated": { "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Creates a robot.

\n \n

This API is no longer supported and will throw an error if used.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.

\n \n

Creates a robot.

", "smithy.api#http": { "method": "POST", "uri": "/createRobot", @@ -923,7 +923,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a robot application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a robot application.

", "smithy.api#http": { "method": "POST", "uri": "/createRobotApplication", @@ -950,7 +950,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

The robot software suite (ROS distribuition) used by the robot application.

", + "smithy.api#documentation": "

The robot software suite used by the robot application.

", "smithy.api#required": {} } }, @@ -1001,7 +1001,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

The robot software suite (ROS distribution) used by the robot application.

" + "smithy.api#documentation": "

The robot software suite used by the robot application.

" } }, "lastUpdatedAt": { @@ -1059,7 +1059,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a version of a robot application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a version of a robot application.

", "smithy.api#http": { "method": "POST", "uri": "/createRobotApplicationVersion", @@ -1130,7 +1130,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

The robot software suite (ROS distribution) used by the robot application.

" + "smithy.api#documentation": "

The robot software suite used by the robot application.

" } }, "lastUpdatedAt": { @@ -1270,7 +1270,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a simulation application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a simulation application.

", "smithy.api#http": { "method": "POST", "uri": "/createSimulationApplication", @@ -1304,7 +1304,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

The robot software suite (ROS distribution) used by the simulation application.

", + "smithy.api#documentation": "

The robot software suite used by the simulation application.

", "smithy.api#required": {} } }, @@ -1367,7 +1367,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

Information about the robot software suite (ROS distribution).

" + "smithy.api#documentation": "

Information about the robot software suite.

" } }, "renderingEngine": { @@ -1431,7 +1431,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a simulation application with a specific revision id.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a simulation application with a specific revision id.

", "smithy.api#http": { "method": "POST", "uri": "/createSimulationApplicationVersion", @@ -1508,7 +1508,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

Information about the robot software suite (ROS distribution).

" + "smithy.api#documentation": "

Information about the robot software suite.

" } }, "renderingEngine": { @@ -1572,7 +1572,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a simulation job.

\n \n

After 90 days, simulation jobs expire and will be deleted. They will no longer be\n accessible.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a simulation job.

\n \n

After 90 days, simulation jobs expire and will be deleted. They will no longer be\n accessible.

\n ", "smithy.api#http": { "method": "POST", "uri": "/createSimulationJob", @@ -1823,7 +1823,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a world export job.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a world export job.

", "smithy.api#http": { "method": "POST", "uri": "/createWorldExportJob", @@ -1957,7 +1957,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates worlds using the specified template.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates worlds using the specified template.

", "smithy.api#http": { "method": "POST", "uri": "/createWorldGenerationJob", @@ -2097,7 +2097,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a world template.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Creates a world template.

", "smithy.api#http": { "method": "POST", "uri": "/createWorldTemplate", @@ -2333,7 +2333,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Deletes a fleet.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Deletes a fleet.

", "smithy.api#http": { "method": "POST", "uri": "/deleteFleet", @@ -2392,7 +2392,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Deletes a robot.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Deletes a robot.

", "smithy.api#http": { "method": "POST", "uri": "/deleteRobot", @@ -2420,7 +2420,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a robot application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Deletes a robot application.

", "smithy.api#http": { "method": "POST", "uri": "/deleteRobotApplication", @@ -2504,7 +2504,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a simulation application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Deletes a simulation application.

", "smithy.api#http": { "method": "POST", "uri": "/deleteSimulationApplication", @@ -2563,7 +2563,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a world template.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Deletes a world template.

", "smithy.api#http": { "method": "POST", "uri": "/deleteWorldTemplate", @@ -3003,7 +3003,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Deregisters a robot.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Deregisters a robot.

", "smithy.api#http": { "method": "POST", "uri": "/deregisterRobot", @@ -3085,7 +3085,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Describes a deployment job.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Describes a deployment job.

", "smithy.api#http": { "method": "POST", "uri": "/describeDeploymentJob", @@ -3208,7 +3208,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Describes a fleet.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Describes a fleet.

", "smithy.api#http": { "method": "POST", "uri": "/describeFleet", @@ -3319,7 +3319,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Describes a robot.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

Describes a robot.

", "smithy.api#http": { "method": "POST", "uri": "/describeRobot", @@ -3350,7 +3350,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a robot application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a robot application.

", "smithy.api#http": { "method": "POST", "uri": "/describeRobotApplication", @@ -3409,7 +3409,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

The robot software suite (ROS distribution) used by the robot application.

" + "smithy.api#documentation": "

The robot software suite used by the robot application.

" } }, "revisionId": { @@ -3559,7 +3559,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a simulation application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a simulation application.

", "smithy.api#http": { "method": "POST", "uri": "/describeSimulationApplication", @@ -3624,7 +3624,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

Information about the robot software suite (ROS distribution).

" + "smithy.api#documentation": "

Information about the robot software suite.

" } }, "renderingEngine": { @@ -3691,7 +3691,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a simulation job.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a simulation job.

", "smithy.api#http": { "method": "POST", "uri": "/describeSimulationJob", @@ -3719,7 +3719,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a simulation job batch.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a simulation job batch.

", "smithy.api#http": { "method": "POST", "uri": "/describeSimulationJobBatch", @@ -3996,7 +3996,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a world.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a world.

", "smithy.api#http": { "method": "POST", "uri": "/describeWorld", @@ -4027,7 +4027,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a world export job.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a world export job.

", "smithy.api#http": { "method": "POST", "uri": "/describeWorldExportJob", @@ -4138,7 +4138,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a world generation job.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a world generation job.

", "smithy.api#http": { "method": "POST", "uri": "/describeWorldGenerationJob", @@ -4317,7 +4317,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a world template.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Describes a world template.

", "smithy.api#http": { "method": "POST", "uri": "/describeWorldTemplate", @@ -4710,7 +4710,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the world template body.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Gets the world template body.

", "smithy.api#http": { "method": "POST", "uri": "/getWorldTemplateBody", @@ -4936,7 +4936,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

\n Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.\n

", "smithy.api#http": { "method": "POST", "uri": "/listDeploymentJobs", @@ -5028,7 +5028,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

\n Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.\n

", "smithy.api#http": { "method": "POST", "uri": "/listFleets", @@ -5114,7 +5114,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of robot application. You can optionally provide filters to retrieve\n specific robot applications.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Returns a list of robot application. You can optionally provide filters to retrieve\n specific robot applications.

", "smithy.api#http": { "method": "POST", "uri": "/listRobotApplications", @@ -5206,7 +5206,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Returns a list of robots. You can optionally provide filters to retrieve specific robots.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

\n Returns a list of robots. You can optionally provide filters to retrieve specific robots.\n

", "smithy.api#http": { "method": "POST", "uri": "/listRobots", @@ -5292,7 +5292,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of simulation applications. You can optionally provide filters to\n retrieve specific simulation applications.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Returns a list of simulation applications. You can optionally provide filters to\n retrieve specific simulation applications.

", "smithy.api#http": { "method": "POST", "uri": "/listSimulationApplications", @@ -5375,7 +5375,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list simulation job batches. You can optionally provide filters to retrieve\n specific simulation batch jobs.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Returns a list simulation job batches. You can optionally provide filters to retrieve\n specific simulation batch jobs.

", "smithy.api#http": { "method": "POST", "uri": "/listSimulationJobBatches", @@ -5455,7 +5455,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of simulation jobs. You can optionally provide filters to retrieve\n specific simulation jobs.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Returns a list of simulation jobs. You can optionally provide filters to retrieve\n specific simulation jobs.

", "smithy.api#http": { "method": "POST", "uri": "/listSimulationJobs", @@ -5539,7 +5539,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags on a AWS RoboMaker resource.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists all tags on a AWS RoboMaker resource.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -5597,7 +5597,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists world export jobs.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists world export jobs.

", "smithy.api#http": { "method": "POST", "uri": "/listWorldExportJobs", @@ -5678,7 +5678,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists world generator jobs.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists world generator jobs.

", "smithy.api#http": { "method": "POST", "uri": "/listWorldGenerationJobs", @@ -5759,7 +5759,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists world templates.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists world templates.

", "smithy.api#http": { "method": "POST", "uri": "/listWorldTemplates", @@ -5833,7 +5833,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists worlds.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Lists worlds.

", "smithy.api#http": { "method": "POST", "uri": "/listWorlds", @@ -6154,7 +6154,7 @@ "smithy.api#deprecated": { "message": "AWS RoboMaker is unable to process this request as the support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Registers a robot with a fleet.

\n \n

This API is no longer supported and will throw an error if used.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Registers a robot with a fleet.

\n \n

This API is no longer supported and will throw an error if used. For more information, see the January 31, 2022 update in the Support policy page.

\n ", "smithy.api#http": { "method": "POST", "uri": "/registerRobot", @@ -6313,7 +6313,7 @@ } ], "traits": { - "smithy.api#documentation": "

Restarts a running simulation job.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Restarts a running simulation job.

", "smithy.api#http": { "method": "POST", "uri": "/restartSimulationJob", @@ -6533,7 +6533,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

Information about a robot software suite (ROS distribution).

" + "smithy.api#documentation": "

Information about a robot software suite.

" } } }, @@ -6650,18 +6650,18 @@ "name": { "target": "com.amazonaws.robomaker#RobotSoftwareSuiteType", "traits": { - "smithy.api#documentation": "

The name of the robot software suite (ROS distribution).

" + "smithy.api#documentation": "

The name of the robot software suite. General is the only supported value.

" } }, "version": { "target": "com.amazonaws.robomaker#RobotSoftwareSuiteVersionType", "traits": { - "smithy.api#documentation": "

The version of the robot software suite (ROS distribution).

" + "smithy.api#documentation": "

The version of the robot software suite. Not applicable for General software suite.

" } } }, "traits": { - "smithy.api#documentation": "

Information about a robot software suite (ROS distribution).

" + "smithy.api#documentation": "

Information about a robot software suite.

" } }, "com.amazonaws.robomaker#RobotSoftwareSuiteType": { @@ -6937,7 +6937,7 @@ "worldConfigs": { "target": "com.amazonaws.robomaker#WorldConfigs", "traits": { - "smithy.api#documentation": "

A list of world configurations.

" + "smithy.api#documentation": "

A list of world configurations.

\n \n

This API is no longer supported and will throw an error if used.

\n " } }, "useDefaultUploadConfigurations": { @@ -7029,7 +7029,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

Information about a robot software suite (ROS distribution).

" + "smithy.api#documentation": "

Information about a robot software suite.

" } }, "simulationSoftwareSuite": { @@ -7267,7 +7267,7 @@ "lastUpdatedAt": { "target": "com.amazonaws.robomaker#LastUpdatedAt", "traits": { - "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job batch was last\n updated.

" + "smithy.api#documentation": "

The time, in milliseconds since the epoch, when the simulation job batch was last updated.\n

" } }, "createdAt": { @@ -7717,13 +7717,13 @@ "name": { "target": "com.amazonaws.robomaker#SimulationSoftwareSuiteType", "traits": { - "smithy.api#documentation": "

The name of the simulation software suite.

" + "smithy.api#documentation": "

The name of the simulation software suite. SimulationRuntime is the only supported value.

" } }, "version": { "target": "com.amazonaws.robomaker#SimulationSoftwareSuiteVersionType", "traits": { - "smithy.api#documentation": "

The version of the simulation software suite.

" + "smithy.api#documentation": "

The version of the simulation software suite. Not applicable for SimulationRuntime.

" } } }, @@ -7875,7 +7875,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new simulation job batch. The batch is defined using one or more\n SimulationJobRequest objects.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Starts a new simulation job batch. The batch is defined using one or more\n SimulationJobRequest objects.

", "smithy.api#http": { "method": "POST", "uri": "/startSimulationJobBatch", @@ -8038,7 +8038,7 @@ "smithy.api#deprecated": { "message": "Support for the AWS RoboMaker application deployment feature has ended. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/fleets.html." }, - "smithy.api#documentation": "

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

\n \n

This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service.

\n ", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n \n

This API is no longer supported. For more information, see the May 2, 2022 update in the Support policy page.

\n \n

\n Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.\n

", "smithy.api#http": { "method": "POST", "uri": "/syncDeploymentJob", @@ -8185,7 +8185,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or edits tags for a AWS RoboMaker resource.

\n

Each tag consists of a tag key and a tag value. Tag keys and tag values are both\n required, but tag values can be empty strings.

\n

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management\n User Guide.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Adds or edits tags for a AWS RoboMaker resource.

\n

Each tag consists of a tag key and a tag value. Tag keys and tag values are both\n required, but tag values can be empty strings.

\n

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management\n User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -8407,7 +8407,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified AWS RoboMaker resource.

\n

To remove a tag, specify the tag key. To change the tag value of an existing tag key,\n use \n TagResource\n .

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Removes the specified tags from the specified AWS RoboMaker resource.

\n

To remove a tag, specify the tag key. To change the tag value of an existing tag key,\n use \n TagResource\n .

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", @@ -8472,7 +8472,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a robot application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Updates a robot application.

", "smithy.api#http": { "method": "POST", "uri": "/updateRobotApplication", @@ -8499,7 +8499,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

The robot software suite (ROS distribution) used by the robot application.

", + "smithy.api#documentation": "

The robot software suite used by the robot application.

", "smithy.api#required": {} } }, @@ -8550,7 +8550,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

The robot software suite (ROS distribution) used by the robot application.

" + "smithy.api#documentation": "

The robot software suite used by the robot application.

" } }, "lastUpdatedAt": { @@ -8602,7 +8602,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a simulation application.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Updates a simulation application.

", "smithy.api#http": { "method": "POST", "uri": "/updateSimulationApplication", @@ -8636,7 +8636,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

Information about the robot software suite (ROS distribution).

", + "smithy.api#documentation": "

Information about the robot software suite.

", "smithy.api#required": {} } }, @@ -8699,7 +8699,7 @@ "robotSoftwareSuite": { "target": "com.amazonaws.robomaker#RobotSoftwareSuite", "traits": { - "smithy.api#documentation": "

Information about the robot software suite (ROS distribution).

" + "smithy.api#documentation": "

Information about the robot software suite.

" } }, "renderingEngine": { @@ -8754,7 +8754,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates a world template.

", + "smithy.api#documentation": "\n

End of support notice: On September 10, 2025, Amazon Web Services\n will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will\n no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. \n For more information on transitioning to Batch to help run containerized\n simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.\n

\n \n

Updates a world template.

", "smithy.api#http": { "method": "POST", "uri": "/updateWorldTemplate", @@ -8850,7 +8850,7 @@ "name": { "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the\n simulation output location to determine the final path.

\n

For example, if your simulation output location is s3://my-bucket and your\n upload configuration name is robot-test, your files will be uploaded to\n s3://my-bucket///robot-test.

", + "smithy.api#documentation": "

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the\n simulation output location to determine the final path.

\n

For example, if your simulation output location is s3://amzn-s3-demo-bucket and your\n upload configuration name is robot-test, your files will be uploaded to\n s3://amzn-s3-demo-bucket///robot-test.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/route53resolver.json b/codegen/sdk/aws-models/route53resolver.json index 0ca0cefc6de..531e53abe8d 100644 --- a/codegen/sdk/aws-models/route53resolver.json +++ b/codegen/sdk/aws-models/route53resolver.json @@ -1057,7 +1057,7 @@ "DestinationArn": { "target": "com.amazonaws.route53resolver#DestinationArn", "traits": { - "smithy.api#documentation": "

The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, \n\t\t\tor a Kinesis Data Firehose delivery stream. Examples of valid values include the following:

\n
    \n
  • \n

    \n S3 bucket:

    \n

    \n arn:aws:s3:::examplebucket\n

    \n

    You can optionally append a file prefix to the end of the ARN.

    \n

    \n arn:aws:s3:::examplebucket/development/\n

    \n
    • \n
  • \n

    \n CloudWatch Logs log group:

    \n

    \n arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*\n

    \n
    • \n
  • \n

    \n Kinesis Data Firehose delivery stream:

    \n

    \n arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name\n

    \n
    • \n
", + "smithy.api#documentation": "

The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, \n\t\t\tor a Kinesis Data Firehose delivery stream. Examples of valid values include the following:

\n
    \n
  • \n

    \n S3 bucket:

    \n

    \n arn:aws:s3:::amzn-s3-demo-bucket\n

    \n

    You can optionally append a file prefix to the end of the ARN.

    \n

    \n arn:aws:s3:::amzn-s3-demo-bucket/development/\n

    \n
    • \n
  • \n

    \n CloudWatch Logs log group:

    \n

    \n arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*\n

    \n
    • \n
  • \n

    \n Kinesis Data Firehose delivery stream:

    \n

    \n arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -7961,6 +7961,15 @@ "target": "com.amazonaws.route53resolver#ResourceId" } }, + "com.amazonaws.route53resolver#ServerNameIndication": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, "com.amazonaws.route53resolver#ServicePrinciple": { "type": "string", "traits": { @@ -8206,6 +8215,12 @@ "traits": { "smithy.api#documentation": "

\n\t\t\tThe protocols for the Resolver endpoints. DoH-FIPS is applicable for inbound endpoints only.\n\t\t\t\n\t\t

\n

For an inbound endpoint you can apply the protocols as follows:

\n
    \n
  • \n

    Do53 and DoH in combination.

    \n
    • \n
  • \n

    Do53 and DoH-FIPS in combination.

    \n
    • \n
  • \n

    Do53 alone.

    \n
    • \n
  • \n

    DoH alone.

    \n
    • \n
  • \n

    DoH-FIPS alone.

    \n
    • \n
  • \n

    None, which is treated as Do53.

    \n
    • \n
\n

For an outbound endpoint you can apply the protocols as follows:

\n
    \n
  • \n

    Do53 and DoH in combination.

    \n
    • \n
  • \n

    Do53 alone.

    \n
    • \n
  • \n

    DoH alone.

    \n
    • \n
  • \n

    None, which is treated as Do53.

    \n
    • \n
" } + }, + "ServerNameIndication": { + "target": "com.amazonaws.route53resolver#ServerNameIndication", + "traits": { + "smithy.api#documentation": "

\n\t\t\tThe Server Name Indication of the DoH server that you want to forward queries to. \n\t\t\tThis is only used if the Protocol of the TargetAddress is DoH.\n\t\t

" + } } }, "traits": { @@ -8648,7 +8663,7 @@ "Qtype": { "target": "com.amazonaws.route53resolver#Qtype", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t

\n
    \n
  • \n

    \n\t\t\t\tA: Returns an IPv4 address.

    \n
    • \n
  • \n

    AAAA: Returns an Ipv6 address.

    \n
    • \n
  • \n

    CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

    \n
    • \n
  • \n

    CNAME: Returns another domain name.

    \n
    • \n
  • \n

    DS: Record that identifies the DNSSEC signing key of a delegated zone.

    \n
    • \n
  • \n

    MX: Specifies mail servers.

    \n
    • \n
  • \n

    NAPTR: Regular-expression-based rewriting of domain names.

    \n
    • \n
  • \n

    NS: Authoritative name servers.

    \n
    • \n
  • \n

    PTR: Maps an IP address to a domain name.

    \n
    • \n
  • \n

    SOA: Start of authority record for the zone.

    \n
    • \n
  • \n

    SPF: Lists the servers authorized to send emails from a domain.

    \n
    • \n
  • \n

    SRV: Application specific values that identify servers.

    \n
    • \n
  • \n

    TXT: Verifies email senders and application-specific values.

    \n
    • \n
  • \n

    A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be\n\t\t\t\tdefined as TYPENUMBER, where the\n\t\t\t\tNUMBER can be 1-65334, for\n\t\t\t\texample, TYPE28. For more information, see \n\t\t\t\tList of DNS record types.

    \n
    • \n
" + "smithy.api#documentation": "

\n\t\t\tThe DNS query type you want the rule to evaluate. Allowed values are;\n\t\t

\n
    \n
  • \n

    \n\t\t\t\tA: Returns an IPv4 address.

    \n
    • \n
  • \n

    AAAA: Returns an Ipv6 address.

    \n
    • \n
  • \n

    CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

    \n
    • \n
  • \n

    CNAME: Returns another domain name.

    \n
    • \n
  • \n

    DS: Record that identifies the DNSSEC signing key of a delegated zone.

    \n
    • \n
  • \n

    MX: Specifies mail servers.

    \n
    • \n
  • \n

    NAPTR: Regular-expression-based rewriting of domain names.

    \n
    • \n
  • \n

    NS: Authoritative name servers.

    \n
    • \n
  • \n

    PTR: Maps an IP address to a domain name.

    \n
    • \n
  • \n

    SOA: Start of authority record for the zone.

    \n
    • \n
  • \n

    SPF: Lists the servers authorized to send emails from a domain.

    \n
    • \n
  • \n

    SRV: Application specific values that identify servers.

    \n
    • \n
  • \n

    TXT: Verifies email senders and application-specific values.

    \n
    • \n
  • \n

    A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be\n\t\t\t\tdefined as TYPENUMBER, where the\n\t\t\t\tNUMBER can be 1-65334, for\n\t\t\t\texample, TYPE28. For more information, see \n\t\t\t\tList of DNS record types.

    \n \n

    If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, \n\t\t\t\t\tthis action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.

    \n     \n
    • \n
" } } }, diff --git a/codegen/sdk/aws-models/s3.json b/codegen/sdk/aws-models/s3.json index f8a2be8c1a8..eb0e8e0f028 100644 --- a/codegen/sdk/aws-models/s3.json +++ b/codegen/sdk/aws-models/s3.json @@ -17661,6 +17661,12 @@ "traits": { "smithy.api#documentation": "

Date the bucket was created. This date can change when making changes to your bucket,\n such as editing its bucket policy.

" } + }, + "BucketRegion": { + "target": "com.amazonaws.s3#BucketRegion", + "traits": { + "smithy.api#documentation": "

\n BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.

" + } } }, "traits": { @@ -17984,6 +17990,9 @@ "com.amazonaws.s3#BucketName": { "type": "string" }, + "com.amazonaws.s3#BucketRegion": { + "type": "string" + }, "com.amazonaws.s3#BucketType": { "type": "enum", "members": { @@ -18207,13 +18216,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumSHA1": { @@ -18371,13 +18380,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumSHA1": { @@ -18476,14 +18485,14 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32c" } }, @@ -18575,13 +18584,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumSHA1": { @@ -18987,7 +18996,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request response.

\n

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket.\n When copying an object, if you don't specify encryption information in your copy\n request, the encryption setting of the target object is set to the default\n encryption configuration of the destination bucket. By default, all buckets have a\n base level of encryption configuration that uses server-side encryption with Amazon S3\n managed keys (SSE-S3). If the destination bucket has a different default encryption\n configuration, Amazon S3 uses\n the corresponding encryption key to encrypt the target\n object copy.

\n

With server-side\n encryption, Amazon S3 encrypts your data as it writes your data to disks in its data\n centers and decrypts the data when you access it. For more information about server-side encryption, see Using\n Server-Side Encryption in the\n Amazon S3 User Guide.

\n

\n General purpose buckets \n

\n
    \n
  • \n

    For general purpose buckets, there are the following supported options for server-side encryption: server-side encryption with Key Management Service (KMS) keys\n (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and \n server-side encryption with customer-provided encryption keys (SSE-C). Amazon S3 uses\n the corresponding KMS key, or a customer-provided key to encrypt the target\n object copy.

    \n
    • \n
  • \n

    When you perform a CopyObject operation, if you want to use a\n different type of encryption setting for the target object, you can specify \n appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a\n KMS key, or a customer-provided key. If the encryption setting in\n your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence.

    \n
    • \n
\n

\n Directory buckets \n

\n
    \n
  • \n

    For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    \n
    • \n
  • \n

    To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). \n Amazon Web Services managed key (aws/s3) isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS configuration. \n Then, when you perform a CopyObject operation and want to specify server-side encryption settings for new object copies with SSE-KMS in the encryption-related request headers, you must ensure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration. \n

    \n
    • \n
", + "smithy.api#documentation": "

The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request response.

\n

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket.\n When copying an object, if you don't specify encryption information in your copy\n request, the encryption setting of the target object is set to the default\n encryption configuration of the destination bucket. By default, all buckets have a\n base level of encryption configuration that uses server-side encryption with Amazon S3\n managed keys (SSE-S3). If the destination bucket has a different default encryption\n configuration, Amazon S3 uses\n the corresponding encryption key to encrypt the target\n object copy.

\n

With server-side\n encryption, Amazon S3 encrypts your data as it writes your data to disks in its data\n centers and decrypts the data when you access it. For more information about server-side encryption, see Using\n Server-Side Encryption in the\n Amazon S3 User Guide.

\n

\n General purpose buckets \n

\n
    \n
  • \n

    For general purpose buckets, there are the following supported options for server-side encryption: server-side encryption with Key Management Service (KMS) keys\n (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and \n server-side encryption with customer-provided encryption keys (SSE-C). Amazon S3 uses\n the corresponding KMS key, or a customer-provided key to encrypt the target\n object copy.

    \n
    • \n
  • \n

    When you perform a CopyObject operation, if you want to use a\n different type of encryption setting for the target object, you can specify \n appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a\n KMS key, or a customer-provided key. If the encryption setting in\n your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence.

    \n
    • \n
\n

\n Directory buckets \n

\n
    \n
  • \n

    For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    \n
    • \n
  • \n

    To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). \n The Amazon Web Services managed key (aws/s3) isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS configuration. \n Then, when you perform a CopyObject operation and want to specify server-side encryption settings for new object copies with SSE-KMS in the encryption-related request headers, you must ensure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration. \n

    \n
    • \n
", "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, @@ -19029,7 +19038,7 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an\n object protected by KMS will fail if they're not made via SSL or using SigV4. For\n information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see\n Specifying the\n Signature Version in Request Authentication in the\n Amazon S3 User Guide.

\n

\n Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, you must specify the \n x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS \n symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nAmazon Web Services managed key (aws/s3) isn't supported. \n

", + "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an\n object protected by KMS will fail if they're not made via SSL or using SigV4. For\n information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see\n Specifying the\n Signature Version in Request Authentication in the\n Amazon S3 User Guide.

\n

\n Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the \n x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS \n symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. \n If you want to specify the \n x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS \n customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -19139,13 +19148,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumSHA1": { @@ -19183,13 +19192,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumSHA1": { @@ -19709,7 +19718,7 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same\n account that's issuing the command, you must use the full Key ARN not the Key ID.

\n

\n General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS \n key to use. If you specify\n x-amz-server-side-encryption:aws:kms or\n x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key\n (aws/s3) to protect the data.

\n

\n Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, you must specify the \n x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS \n symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nAmazon Web Services managed key (aws/s3) isn't supported. \n

", + "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same\n account that's issuing the command, you must use the full Key ARN not the Key ID.

\n

\n General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS \n key to use. If you specify\n x-amz-server-side-encryption:aws:kms or\n x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key\n (aws/s3) to protect the data.

\n

\n Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the \n x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS \n symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. \n If you want to specify the \n x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS \n customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -19794,7 +19803,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets. \n For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see \n S3 Express One Zone APIs in the Amazon S3 User Guide. \n

\n

To make Zonal endpoint API requests on a directory bucket, use the CreateSession\n API operation. Specifically, you grant s3express:CreateSession permission to a\n bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the\n CreateSession API request on the bucket, which returns temporary security\n credentials that include the access key ID, secret access key, session token, and\n expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After\n the session is created, you don’t need to use other policies to grant permissions to each\n Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by\n applying the temporary security credentials of the session to the request headers and\n following the SigV4 protocol for authentication. You also apply the session token to the\n x-amz-s3session-token request header for authorization. Temporary security\n credentials are scoped to the bucket and expire after 5 minutes. After the expiration time,\n any calls that you make with those credentials will fail. You must use IAM credentials\n again to make a CreateSession API request that generates a new set of\n temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond\n the original specified interval.

\n

If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid\n service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to\n initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the\n Amazon S3 User Guide.

\n \n
    \n
  • \n

    You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n \n CopyObject API operation - Unlike other Zonal endpoint API operations, the CopyObject API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the CopyObject API operation on directory buckets, see CopyObject.

    \n
    • \n
  • \n

    \n \n HeadBucket API operation - Unlike other Zonal endpoint API operations, the HeadBucket API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the HeadBucket API operation on directory buckets, see HeadBucket.

    \n
    • \n
\n \n
\n
Permissions
\n
\n

To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that\n grants s3express:CreateSession permission to the bucket. In a\n policy, you can have the s3express:SessionMode condition key to\n control who can create a ReadWrite or ReadOnly session.\n For more information about ReadWrite or ReadOnly\n sessions, see \n x-amz-create-session-mode\n . For example policies, see\n Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the\n Amazon S3 User Guide.

\n

To grant cross-account access to Zonal endpoint API operations, the bucket policy should also grant both accounts the s3express:CreateSession permission.

\n

If you want to encrypt objects with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.

\n
\n
Encryption
\n
\n

For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

\n

For Zonal endpoint (object-level) API operations except CopyObject and UploadPartCopy, \nyou authenticate and authorize requests through CreateSession for low latency. \n To encrypt new objects in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). Then, when a session is created for Zonal endpoint API operations, new objects are automatically encrypted and decrypted with SSE-KMS and S3 Bucket Keys during the session.

\n \n

\n Only 1 customer managed key is supported per directory bucket for the lifetime of the bucket. Amazon Web Services managed key (aws/s3) isn't supported. \n After you specify SSE-KMS as your bucket's default encryption configuration with a customer managed key, you can't change the customer managed key for the bucket's SSE-KMS configuration.\n

\n \n

In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, \n you can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) from the CreateSession request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket. \n

\n \n

When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. \n Also, in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n it's not supported to override the values of the encryption settings from the CreateSession request. \n\n

\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n
\n
", + "smithy.api#documentation": "

Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets. \n For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see \n S3 Express One Zone APIs in the Amazon S3 User Guide. \n

\n

To make Zonal endpoint API requests on a directory bucket, use the CreateSession\n API operation. Specifically, you grant s3express:CreateSession permission to a\n bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the\n CreateSession API request on the bucket, which returns temporary security\n credentials that include the access key ID, secret access key, session token, and\n expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After\n the session is created, you don’t need to use other policies to grant permissions to each\n Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by\n applying the temporary security credentials of the session to the request headers and\n following the SigV4 protocol for authentication. You also apply the session token to the\n x-amz-s3session-token request header for authorization. Temporary security\n credentials are scoped to the bucket and expire after 5 minutes. After the expiration time,\n any calls that you make with those credentials will fail. You must use IAM credentials\n again to make a CreateSession API request that generates a new set of\n temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond\n the original specified interval.

\n

If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid\n service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to\n initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the\n Amazon S3 User Guide.

\n \n
    \n
  • \n

    You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n \n CopyObject API operation - Unlike other Zonal endpoint API operations, the CopyObject API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the CopyObject API operation on directory buckets, see CopyObject.

    \n
    • \n
  • \n

    \n \n HeadBucket API operation - Unlike other Zonal endpoint API operations, the HeadBucket API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the HeadBucket API operation on directory buckets, see HeadBucket.

    \n
    • \n
\n \n
\n
Permissions
\n
\n

To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that\n grants s3express:CreateSession permission to the bucket. In a\n policy, you can have the s3express:SessionMode condition key to\n control who can create a ReadWrite or ReadOnly session.\n For more information about ReadWrite or ReadOnly\n sessions, see \n x-amz-create-session-mode\n . For example policies, see\n Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the\n Amazon S3 User Guide.

\n

To grant cross-account access to Zonal endpoint API operations, the bucket policy should also grant both accounts the s3express:CreateSession permission.

\n

If you want to encrypt objects with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.

\n
\n
Encryption
\n
\n

For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

\n

For Zonal endpoint (object-level) API operations except CopyObject and UploadPartCopy, \nyou authenticate and authorize requests through CreateSession for low latency. \n To encrypt new objects in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). Then, when a session is created for Zonal endpoint API operations, new objects are automatically encrypted and decrypted with SSE-KMS and S3 Bucket Keys during the session.

\n \n

\n Only 1 customer managed key is supported per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn't supported. \n After you specify SSE-KMS as your bucket's default encryption configuration with a customer managed key, you can't change the customer managed key for the bucket's SSE-KMS configuration.\n

\n \n

In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, \n you can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) from the CreateSession request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket. \n

\n \n

When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. \n Also, in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n it's not supported to override the values of the encryption settings from the CreateSession request. \n\n

\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n
\n
", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?session", @@ -19848,7 +19857,8 @@ } }, "traits": { - "smithy.api#output": {} + "smithy.api#output": {}, + "smithy.api#xmlName": "CreateSessionResult" } }, "com.amazonaws.s3#CreateSessionRequest": { @@ -19882,7 +19892,7 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

If you specify x-amz-server-side-encryption with aws:kms, you must specify the \n x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS \n symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Also, if the KMS key doesn't exist in the same\n account that't issuing the command, you must use the full Key ARN not the Key ID.

\n

Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nAmazon Web Services managed key (aws/s3) isn't supported. \n

", + "smithy.api#documentation": "

If you specify x-amz-server-side-encryption with aws:kms, you must specify the \n x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS \n symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Also, if the KMS key doesn't exist in the same\n account that't issuing the command, you must use the full Key ARN not the Key ID.

\n

Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -20782,7 +20792,7 @@ "target": "com.amazonaws.s3#DeleteObjectOutput" }, "traits": { - "smithy.api#documentation": "

Removes an object from a bucket. The behavior depends on the bucket's versioning state:

\n
    \n
  • \n

    If bucket versioning is not enabled, the operation permanently deletes the object.

    \n
    • \n
  • \n

    If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s versionId in the request. For more information about versioning-enabled buckets, see Deleting object versions from a versioning-enabled bucket.

    \n
    • \n
  • \n

    If bucket versioning is suspended, the operation removes the object that has a null versionId, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null versionId, and all versions of the object have a versionId, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a versionId, you must include the object’s versionId in the request. For more information about versioning-suspended buckets, see Deleting objects from versioning-suspended buckets.

    \n
    • \n
\n \n
    \n
  • \n

    \n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null \n to the versionId query parameter in the request.

    \n
    • \n
  • \n

    \n Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

    \n
    • \n
\n \n

To remove a specific version, you must use the versionId query parameter. Using this\n query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3\n sets the response header x-amz-delete-marker to true.

\n

If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa request\n header in the DELETE versionId request. Requests that include\n x-amz-mfa must use HTTPS. For more information about MFA Delete, see Using MFA Delete in the Amazon S3\n User Guide. To see sample\n requests that use versioning, see Sample\n Request.

\n \n

\n Directory buckets - MFA delete is not supported by directory buckets.

\n \n

You can delete objects by explicitly calling DELETE Object or calling \n (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block\n users or accounts from removing or deleting objects from your bucket, you must deny them\n the s3:DeleteObject, s3:DeleteObjectVersion, and\n s3:PutLifeCycleConfiguration actions.

\n \n

\n Directory buckets - S3 Lifecycle is not supported by directory buckets.

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The following permissions are required in your policies when your \n DeleteObjects request includes specific headers.

    \n
      \n
    • \n

      \n \n s3:DeleteObject\n - To delete an object from a bucket, you must always have the s3:DeleteObject permission.

      \n
      • \n
    • \n

      \n \n s3:DeleteObjectVersion\n - To delete a specific version of an object from a versioning-enabled bucket, you must have the s3:DeleteObjectVersion permission.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n
\n
\n

The following action is related to DeleteObject:

\n ", + "smithy.api#documentation": "

Removes an object from a bucket. The behavior depends on the bucket's versioning state.\n For more information, see Best\n practices to consider before deleting an object.

\n

To remove a specific version, you must use the versionId query parameter.\n Using this query parameter permanently deletes the version. If the object deleted is a\n delete marker, Amazon S3 sets the response header x-amz-delete-marker to true. If\n the object you want to delete is in a bucket where the bucket versioning configuration is\n MFA delete enabled, you must include the x-amz-mfa request header in the\n DELETE versionId request. Requests that include x-amz-mfa must\n use HTTPS. For more information about MFA delete and to see example requests, see Using MFA\n delete and Sample\n request in the Amazon S3 User Guide.

\n \n
    \n
  • \n

    S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the\n versionId query parameter in the request.

    \n
    • \n
  • \n

    For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    MFA delete is not supported by directory buckets.

    \n
    • \n
\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The\n following permissions are required in your policies when your\n DeleteObjects request includes specific headers.

    \n
      \n
    • \n

      \n \n s3:DeleteObject\n \n - To delete an object from a bucket, you must always have the\n s3:DeleteObject permission.

      \n \n

      You can also use PutBucketLifecycle to delete\n objects in Amazon S3.

      \n       \n
      • \n
    • \n

      \n \n s3:DeleteObjectVersion\n - To delete a specific version of an object from a\n versioning-enabled bucket, you must have the\n s3:DeleteObjectVersion permission.

      \n
      • \n
    • \n

      If you want to block users or accounts from removing or deleting\n objects from your bucket, you must deny them the\n s3:DeleteObject, s3:DeleteObjectVersion,\n and s3:PutLifeCycleConfiguration permissions.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory buckets permissions -\n To grant access to this API operation on a directory bucket, we recommend\n that you use the CreateSession API operation for\n session-based authorization.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n
\n
\n

The following action is related to DeleteObject:

\n ", "smithy.api#examples": [ { "title": "To delete an object (from a non-versioned bucket)", @@ -21137,7 +21147,7 @@ "ChecksumAlgorithm": { "target": "com.amazonaws.s3#ChecksumAlgorithm", "traits": { - "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    CRC32

    \n
    • \n
  • \n

    CRC32C

    \n
    • \n
  • \n

    SHA1

    \n
    • \n
  • \n

    SHA256

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    \n CRC32\n

    \n
    • \n
  • \n

    \n CRC32C\n

    \n
    • \n
  • \n

    \n SHA1\n

    \n
    • \n
  • \n

    \n SHA256\n

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n

If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.

", "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" } } @@ -22335,6 +22345,13 @@ "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Rule" } + }, + "TransitionDefaultMinimumObjectSize": { + "target": "com.amazonaws.s3#TransitionDefaultMinimumObjectSize", + "traits": { + "smithy.api#documentation": "

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

\n
    \n
  • \n

    \n all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

    \n
    • \n
  • \n

    \n varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.\n

    \n
    • \n
\n

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

", + "smithy.api#httpHeader": "x-amz-transition-default-minimum-object-size" + } } }, "traits": { @@ -23519,7 +23536,8 @@ } }, "traits": { - "smithy.api#output": {} + "smithy.api#output": {}, + "smithy.api#xmlName": "GetObjectAttributesResponse" } }, "com.amazonaws.s3#GetObjectAttributesParts": { @@ -23860,14 +23878,14 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. For more information, see \n Checking object integrity in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32c" } }, @@ -24824,7 +24842,7 @@ } ], "traits": { - "smithy.api#documentation": "

The HEAD operation retrieves metadata from an object without returning the\n object itself. This operation is useful if you're interested only in an object's metadata.

\n \n

A HEAD request has the same options as a GET operation on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not\n Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. \n It's not possible to retrieve the exact exception of these error codes.

\n \n

Request headers are limited to 8 KB in size. For more information, see Common\n Request Headers.

\n
\n
Permissions
\n
\n

\n
    \n
  • \n

    \n General purpose bucket permissions - To\n use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation.\n For more information, see Actions, resources, and condition\n keys for Amazon S3 in the Amazon S3\n User Guide.

    \n

    If the object you request doesn't exist, the error that\n Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the bucket, Amazon S3\n returns an HTTP status code 404 Not Found error.

      \n
      • \n
    • \n

      If you don’t have the s3:ListBucket permission, Amazon S3 returns\n an HTTP status code 403 Forbidden error.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If you enable x-amz-checksum-mode in the request and the object is encrypted with\n Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

    \n
    • \n
\n
\n
Encryption
\n
\n \n

Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for HEAD requests if your object uses server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3\n managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. \n If you include this header in a HEAD request for an object that uses these types of keys, \n you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.

\n \n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:

\n
    \n
  • \n

    \n x-amz-server-side-encryption-customer-algorithm\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key-MD5\n

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3\n User Guide.

\n \n

\n Directory bucket - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

\n \n
\n
Versioning
\n
\n
    \n
  • \n

    If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

    \n
    • \n
  • \n

    If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

    \n
    • \n
\n \n
    \n
  • \n

    \n Directory buckets - Delete marker is not supported by directory buckets.

    \n
    • \n
  • \n

    \n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null \n to the versionId query parameter in the request.

    \n
    • \n
\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n \n

For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

\n \n
\n
\n

The following actions are related to HeadObject:

\n ", + "smithy.api#documentation": "

The HEAD operation retrieves metadata from an object without returning the\n object itself. This operation is useful if you're interested only in an object's metadata.

\n \n

A HEAD request has the same options as a GET operation on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not\n Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. \n It's not possible to retrieve the exact exception of these error codes.

\n \n

Request headers are limited to 8 KB in size. For more information, see Common\n Request Headers.

\n
\n
Permissions
\n
\n

\n
    \n
  • \n

    \n General purpose bucket permissions - To\n use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation.\n For more information, see Actions, resources, and condition\n keys for Amazon S3 in the Amazon S3\n User Guide. For more information about the permissions to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations in the Amazon S3 User Guide.

    \n

    If the object you request doesn't exist, the error that\n Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

    \n
      \n
    • \n

      If you have the s3:ListBucket permission on the bucket, Amazon S3\n returns an HTTP status code 404 Not Found error.

      \n
      • \n
    • \n

      If you don’t have the s3:ListBucket permission, Amazon S3 returns\n an HTTP status code 403 Forbidden error.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession\n .

    \n

    If you enable x-amz-checksum-mode in the request and the object is encrypted with\n Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the\n kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

    \n
    • \n
\n
\n
Encryption
\n
\n \n

Encryption request headers, like x-amz-server-side-encryption,\n should not be sent for HEAD requests if your object uses server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3\n managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. \n If you include this header in a HEAD request for an object that uses these types of keys, \n you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.

\n \n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:

\n
    \n
  • \n

    \n x-amz-server-side-encryption-customer-algorithm\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key\n

    \n
    • \n
  • \n

    \n x-amz-server-side-encryption-customer-key-MD5\n

    \n
    • \n
\n

For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3\n User Guide.

\n \n

\n Directory bucket - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

\n \n
\n
Versioning
\n
\n
    \n
  • \n

    If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

    \n
    • \n
  • \n

    If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

    \n
    • \n
\n \n
    \n
  • \n

    \n Directory buckets - Delete marker is not supported by directory buckets.

    \n
    • \n
  • \n

    \n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null \n to the versionId query parameter in the request.

    \n
    • \n
\n \n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com.

\n \n

For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

\n \n
\n
\n

The following actions are related to HeadObject:

\n ", "smithy.api#http": { "method": "HEAD", "uri": "/{Bucket}/{Key+}", @@ -24917,14 +24935,14 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32c" } }, @@ -26077,7 +26095,7 @@ } }, "com.amazonaws.s3#LifecycleRuleFilter": { - "type": "union", + "type": "structure", "members": { "Prefix": { "target": "com.amazonaws.s3#Prefix", @@ -26533,6 +26551,12 @@ "traits": { "smithy.api#documentation": "

\n ContinuationToken is included in the\n response when there are more buckets that can be listed with pagination. The next ListBuckets request to Amazon S3 can be continued with this ContinuationToken. ContinuationToken is obfuscated and is not a real bucket.

" } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

If Prefix was sent with the request, it is included in the response.

\n

All bucket names in the response begin with the specified bucket name prefix.

" + } } }, "traits": { @@ -26556,6 +26580,20 @@ "smithy.api#documentation": "

\n ContinuationToken indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken is obfuscated and is not a real\n key. You can use this ContinuationToken for pagination of the list results.

\n

Length Constraints: Minimum length of 0. Maximum length of 1024.

\n

Required: No.

", "smithy.api#httpQuery": "continuation-token" } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "

Limits the response to bucket names that begin with the specified bucket name prefix.

", + "smithy.api#httpQuery": "prefix" + } + }, + "BucketRegion": { + "target": "com.amazonaws.s3#BucketRegion", + "traits": { + "smithy.api#documentation": "

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

\n \n

Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

\n ", + "smithy.api#httpQuery": "bucket-region" + } } }, "traits": { @@ -26607,7 +26645,8 @@ } }, "traits": { - "smithy.api#output": {} + "smithy.api#output": {}, + "smithy.api#xmlName": "ListAllMyDirectoryBucketsResult" } }, "com.amazonaws.s3#ListDirectoryBucketsRequest": { @@ -28635,13 +28674,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

" + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumSHA1": { @@ -28986,13 +29025,13 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

" + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

" } }, "ChecksumSHA1": { @@ -29226,7 +29265,7 @@ "RestrictPublicBuckets": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#documentation": "

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only Amazon Web Servicesservice principals and authorized users within this account if the bucket has\n a public policy.

\n

Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.

", + "smithy.api#documentation": "

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only Amazon Web Services service principals and authorized users within this account if the bucket has\n a public policy.

\n

Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.

", "smithy.api#xmlName": "RestrictPublicBuckets" } } @@ -29625,7 +29664,7 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "

This operation configures default encryption \n and Amazon S3 Bucket Keys for an existing bucket.

\n \n

\n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

\n \n

By default, all buckets have a default encryption configuration that uses server-side\n encryption with Amazon S3 managed keys (SSE-S3).

\n \n
    \n
  • \n

    \n General purpose buckets\n

    \n
      \n
    • \n

      You can optionally configure default encryption\n for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or\n dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). \n If you specify default encryption by using\n SSE-KMS, you can also configure Amazon S3 Bucket\n Keys. For information about the bucket default\n encryption feature, see Amazon S3 Bucket Default Encryption\n in the Amazon S3 User Guide.\n

      \n
      • \n
    • \n

      If you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 doesn't validate the KMS key ID provided in PutBucketEncryption requests.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory buckets - You can optionally configure default encryption\n for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

    \n
      \n
    • \n

      We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

      \n
      • \n
    • \n

      Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nAmazon Web Services managed key (aws/s3) isn't supported. \n

      \n
      • \n
    • \n

      S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

      \n
      • \n
    • \n

      When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.

      \n
      • \n
    • \n

      For directory buckets, if you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, Amazon S3 validates the KMS key ID provided in PutBucketEncryption requests.

      \n
      • \n
    \n
    • \n
\n \n \n

If you're specifying a customer managed KMS key, we recommend using a fully qualified\n KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a KMS key\n that belongs to the requester, and not the bucket owner.

\n

Also, this action requires Amazon Web Services Signature Version 4. For more information, see \n Authenticating Requests (Amazon Web Services Signature Version 4).

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The s3:PutEncryptionConfiguration permission is required in a policy. \n The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n

    To set a directory bucket default encryption with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

\n
\n
\n

The following operations are related to PutBucketEncryption:

\n ", + "smithy.api#documentation": "

This operation configures default encryption \n and Amazon S3 Bucket Keys for an existing bucket.

\n \n

\n Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name\n . Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.

\n \n

By default, all buckets have a default encryption configuration that uses server-side\n encryption with Amazon S3 managed keys (SSE-S3).

\n \n
    \n
  • \n

    \n General purpose buckets\n

    \n
      \n
    • \n

      You can optionally configure default encryption\n for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or\n dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). \n If you specify default encryption by using\n SSE-KMS, you can also configure Amazon S3 Bucket\n Keys. For information about the bucket default\n encryption feature, see Amazon S3 Bucket Default Encryption\n in the Amazon S3 User Guide.\n

      \n
      • \n
    • \n

      If you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 doesn't validate the KMS key ID provided in PutBucketEncryption requests.

      \n
      • \n
    \n
    • \n
  • \n

    \n Directory buckets - You can optionally configure default encryption\n for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

    \n
      \n
    • \n

      We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession requests or PUT object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

      \n
      • \n
    • \n

      Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

      \n
      • \n
    • \n

      S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

      \n
      • \n
    • \n

      When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.

      \n
      • \n
    • \n

      For directory buckets, if you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, Amazon S3 validates the KMS key ID provided in PutBucketEncryption requests.

      \n
      • \n
    \n
    • \n
\n \n \n

If you're specifying a customer managed KMS key, we recommend using a fully qualified\n KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a KMS key\n that belongs to the requester, and not the bucket owner.

\n

Also, this action requires Amazon Web Services Signature Version 4. For more information, see \n Authenticating Requests (Amazon Web Services Signature Version 4).

\n \n
\n
Permissions
\n
\n
    \n
  • \n

    \n General purpose bucket permissions - The s3:PutEncryptionConfiguration permission is required in a policy. \n The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

    \n
    • \n
  • \n

    \n Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    \n

    To set a directory bucket default encryption with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.

    \n
    • \n
\n
\n
HTTP Host header syntax
\n
\n

\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

\n
\n
\n

The following operations are related to PutBucketEncryption:

\n ", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?encryption", @@ -29815,14 +29854,14 @@ "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.s3#PutBucketLifecycleConfigurationOutput" }, "traits": { "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.

\n \n

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility.\n For the related API description, see PutBucketLifecycle.

\n \n
\n
Rules
\n
\n

You specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3\n Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable.\n Each rule consists of the following:

\n
    \n
  • \n

    A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.

    \n
    • \n
  • \n

    A status indicating whether the rule is in effect.

    \n
    • \n
  • \n

    One or more lifecycle transition and expiration actions that you want\n Amazon S3 to perform on the objects identified by the filter. If the state of\n your bucket is versioning-enabled or versioning-suspended, you can have many\n versions of the same object (one current version and zero or more noncurrent\n versions). Amazon S3 provides predefined actions that you can specify for current\n and noncurrent object versions.

    \n
    • \n
\n

For more information, see Object Lifecycle\n Management and Lifecycle Configuration\n Elements.

\n
\n
Permissions
\n
\n

By default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that created\n it) can access the resource. The resource owner can optionally grant access\n permissions to others by writing an access policy. For this operation, a user must\n get the s3:PutLifecycleConfiguration permission.

\n

You can also explicitly deny permissions. An explicit deny also supersedes any\n other permissions. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them permissions for the\n following actions:

\n
    \n
  • \n

    \n s3:DeleteObject\n

    \n
    • \n
  • \n

    \n s3:DeleteObjectVersion\n

    \n
    • \n
  • \n

    \n s3:PutLifecycleConfiguration\n

    \n
    • \n
\n

For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.

\n
\n
\n

The following operations are related to\n PutBucketLifecycleConfiguration:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.

\n
\n
Rules
\n
\n

You specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3\n Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable.

\n

Bucket lifecycle configuration supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility.\n For the related API description, see PutBucketLifecycle.

\n

A lifecycle rule consists of the following:

\n
    \n
  • \n

    A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.

    \n
    • \n
  • \n

    A status indicating whether the rule is in effect.

    \n
    • \n
  • \n

    One or more lifecycle transition and expiration actions that you want\n Amazon S3 to perform on the objects identified by the filter. If the state of\n your bucket is versioning-enabled or versioning-suspended, you can have many\n versions of the same object (one current version and zero or more noncurrent\n versions). Amazon S3 provides predefined actions that you can specify for current\n and noncurrent object versions.

    \n
    • \n
\n

For more information, see Object Lifecycle\n Management and Lifecycle Configuration\n Elements.

\n
\n
Permissions
\n
\n

By default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that created\n it) can access the resource. The resource owner can optionally grant access\n permissions to others by writing an access policy. For this operation, a user must\n get the s3:PutLifecycleConfiguration permission.

\n

You can also explicitly deny permissions. An explicit deny also supersedes any\n other permissions. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them permissions for the\n following actions:

\n
    \n
  • \n

    \n s3:DeleteObject\n

    \n
    • \n
  • \n

    \n s3:DeleteObjectVersion\n

    \n
    • \n
  • \n

    \n s3:PutLifecycleConfiguration\n

    \n
    • \n
\n

For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.

\n
\n
\n

The following operations are related to\n PutBucketLifecycleConfiguration:

\n ", "smithy.api#examples": [ { "title": "Put bucket lifecycle", @@ -29864,6 +29903,21 @@ } } }, + "com.amazonaws.s3#PutBucketLifecycleConfigurationOutput": { + "type": "structure", + "members": { + "TransitionDefaultMinimumObjectSize": { + "target": "com.amazonaws.s3#TransitionDefaultMinimumObjectSize", + "traits": { + "smithy.api#documentation": "

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

\n
    \n
  • \n

    \n all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

    \n
    • \n
  • \n

    \n varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.\n

    \n
    • \n
\n

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

", + "smithy.api#httpHeader": "x-amz-transition-default-minimum-object-size" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.s3#PutBucketLifecycleConfigurationRequest": { "type": "structure", "members": { @@ -29899,6 +29953,13 @@ "smithy.api#documentation": "

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

", "smithy.api#httpHeader": "x-amz-expected-bucket-owner" } + }, + "TransitionDefaultMinimumObjectSize": { + "target": "com.amazonaws.s3#TransitionDefaultMinimumObjectSize", + "traits": { + "smithy.api#documentation": "

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

\n
    \n
  • \n

    \n all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.

    \n
    • \n
  • \n

    \n varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.\n

    \n
    • \n
\n

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

", + "smithy.api#httpHeader": "x-amz-transition-default-minimum-object-size" + } } }, "traits": { @@ -30278,7 +30339,7 @@ "ChecksumAlgorithm": { "target": "com.amazonaws.s3#ChecksumAlgorithm", "traits": { - "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    CRC32

    \n
    • \n
  • \n

    CRC32C

    \n
    • \n
  • \n

    SHA1

    \n
    • \n
  • \n

    SHA256

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n \n

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

\n ", + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    \n CRC32\n

    \n
    • \n
  • \n

    \n CRC32C\n

    \n
    • \n
  • \n

    \n SHA1\n

    \n
    • \n
  • \n

    \n SHA256\n

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n \n

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

\n ", "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" } }, @@ -31296,14 +31357,14 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32c" } }, @@ -31448,7 +31509,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST Authentication.

\n \n

The Content-MD5 header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information about Amazon S3 Object Lock, see Amazon S3 Object Lock\n Overview in the Amazon S3 User Guide.

\n \n \n

This functionality is not supported for directory buckets.

\n ", + "smithy.api#documentation": "

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST Authentication.

\n \n

The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information, see Uploading objects to an Object Lock enabled bucket\n in the Amazon S3 User Guide.

\n \n \n

This functionality is not supported for directory buckets.

\n ", "smithy.api#httpHeader": "Content-MD5" } }, @@ -31462,21 +31523,21 @@ "ChecksumAlgorithm": { "target": "com.amazonaws.s3#ChecksumAlgorithm", "traits": { - "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    CRC32

    \n
    • \n
  • \n

    CRC32C

    \n
    • \n
  • \n

    SHA1

    \n
    • \n
  • \n

    SHA256

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n \n

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

\n ", + "smithy.api#documentation": "

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

\n

For the x-amz-checksum-algorithm\n header, replace \n algorithm\n with the supported algorithm from the following list:

\n
    \n
  • \n

    \n CRC32\n

    \n
    • \n
  • \n

    \n CRC32C\n

    \n
    • \n
  • \n

    \n SHA1\n

    \n
    • \n
  • \n

    \n SHA256\n

    \n
    • \n
\n

For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.

\n

If the individual checksum value you provide through x-amz-checksum-algorithm\n doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n .

\n \n

The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information, see Uploading objects to an Object Lock enabled bucket\n in the Amazon S3 User Guide.

\n \n

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.

", "smithy.api#httpHeader": "x-amz-sdk-checksum-algorithm" } }, "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32c" } }, @@ -31599,7 +31660,7 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same\n account that's issuing the command, you must use the full Key ARN not the Key ID.

\n

\n General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS \n key to use. If you specify\n x-amz-server-side-encryption:aws:kms or\n x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key\n (aws/s3) to protect the data.

\n

\n Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, you must specify the \n x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS \n symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nAmazon Web Services managed key (aws/s3) isn't supported. \n

", + "smithy.api#documentation": "

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same\n account that's issuing the command, you must use the full Key ARN not the Key ID.

\n

\n General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS \n key to use. If you specify\n x-amz-server-side-encryption:aws:kms or\n x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key\n (aws/s3) to protect the data.

\n

\n Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the \n x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS \n symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. \n If you want to specify the \n x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS \n customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -32282,7 +32343,7 @@ } }, "com.amazonaws.s3#ReplicationRuleFilter": { - "type": "union", + "type": "structure", "members": { "Prefix": { "target": "com.amazonaws.s3#Prefix", @@ -32525,7 +32586,7 @@ "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n \n

The SELECT job type for the RestoreObject operation is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Restores an archived copy of an object back into Amazon S3

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n
    \n
  • \n

    \n restore an archive - Restore an archived object

    \n
    • \n
\n

For more information about the S3 structure in the request body, see the\n following:

\n \n
\n
Permissions
\n
\n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by\n default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

\n
\n
Restoring objects
\n
\n

Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval\n or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive\n storage classes, you must first initiate a restore request, and then wait until a\n temporary copy of the object is available. If you want a permanent copy of the\n object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.\n To access an archived object, you must restore the object for the duration (number\n of days) that you specify. For objects in the Archive Access or Deep Archive\n Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,\n and then wait until the object is moved into the Frequent Access tier.

\n

To restore a specific object version, you can provide a version ID. If you\n don't provide a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object, you can specify one of the following data\n access tier options in the Tier element of the request body:

\n
    \n
  • \n

    \n Expedited - Expedited retrievals allow you to quickly access\n your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval\n storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests\n for restoring archives are required. For all but the largest archived\n objects (250 MB+), data accessed using Expedited retrievals is typically\n made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it.\n Expedited retrievals and provisioned capacity are not available for objects\n stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
  • \n

    \n Standard - Standard retrievals allow you to access any of\n your archived objects within several hours. This is the default option for\n retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3–5 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored\n in S3 Intelligent-Tiering.

    \n
    • \n
  • \n

    \n Bulk - Bulk retrievals free for objects stored in the\n S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,\n enabling you to retrieve large amounts, even petabytes, of data at no cost.\n Bulk retrievals typically finish within 5–12 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost\n retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
\n

For more information about archive retrieval options and provisioned capacity\n for Expedited data access, see Restoring Archived\n Objects in the Amazon S3 User Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster\n speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.

\n

To get the status of object restoration, you can send a HEAD\n request. Operations return the x-amz-restore header, which provides\n information about the restoration status, in the response. You can use Amazon S3 event\n notifications to notify you when a restore is initiated or completed. For more\n information, see Configuring Amazon S3 Event\n Notifications in the Amazon S3 User Guide.

\n

After restoring an archived object, you can update the restoration period by\n reissuing the request with a new period. Amazon S3 updates the restoration period\n relative to the current time and charges only for the request-there are no\n data transfer charges. You cannot update the restoration period when Amazon S3 is\n actively processing your current restore request for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an\n expiration action, the object expiration overrides the life span that you specify\n in a restore request. For example, if you restore an object copy for 10 days, but\n the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days.\n For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle\n Management in Amazon S3 User Guide.

\n
\n
Responses
\n
\n

A successful action returns either the 200 OK or 202\n Accepted status code.

\n
    \n
  • \n

    If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

    \n
    • \n
  • \n

    If the object is previously restored, Amazon S3 returns 200 OK in\n the response.

    \n
    • \n
\n
    \n
  • \n

    Special errors:

    \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress\n

      \n
      • \n
    • \n

      \n Cause: Object restore is already in progress.\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client\n

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: GlacierExpeditedRetrievalNotAvailable\n

      \n
      • \n
    • \n

      \n Cause: expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to\n process the Expedited request. This error applies only to Expedited\n retrievals and not to S3 Standard or Bulk retrievals.)\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 503\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: N/A\n

      \n
      • \n
    \n
    • \n
\n
\n
\n

The following operations are related to RestoreObject:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

Restores an archived copy of an object back into Amazon S3

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

This action performs the following types of requests:

\n
    \n
  • \n

    \n restore an archive - Restore an archived object

    \n
    • \n
\n

For more information about the S3 structure in the request body, see the\n following:

\n \n
\n
Permissions
\n
\n

To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by\n default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.

\n
\n
Restoring objects
\n
\n

Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval\n or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive\n storage classes, you must first initiate a restore request, and then wait until a\n temporary copy of the object is available. If you want a permanent copy of the\n object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.\n To access an archived object, you must restore the object for the duration (number\n of days) that you specify. For objects in the Archive Access or Deep Archive\n Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,\n and then wait until the object is moved into the Frequent Access tier.

\n

To restore a specific object version, you can provide a version ID. If you\n don't provide a version ID, Amazon S3 restores the current version.

\n

When restoring an archived object, you can specify one of the following data\n access tier options in the Tier element of the request body:

\n
    \n
  • \n

    \n Expedited - Expedited retrievals allow you to quickly access\n your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval\n storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests\n for restoring archives are required. For all but the largest archived\n objects (250 MB+), data accessed using Expedited retrievals is typically\n made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it.\n Expedited retrievals and provisioned capacity are not available for objects\n stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
  • \n

    \n Standard - Standard retrievals allow you to access any of\n your archived objects within several hours. This is the default option for\n retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3–5 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored\n in S3 Intelligent-Tiering.

    \n
    • \n
  • \n

    \n Bulk - Bulk retrievals free for objects stored in the\n S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,\n enabling you to retrieve large amounts, even petabytes, of data at no cost.\n Bulk retrievals typically finish within 5–12 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost\n retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.

    \n
    • \n
\n

For more information about archive retrieval options and provisioned capacity\n for Expedited data access, see Restoring Archived\n Objects in the Amazon S3 User Guide.

\n

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster\n speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.

\n

To get the status of object restoration, you can send a HEAD\n request. Operations return the x-amz-restore header, which provides\n information about the restoration status, in the response. You can use Amazon S3 event\n notifications to notify you when a restore is initiated or completed. For more\n information, see Configuring Amazon S3 Event\n Notifications in the Amazon S3 User Guide.

\n

After restoring an archived object, you can update the restoration period by\n reissuing the request with a new period. Amazon S3 updates the restoration period\n relative to the current time and charges only for the request-there are no\n data transfer charges. You cannot update the restoration period when Amazon S3 is\n actively processing your current restore request for the object.

\n

If your bucket has a lifecycle configuration with a rule that includes an\n expiration action, the object expiration overrides the life span that you specify\n in a restore request. For example, if you restore an object copy for 10 days, but\n the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days.\n For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle\n Management in Amazon S3 User Guide.

\n
\n
Responses
\n
\n

A successful action returns either the 200 OK or 202\n Accepted status code.

\n
    \n
  • \n

    If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.

    \n
    • \n
  • \n

    If the object is previously restored, Amazon S3 returns 200 OK in\n the response.

    \n
    • \n
\n
    \n
  • \n

    Special errors:

    \n
      \n
    • \n

      \n Code: RestoreAlreadyInProgress\n

      \n
      • \n
    • \n

      \n Cause: Object restore is already in progress.\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 409 Conflict\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: Client\n

      \n
      • \n
    \n
    • \n
  • \n
      \n
    • \n

      \n Code: GlacierExpeditedRetrievalNotAvailable\n

      \n
      • \n
    • \n

      \n Cause: expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to\n process the Expedited request. This error applies only to Expedited\n retrievals and not to S3 Standard or Bulk retrievals.)\n

      \n
      • \n
    • \n

      \n HTTP Status Code: 503\n

      \n
      • \n
    • \n

      \n SOAP Fault Code Prefix: N/A\n

      \n
      • \n
    \n
    • \n
\n
\n
\n

The following operations are related to RestoreObject:

\n ", "smithy.api#examples": [ { "title": "To restore an archived object", @@ -32653,7 +32714,7 @@ "Type": { "target": "com.amazonaws.s3#RestoreRequestType", "traits": { - "smithy.api#documentation": "\n

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Type of restore request.

" + "smithy.api#documentation": "

Type of restore request.

" } }, "Tier": { @@ -32671,7 +32732,7 @@ "SelectParameters": { "target": "com.amazonaws.s3#SelectParameters", "traits": { - "smithy.api#documentation": "\n

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Describes the parameters for Select job types.

" + "smithy.api#documentation": "

Describes the parameters for Select job types.

" } }, "OutputLocation": { @@ -32896,7 +32957,7 @@ "target": "com.amazonaws.s3#SelectObjectContentOutput" }, "traits": { - "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n \n

The SelectObjectContent operation is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the operation as usual. Learn more\n

\n \n

This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.

\n

\n
\n
Permissions
\n
\n

You must have the s3:GetObject permission for this operation. Amazon S3\n Select does not support anonymous access. For more information about permissions,\n see Specifying Permissions in\n a Policy in the Amazon S3 User Guide.

\n
\n
Object Data Formats
\n
\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n
    \n
  • \n

    \n CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.

    \n
    • \n
  • \n

    \n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.

    \n
    • \n
  • \n

    \n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.

    \n
    • \n
  • \n

    \n Server-side encryption - Amazon S3 Select supports\n querying objects that are protected with server-side encryption.

    \n

    For objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more\n information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys)\n in the Amazon S3 User Guide.

    \n

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently,\n so you don't need to specify anything. For more information about\n server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the\n Amazon S3 User Guide.

    \n
    • \n
\n
\n
Working with the Response Body
\n
\n

Given the response size is unknown, Amazon S3 Select streams the response as a\n series of messages and includes a Transfer-Encoding header with\n chunked as its value in the response. For more information, see\n Appendix:\n SelectObjectContent\n Response.

\n
\n
GetObject Support
\n
\n

The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.

\n
    \n
  • \n

    \n Range: Although you can specify a scan range for an Amazon S3 Select\n request (see SelectObjectContentRequest - ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.\n

    \n
    • \n
  • \n

    The GLACIER, DEEP_ARCHIVE, and\n REDUCED_REDUNDANCY storage classes, or the\n ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access\n tiers of the INTELLIGENT_TIERING storage class: You cannot\n query objects in the GLACIER, DEEP_ARCHIVE, or\n REDUCED_REDUNDANCY storage classes, nor objects in the\n ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access\n tiers of the INTELLIGENT_TIERING storage class. For more\n information about storage classes, see Using Amazon S3\n storage classes in the\n Amazon S3 User Guide.

    \n
    • \n
\n
\n
Special Errors
\n
\n

For a list of special errors for this operation, see List of SELECT Object Content Error Codes\n

\n
\n
\n

The following operations are related to SelectObjectContent:

\n ", + "smithy.api#documentation": "\n

This operation is not supported by directory buckets.

\n \n

This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.

\n

This functionality is not supported for Amazon S3 on Outposts.

\n

For more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.

\n

\n
\n
Permissions
\n
\n

You must have the s3:GetObject permission for this operation. Amazon S3\n Select does not support anonymous access. For more information about permissions,\n see Specifying Permissions in\n a Policy in the Amazon S3 User Guide.

\n
\n
Object Data Formats
\n
\n

You can use Amazon S3 Select to query objects that have the following format\n properties:

\n
    \n
  • \n

    \n CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.

    \n
    • \n
  • \n

    \n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.

    \n
    • \n
  • \n

    \n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.

    \n
    • \n
  • \n

    \n Server-side encryption - Amazon S3 Select supports\n querying objects that are protected with server-side encryption.

    \n

    For objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more\n information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys)\n in the Amazon S3 User Guide.

    \n

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently,\n so you don't need to specify anything. For more information about\n server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the\n Amazon S3 User Guide.

    \n
    • \n
\n
\n
Working with the Response Body
\n
\n

Given the response size is unknown, Amazon S3 Select streams the response as a\n series of messages and includes a Transfer-Encoding header with\n chunked as its value in the response. For more information, see\n Appendix:\n SelectObjectContent\n Response.

\n
\n
GetObject Support
\n
\n

The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.

\n
    \n
  • \n

    \n Range: Although you can specify a scan range for an Amazon S3 Select\n request (see SelectObjectContentRequest - ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.\n

    \n
    • \n
  • \n

    The GLACIER, DEEP_ARCHIVE, and\n REDUCED_REDUNDANCY storage classes, or the\n ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access\n tiers of the INTELLIGENT_TIERING storage class: You cannot\n query objects in the GLACIER, DEEP_ARCHIVE, or\n REDUCED_REDUNDANCY storage classes, nor objects in the\n ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access\n tiers of the INTELLIGENT_TIERING storage class. For more\n information about storage classes, see Using Amazon S3\n storage classes in the\n Amazon S3 User Guide.

    \n
    • \n
\n
\n
Special Errors
\n
\n

For a list of special errors for this operation, see List of SELECT Object Content Error Codes\n

\n
\n
\n

The following operations are related to SelectObjectContent:

\n ", "smithy.api#http": { "method": "POST", "uri": "/{Bucket}/{Key+}?select&select-type=2", @@ -33050,7 +33111,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Request to filter the contents of an Amazon S3 object based on a simple Structured Query\n Language (SQL) statement. In the request, along with the SQL expression, you must specify a\n data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data\n into records. It returns only records that match the specified SQL expression. You must\n also specify the data serialization format for the response. For more information, see\n S3Select API Documentation.

", + "smithy.api#documentation": "

Request to filter the contents of an Amazon S3 object based on a simple Structured Query\n Language (SQL) statement. In the request, along with the SQL expression, you must specify a\n data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data\n into records. It returns only records that match the specified SQL expression. You must\n also specify the data serialization format for the response. For more information, see\n S3Select API Documentation.

", "smithy.api#input": {} } }, @@ -33074,7 +33135,7 @@ "Expression": { "target": "com.amazonaws.s3#Expression", "traits": { - "smithy.api#documentation": "\n

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

The expression that is used to query the object.

", + "smithy.api#documentation": "

The expression that is used to query the object.

", "smithy.api#required": {} } }, @@ -33087,7 +33148,7 @@ } }, "traits": { - "smithy.api#documentation": "\n

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more\n

\n \n

Describes the parameters for Select job types.

\n

Learn How to optimize querying your data in Amazon S3 using\n Amazon Athena, S3 Object Lambda, or client-side filtering.

" + "smithy.api#documentation": "

Describes the parameters for Select job types.

" } }, "com.amazonaws.s3#ServerSideEncryption": { @@ -33131,7 +33192,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more\n information, see PutBucketEncryption.

\n \n
    \n
  • \n

    \n General purpose buckets - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates\n an Amazon Web Services KMS key (aws/s3) in your Amazon Web Services account the first time that you add an object encrypted\n with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS.

    \n
    • \n
  • \n

    \n Directory buckets - Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nAmazon Web Services managed key (aws/s3) isn't supported. \n

    \n
    • \n
  • \n

    \n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.

    \n
    • \n
\n " + "smithy.api#documentation": "

Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more\n information, see PutBucketEncryption.

\n \n
    \n
  • \n

    \n General purpose buckets - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates\n an Amazon Web Services KMS key (aws/s3) in your Amazon Web Services account the first time that you add an object encrypted\n with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS.

    \n
    • \n
  • \n

    \n Directory buckets - Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3) isn't supported. \n

    \n
    • \n
  • \n

    \n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.

    \n
    • \n
\n " } }, "com.amazonaws.s3#ServerSideEncryptionConfiguration": { @@ -33736,6 +33797,23 @@ "smithy.api#documentation": "

Specifies when an object transitions to a specified storage class. For more information\n about Amazon S3 lifecycle configuration rules, see Transitioning\n Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

" } }, + "com.amazonaws.s3#TransitionDefaultMinimumObjectSize": { + "type": "enum", + "members": { + "varies_by_storage_class": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "varies_by_storage_class" + } + }, + "all_storage_classes_128K": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "all_storage_classes_128K" + } + } + } + }, "com.amazonaws.s3#TransitionList": { "type": "list", "member": { @@ -34085,14 +34163,14 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", + "smithy.api#documentation": "

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded\n with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated\n with multipart uploads, see \n Checking object integrity in the Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32c" } }, @@ -34195,14 +34273,14 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.\n This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see\n Checking object integrity in the\n Amazon S3 User Guide.

", "smithy.api#httpHeader": "x-amz-checksum-crc32c" } }, @@ -34497,14 +34575,14 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32\n checksum of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.

\n

Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.

\n

", + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32\n checksum of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.

\n

Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.

\n

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C\n checksum of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.

\n

Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.

", + "smithy.api#documentation": "

This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32C\n checksum of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.

\n

Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.

", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-crc32c" } }, diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index 905c17b98d8..0efafed0185 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -2076,7 +2076,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications.

" } }, "com.amazonaws.sagemaker#AppList": { @@ -6701,7 +6701,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1 + "min": 0 } } }, @@ -7618,7 +7618,13 @@ "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#AppLifecycleManagement", "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor\n applications.

" + } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default \n lifecycle configuration.

" } } }, @@ -9913,6 +9919,12 @@ "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.

" } }, + "TagPropagation": { + "target": "com.amazonaws.sagemaker#TagPropagation", + "traits": { + "smithy.api#documentation": "

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

" + } + }, "DefaultSpaceSettings": { "target": "com.amazonaws.sagemaker#DefaultSpaceSettings", "traits": { @@ -17845,6 +17857,12 @@ "traits": { "smithy.api#documentation": "

The instance type and the Amazon Resource Name (ARN) of the SageMaker image\n created on the instance.

" } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The lifecycle configuration that runs before the default lifecycle configuration

" + } } }, "traits": { @@ -19338,6 +19356,12 @@ "smithy.api#documentation": "

The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided.

" } }, + "TagPropagation": { + "target": "com.amazonaws.sagemaker#TagPropagation", + "traits": { + "smithy.api#documentation": "

Indicates whether custom tag propagation is supported for the domain.

" + } + }, "DefaultSpaceSettings": { "target": "com.amazonaws.sagemaker#DefaultSpaceSettings", "traits": { @@ -30353,12 +30377,50 @@ "target": "com.amazonaws.sagemaker#AppType" } }, + "com.amazonaws.sagemaker#HiddenInstanceTypesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AppInstanceType" + } + }, "com.amazonaws.sagemaker#HiddenMlToolsList": { "type": "list", "member": { "target": "com.amazonaws.sagemaker#MlTools" } }, + "com.amazonaws.sagemaker#HiddenSageMakerImage": { + "type": "structure", + "members": { + "SageMakerImageName": { + "target": "com.amazonaws.sagemaker#SageMakerImageName", + "traits": { + "smithy.api#documentation": "

\n The SageMaker image name that you are hiding from the Studio user interface.\n

" + } + }, + "VersionAliases": { + "target": "com.amazonaws.sagemaker#VersionAliasesList", + "traits": { + "smithy.api#documentation": "

\n The version aliases you are hiding from the Studio user interface.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker\n image name and version aliases.

" + } + }, + "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#HiddenSageMakerImage" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.sagemaker#HolidayConfig": { "type": "list", "member": { @@ -31089,9 +31151,7 @@ "PreHumanTaskLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

\n

For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n

    \n
    • \n
\n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Modalities\n

\n

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

\n

\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n

\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox\n

    \n
    • \n
\n

\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
\n

\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n

\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object\n is sent to a human worker. Use this function to provide input to a custom labeling\n job.

\n

For built-in\n task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for\n PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

\n

\n Bounding box - Finds the most similar boxes from\n different workers based on the Jaccard index of the boxes.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox\n

    \n
    • \n
\n

\n Image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass\n

    \n
    • \n
\n

\n Multi-label image classification - Uses a variant of the Expectation\n Maximization approach to estimate the true classes of an image based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel\n

    \n
    • \n
\n

\n Semantic segmentation - Treats each pixel in an image as\n a multi-class classification and treats pixel annotations from workers as\n \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation\n

    \n
    • \n
\n

\n Text classification - Uses a variant of the Expectation\n Maximization approach to estimate the true class of text based on annotations\n from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass\n

    \n
    • \n
\n

\n Multi-label text classification - Uses a variant of the\n Expectation Maximization approach to estimate the true classes of text based on\n annotations from individual workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel\n

    \n
    • \n
\n

\n Named entity recognition - Groups similar selections and\n calculates aggregate boundaries, resolving to most-assigned label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition\n

    \n
    • \n
\n

\n Video Classification - Use this task type when you need workers to classify videos using\n predefined labels that you specify. Workers are shown videos and are asked to choose one\n label for each video.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass\n

    \n
    • \n
\n

\n Video Frame Object Detection - Use this task type to\n have workers identify and locate objects in a sequence of video frames (images extracted\n from a video) using bounding boxes. For example, you can use this task to ask workers to\n identify and localize various objects in a series of video frames, such as cars, bikes,\n and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking - Use this task type to\n have workers track the movement of objects in a sequence of video frames (images\n extracted from a video) using bounding boxes. For example, you can use this task to ask\n workers to track the movement of objects, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Modalities\n

\n

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks.\n See 3D Point Cloud Task types\n to learn more.

\n

\n 3D Point Cloud Object Detection - \n Use this task type when you want workers to classify objects in a 3D point cloud by \n drawing 3D cuboids around objects. For example, you can use this task type to ask workers \n to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D Point Cloud Object Tracking - \n Use this task type when you want workers to draw 3D cuboids around objects\n that appear in a sequence of 3D point cloud frames. \n For example, you can use this task type to ask workers to track \n the movement of vehicles across multiple point cloud frames.\n

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D Point Cloud Semantic Segmentation - \n Use this task type when you want workers to create a point-level semantic segmentation masks by \n painting objects in a 3D point cloud using different colors where each color is assigned to one of \n the classes you specify.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation\n

    \n
    • \n
\n

\n Use the following ARNs for Label Verification and Adjustment Jobs\n

\n

Use label verification and adjustment jobs to review and adjust labels. To learn more,\n see Verify and Adjust Labels .

\n

\n Bounding box verification - Uses a variant of the\n Expectation Maximization approach to estimate the true class of verification\n judgement for bounding box labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox\n

    \n
    • \n
\n

\n Bounding box adjustment - Finds the most similar boxes\n from different workers based on the Jaccard index of the adjusted\n annotations.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox\n

    \n
    • \n
\n

\n Semantic segmentation verification - Uses a variant of\n the Expectation Maximization approach to estimate the true class of verification\n judgment for semantic segmentation labels based on annotations from individual\n workers.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation\n

    \n
    • \n
\n

\n Semantic segmentation adjustment - Treats each pixel in\n an image as a multi-class classification and treats pixel adjusted annotations\n from workers as \"votes\" for the correct label.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation\n

    \n
    • \n
\n

\n Video Frame Object Detection Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to classify and localize objects in a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection\n

    \n
    • \n
\n

\n Video Frame Object Tracking Adjustment - \n Use this task type when you want workers to adjust bounding boxes that workers have added \n to video frames to track object movement across a sequence of video frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking\n

    \n
    • \n
\n

\n 3D point cloud object detection adjustment - Adjust\n 3D cuboids in a point cloud frame.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection\n

    \n
    • \n
\n

\n 3D point cloud object tracking adjustment - Adjust 3D\n cuboids across a sequence of point cloud frames.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking\n

    \n
    • \n
\n

\n 3D point cloud semantic segmentation adjustment -\n Adjust semantic segmentation masks in a 3D point cloud.

\n
    \n
  • \n

    \n arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
  • \n

    \n arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation\n

    \n
    • \n
" } }, "TaskKeywords": { @@ -31147,9 +31207,7 @@ "AnnotationConsolidationConfig": { "target": "com.amazonaws.sagemaker#AnnotationConsolidationConfig", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

Configures how labels are consolidated across human workers.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Configures how labels are consolidated across human workers.

" } }, "PublicWorkforceTaskPrice": { @@ -32419,7 +32477,7 @@ "IdleTimeoutInMinutes": { "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", "traits": { - "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it down.

" + "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it\n down.

" } }, "MinIdleTimeoutInMinutes": { @@ -32820,6 +32878,16 @@ "smithy.api#pattern": "^(^\\d+$)|(^\\d+.\\d+$)|(^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$)$" } }, + "com.amazonaws.sagemaker#ImageVersionAliasPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$" + } + }, "com.amazonaws.sagemaker#ImageVersionArn": { "type": "string", "traits": { @@ -35497,6 +35565,12 @@ "traits": { "smithy.api#documentation": "

The configuration parameters that specify the IAM roles assumed by the execution role of \n SageMaker (assumable roles) and the cluster instances or job execution environments \n (execution roles or runtime roles) to manage and access resources required for running Amazon EMR\n clusters or Amazon EMR Serverless applications.

" } + }, + "BuiltInLifecycleConfigArn": { + "target": "com.amazonaws.sagemaker#StudioLifecycleConfigArn", + "traits": { + "smithy.api#documentation": "

The lifecycle configuration that runs before the default lifecycle configuration. It can override changes made in the default \n lifecycle configuration.

" + } } }, "traits": { @@ -36147,9 +36221,7 @@ "PreHumanTaskLambdaArn": { "target": "com.amazonaws.sagemaker#LambdaFunctionArn", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each\n data object is sent to a worker.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each\n data object is sent to a worker.

" } }, "AnnotationConsolidationLambdaArn": { @@ -44688,6 +44760,12 @@ "traits": { "smithy.api#enumValue": "InferenceOptimization" } + }, + "PERFORMANCE_EVALUATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PerformanceEvaluation" + } } } }, @@ -59430,6 +59508,17 @@ } } }, + "com.amazonaws.sagemaker#SageMakerImageName": { + "type": "enum", + "members": { + "sagemaker_distribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sagemaker_distribution" + } + } + } + }, "com.amazonaws.sagemaker#SageMakerImageVersionAlias": { "type": "string", "traits": { @@ -60910,7 +60999,7 @@ } }, "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications in a space.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio\n applications in a space.

" } }, "com.amazonaws.sagemaker#SpaceArn": { @@ -60932,7 +61021,7 @@ "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications in a space.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of CodeEditor applications in\n a space.

" } } }, @@ -61017,7 +61106,7 @@ "IdleTimeoutInMinutes": { "target": "com.amazonaws.sagemaker#IdleTimeoutInMinutes", "traits": { - "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it down.

" + "smithy.api#documentation": "

The time that SageMaker waits after the application becomes idle before shutting it\n down.

" } } }, @@ -61040,7 +61129,7 @@ "AppLifecycleManagement": { "target": "com.amazonaws.sagemaker#SpaceAppLifecycleManagement", "traits": { - "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of JupyterLab applications in a space.

" + "smithy.api#documentation": "

Settings that are used to configure and manage the lifecycle of JupyterLab applications in\n a space.

" } } }, @@ -62662,6 +62751,18 @@ "traits": { "smithy.api#documentation": "

The Applications supported in Studio that are hidden from the Studio left navigation\n pane.

" } + }, + "HiddenInstanceTypes": { + "target": "com.amazonaws.sagemaker#HiddenInstanceTypesList", + "traits": { + "smithy.api#documentation": "

\n The instance types you are hiding from the Studio user interface.\n

" + } + }, + "HiddenSageMakerImageVersionAliases": { + "target": "com.amazonaws.sagemaker#HiddenSageMakerImageVersionAliasesList", + "traits": { + "smithy.api#documentation": "

\n The version aliases you are hiding from the Studio user interface.\n

" + } } }, "traits": { @@ -62923,6 +63024,23 @@ } } }, + "com.amazonaws.sagemaker#TagPropagation": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.sagemaker#TagValue": { "type": "string", "traits": { @@ -68079,6 +68197,12 @@ "traits": { "smithy.api#documentation": "

Specifies the VPC used for non-EFS traffic.

\n
    \n
  • \n

    \n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.

    \n
    • \n
  • \n

    \n VpcOnly - All Studio traffic is through the specified VPC and\n subnets.

    \n
    • \n
\n

This configuration can only be modified if there are no apps in the\n InService, Pending, or Deleting state. The\n configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already\n set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided as part of the same request.

" } + }, + "TagPropagation": { + "target": "com.amazonaws.sagemaker#TagPropagation", + "traits": { + "smithy.api#documentation": "

Indicates whether custom tag propagation is supported for the domain. Defaults to DISABLED.

" + } } }, "traits": { @@ -70456,7 +70580,7 @@ "AutoMountHomeEFS": { "target": "com.amazonaws.sagemaker#AutoMountHomeEFS", "traits": { - "smithy.api#documentation": "

Indicates whether auto-mounting of an EFS volume is supported for the user profile. The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.

" + "smithy.api#documentation": "

Indicates whether auto-mounting of an EFS volume is supported for the user profile. The\n DefaultAsDomain value is only supported for user profiles. Do not use the\n DefaultAsDomain value when setting this parameter for a domain.

" } } }, @@ -70657,6 +70781,18 @@ } } }, + "com.amazonaws.sagemaker#VersionAliasesList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ImageVersionAliasPattern" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.sagemaker#VersionId": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/securityhub.json b/codegen/sdk/aws-models/securityhub.json index e431233ae1d..ea5821d1a02 100644 --- a/codegen/sdk/aws-models/securityhub.json +++ b/codegen/sdk/aws-models/securityhub.json @@ -55,7 +55,7 @@ } ], "traits": { - "smithy.api#documentation": "

Accepts the invitation to be a member account and be monitored by the Security Hub administrator\n account that the invitation was sent from.

\n

This operation is only used by member accounts that are not added through\n Organizations.

\n

When the member account accepts the invitation, permission is granted to the administrator\n account to view findings generated in the member account.

", + "smithy.api#documentation": "\n

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. \n For information, see Managing Security Hub administrator and member accounts with Organizations \n in the Security Hub User Guide.

\n \n

Accepts the invitation to be a member account and be monitored by the Security Hub administrator\n account that the invitation was sent from.

\n

This operation is only used by member accounts that are not added through\n Organizations.

\n

When the member account accepts the invitation, permission is granted to the administrator\n account to view findings generated in the member account.

", "smithy.api#examples": [ { "title": "To accept an invitation be a member account", @@ -674,7 +674,7 @@ "Type": { "target": "com.amazonaws.securityhub#AutomationRulesActionType", "traits": { - "smithy.api#documentation": "

\n Specifies that the rule action should update the Types finding field. The Types \n finding field classifies findings in the format of namespace/category/classifier. For more information, see\n Types taxonomy for ASFF in \n the Security Hub User Guide.\n

" + "smithy.api#documentation": "

\n Specifies the type of action that Security Hub takes when a finding matches the defined criteria of a rule.\n

" } }, "FindingFieldsUpdate": { @@ -685,7 +685,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n One or more actions to update finding fields if a finding matches the defined criteria \n of the rule.\n

" + "smithy.api#documentation": "

\n One or more actions that Security Hub takes when a finding matches the defined criteria \n of a rule.\n

" } }, "com.amazonaws.securityhub#AutomationRulesActionType": { @@ -958,7 +958,7 @@ "ResourceId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

\n The identifier for the given resource type. For Amazon Web Services resources that are identified by \n Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, \n this is the identifier as defined by the Amazon Web Servicesservice that created the resource. \n For non-Amazon Web Services resources, this is a unique identifier that is associated with the \n resource.\n

\n

\n \t\tArray Members: Minimum number of 1 item. Maximum number of 100 items.\n \t

" + "smithy.api#documentation": "

\n The identifier for the given resource type. For Amazon Web Services resources that are identified by \n Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, \n this is the identifier as defined by the Amazon Web Services service that created the resource. \n For non-Amazon Web Services resources, this is a unique identifier that is associated with the \n resource.\n

\n

\n \t\tArray Members: Minimum number of 1 item. Maximum number of 100 items.\n \t

" } }, "ResourcePartition": { @@ -2986,7 +2986,7 @@ "Lifecycle": { "target": "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails", "traits": { - "smithy.api#documentation": "

Defines when a protected resource is transitioned to cold storage and when it expires.\n Backup transitions and expires backups automatically according to the\n lifecycle that you define. If you do not specify a lifecycle, Backup applies\n the lifecycle policy of the source backup to the destination backup.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" + "smithy.api#documentation": "

Defines when a protected resource is transitioned to cold storage and when it expires.\n Backup transitions and expires backups automatically according to the\n lifecycle that you define. If you don't specify a lifecycle, Backup applies\n the lifecycle policy of the source backup to the destination backup.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" } } }, @@ -3054,7 +3054,7 @@ "Lifecycle": { "target": "com.amazonaws.securityhub#AwsBackupBackupPlanLifecycleDetails", "traits": { - "smithy.api#documentation": "

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" + "smithy.api#documentation": "

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you don't specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" } } }, @@ -3086,7 +3086,7 @@ "EncryptionKeyArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support \nfull Backup management. If you do not specify a key, Backup creates an KMS key for you by default.\n

" + "smithy.api#documentation": "

The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support \nfull Backup management. If you don't specify a key, Backup creates an KMS key for you by default.\n

" } }, "Notifications": { @@ -9342,7 +9342,7 @@ "SchedulingStrategy": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The scheduling strategy to use for the service.

\n

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

\n

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that do not meet the placement constraints.

\n

Valid values: REPLICA | DAEMON\n

" + "smithy.api#documentation": "

The scheduling strategy to use for the service.

\n

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

\n

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that don't meet the placement constraints.

\n

Valid values: REPLICA | DAEMON\n

" } }, "ServiceArn": { @@ -15149,7 +15149,7 @@ "DBName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

Contains the name of the initial database of this instance that was provided at create\n time, if one was specified when the DB instance was created. This same name is returned for\n the life of the DB instance.

\n

\n Oracle\n

\n

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the\n returned parameters do not apply to an Oracle DB instance.

" + "smithy.api#documentation": "

The meaning of this parameter differs according to the database engine you use.

\n

\n MySQL, MariaDB, SQL Server, PostgreSQL\n

\n

Contains the name of the initial database of this instance that was provided at create\n time, if one was specified when the DB instance was created. This same name is returned for\n the life of the DB instance.

\n

\n Oracle\n

\n

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the\n returned parameters don't apply to an Oracle DB instance.

" } }, "DeletionProtection": { @@ -18983,7 +18983,7 @@ "WorkflowStatus": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

The status of the investigation into a finding. Allowed values are the following.

\n
    \n
  • \n

    \n NEW - The initial state of a finding, before it is reviewed.

    \n

    Security Hub also resets the workflow status from NOTIFIED or\n RESOLVED to NEW in the following cases:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to ACTIVE.

      \n
      • \n
    • \n

      \n Compliance.Status changes from PASSED to either WARNING,\n FAILED, or NOT_AVAILABLE.

      \n
      • \n
    \n
    • \n
  • \n

    \n NOTIFIED - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.

    \n

    If one of the following occurs, the workflow status is changed automatically from\n NOTIFIED to NEW:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to\n ACTIVE.

      \n
      • \n
    • \n

      \n Compliance.Status changes from PASSED to FAILED,\n WARNING, or NOT_AVAILABLE.

      \n
      • \n
    \n
    • \n
  • \n

    \n SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is\n needed.

    \n

    The workflow status of a SUPPRESSED finding does not change if\n RecordState changes from ARCHIVED to\n ACTIVE.

    \n
    • \n
  • \n

    \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

    \n

    The finding remains RESOLVED unless one of the following occurs:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to\n ACTIVE.

      \n
      • \n
    • \n

      \n Compliance.Status changes from PASSED to FAILED,\n WARNING, or NOT_AVAILABLE.

      \n
      • \n
    \n

    In those cases, the workflow status is automatically reset to NEW.

    \n

    For findings from controls, if Compliance.Status is PASSED,\n then Security Hub automatically sets the workflow status to RESOLVED.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the investigation into a finding. Allowed values are the following.

\n
    \n
  • \n

    \n NEW - The initial state of a finding, before it is reviewed.

    \n

    Security Hub also resets the workflow status from NOTIFIED or\n RESOLVED to NEW in the following cases:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to ACTIVE.

      \n
      • \n
    • \n

      \n Compliance.Status changes from PASSED to either WARNING,\n FAILED, or NOT_AVAILABLE.

      \n
      • \n
    \n
    • \n
  • \n

    \n NOTIFIED - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.

    \n

    If one of the following occurs, the workflow status is changed automatically from\n NOTIFIED to NEW:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to\n ACTIVE.

      \n
      • \n
    • \n

      \n Compliance.Status changes from PASSED to FAILED,\n WARNING, or NOT_AVAILABLE.

      \n
      • \n
    \n
    • \n
  • \n

    \n SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is\n needed.

    \n

    The workflow status of a SUPPRESSED finding does not change if\n RecordState changes from ARCHIVED to\n ACTIVE.

    \n
    • \n
  • \n

    \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

    \n

    The finding remains RESOLVED unless one of the following occurs:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to\n ACTIVE.

      \n
      • \n
    • \n

      \n Compliance.Status changes from PASSED to FAILED,\n WARNING, or NOT_AVAILABLE.

      \n
      • \n
    \n

    In those cases, the workflow status is automatically reset to NEW.

    \n

    For findings from controls, if Compliance.Status is PASSED,\n then Security Hub automatically sets the workflow status to RESOLVED.

    \n
    • \n
" } }, "RecordState": { @@ -19082,7 +19082,7 @@ "ComplianceSecurityControlId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "

\n The unique identifier of a control across standards. Values for this field typically consist of an \n Amazon Web Servicesservice and a number, such as APIGateway.5.\n

" + "smithy.api#documentation": "

\n The unique identifier of a control across standards. Values for this field typically consist of an \n Amazon Web Services service and a number, such as APIGateway.5.\n

" } }, "ComplianceAssociatedStandardsId": { @@ -20188,13 +20188,13 @@ "OverrideAction": { "target": "com.amazonaws.securityhub#WafOverrideAction", "traits": { - "smithy.api#documentation": "

Use the OverrideAction to test your RuleGroup.

\n

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to\n None, the RuleGroup blocks a request if any individual rule in the RuleGroup\n matches the request and is configured to block that request.

\n

However, if you first want to test the RuleGroup,\n set the OverrideAction to Count. The RuleGroup\n then overrides any block action specified by individual rules contained within the group.\n Instead of blocking matching requests, those requests are counted.

\n

\n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup\n to a web ACL. In this case you do not use ActivatedRule\n Action. For all other update requests,\n ActivatedRule\n Action is used instead of ActivatedRule\n OverrideAction.

" + "smithy.api#documentation": "

Use the OverrideAction to test your RuleGroup.

\n

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to\n None, the RuleGroup blocks a request if any individual rule in the RuleGroup\n matches the request and is configured to block that request.

\n

However, if you first want to test the RuleGroup,\n set the OverrideAction to Count. The RuleGroup\n then overrides any block action specified by individual rules contained within the group.\n Instead of blocking matching requests, those requests are counted.

\n

\n ActivatedRule|OverrideAction applies only when updating or\n adding a RuleGroup\n to a web ACL. In this case you don't use ActivatedRule\n Action. For all other update requests,\n ActivatedRule\n Action is used instead of ActivatedRule\n OverrideAction.

" } }, "Priority": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Specifies the order in which the rules in a web\n ACL are evaluated. Rules with a lower value for Priority are\n evaluated before rules with a higher value. The value must be a unique integer. If you add\n multiple rules to a web ACL, the values do not need to be consecutive.

" + "smithy.api#documentation": "

Specifies the order in which the rules in a web\n ACL are evaluated. Rules with a lower value for Priority are\n evaluated before rules with a higher value. The value must be a unique integer. If you add\n multiple rules to a web ACL, the values don't need to be consecutive.

" } }, "RuleId": { @@ -21632,7 +21632,7 @@ } ], "traits": { - "smithy.api#documentation": "

Used by Security Hub customers to update information about their investigation into a finding.\n Requested by administrator accounts or member accounts. Administrator accounts can update findings for\n their account and their member accounts. Member accounts can update findings for their\n account.

\n

Updates from BatchUpdateFindings do not affect the value of\n UpdatedAt for a finding.

\n

Administrator and member accounts can use BatchUpdateFindings to update the\n following finding fields and objects.

\n
    \n
  • \n

    \n Confidence\n

    \n
    • \n
  • \n

    \n Criticality\n

    \n
    • \n
  • \n

    \n Note\n

    \n
    • \n
  • \n

    \n RelatedFindings\n

    \n
    • \n
  • \n

    \n Severity\n

    \n
    • \n
  • \n

    \n Types\n

    \n
    • \n
  • \n

    \n UserDefinedFields\n

    \n
    • \n
  • \n

    \n VerificationState\n

    \n
    • \n
  • \n

    \n Workflow\n

    \n
    • \n
\n

You can configure IAM policies to restrict access to fields and field values. For\n example, you might not want member accounts to be able to suppress findings or change the\n finding severity. See Configuring access to BatchUpdateFindings in the\n Security Hub User Guide.

", + "smithy.api#documentation": "

Used by Security Hub customers to update information about their investigation into a finding.\n Requested by administrator accounts or member accounts. Administrator accounts can update findings for\n their account and their member accounts. Member accounts can update findings for their\n account.

\n

Updates from BatchUpdateFindings don't affect the value of\n UpdatedAt for a finding.

\n

Administrator and member accounts can use BatchUpdateFindings to update the\n following finding fields and objects.

\n
    \n
  • \n

    \n Confidence\n

    \n
    • \n
  • \n

    \n Criticality\n

    \n
    • \n
  • \n

    \n Note\n

    \n
    • \n
  • \n

    \n RelatedFindings\n

    \n
    • \n
  • \n

    \n Severity\n

    \n
    • \n
  • \n

    \n Types\n

    \n
    • \n
  • \n

    \n UserDefinedFields\n

    \n
    • \n
  • \n

    \n VerificationState\n

    \n
    • \n
  • \n

    \n Workflow\n

    \n
    • \n
\n

You can configure IAM policies to restrict access to fields and field values. For\n example, you might not want member accounts to be able to suppress findings or change the\n finding severity. See Configuring access to BatchUpdateFindings in the\n Security Hub User Guide.

", "smithy.api#examples": [ { "title": "To update Security Hub findings", @@ -22198,7 +22198,7 @@ "SecurityControlId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

\n Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an \n Amazon Web Servicesservice and a unique number, such as APIGateway.5.\n

" + "smithy.api#documentation": "

\n Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an \n Amazon Web Services service and a unique number, such as APIGateway.5.\n

" } }, "AssociatedStandards": { @@ -23058,7 +23058,7 @@ } ], "traits": { - "smithy.api#documentation": "

Used to enable finding aggregation. Must be called from the aggregation Region.

\n

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.\n

", + "smithy.api#documentation": "\n

The aggregation Region is now called the home Region.

\n \n

Used to enable cross-Region aggregation. This operation can be invoked from the home Region only.

\n

For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub in the Security Hub User Guide.\n

", "smithy.api#examples": [ { "title": "To enable cross-Region aggregation", @@ -23102,7 +23102,7 @@ "Regions": { "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

\n

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.\n

\n

An InvalidInputException error results if you populate this field while RegionLinkingMode is \n NO_REGIONS.

" + "smithy.api#documentation": "

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.

\n

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.\n

\n

An InvalidInputException error results if you populate this field while RegionLinkingMode is \n NO_REGIONS.

" } } }, @@ -23116,13 +23116,13 @@ "FindingAggregatorArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.

" + "smithy.api#documentation": "

The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop cross-Region aggregation.

" } }, "FindingAggregationRegion": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The aggregation Region.

" + "smithy.api#documentation": "

The home Region. Findings generated in linked Regions are replicated and sent to the home Region.

" } }, "RegionLinkingMode": { @@ -23280,7 +23280,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.

\n

\n CreateMembers is always used to add accounts that are not organization\n members.

\n

For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:

\n
    \n
  • \n

    Security Hub is not configured to automatically add new organization accounts.

    \n
    • \n
  • \n

    The account was disassociated or deleted in Security Hub.

    \n
    • \n
\n

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.

\n

For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.

\n

Accounts that are managed using Organizations do not receive an invitation. They\n automatically become a member account in Security Hub.

\n
    \n
  • \n

    If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

    \n
    • \n
  • \n

    For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

    \n
    • \n
\n

A permissions policy is added that permits the administrator account to view the findings\n generated in the member account.

\n

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

", + "smithy.api#documentation": "

Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.

\n

\n CreateMembers is always used to add accounts that are not organization\n members.

\n

For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:

\n
    \n
  • \n

    Security Hub is not configured to automatically add new organization accounts.

    \n
    • \n
  • \n

    The account was disassociated or deleted in Security Hub.

    \n
    • \n
\n

This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.

\n

For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.

\n

Accounts that are managed using Organizations don't receive an invitation. They\n automatically become a member account in Security Hub.

\n
    \n
  • \n

    If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.

    \n
    • \n
  • \n

    For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.

    \n
    • \n
\n

A permissions policy is added that permits the administrator account to view the findings\n generated in the member account.

\n

To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.

", "smithy.api#examples": [ { "title": "To add a member account", @@ -23560,7 +23560,7 @@ } ], "traits": { - "smithy.api#documentation": "

Declines invitations to become a member account.

\n

A prospective member account uses this operation to decline an invitation to become a member.

\n

This operation is only called by member accounts that aren't part of an organization.\n Organization accounts don't receive invitations.

", + "smithy.api#documentation": "\n

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. \n For information, see Managing Security Hub administrator and member accounts with Organizations \n in the Security Hub User Guide.

\n \n

Declines invitations to become a Security Hub member account.

\n

A prospective member account uses this operation to decline an invitation to become a member.

\n

Only member accounts that aren't part of an Amazon Web Services organization should use this operation.\n Organization accounts don't receive invitations.

", "smithy.api#examples": [ { "title": "To decline invitation to become a member account", @@ -23789,7 +23789,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.

\n

When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.\n

", + "smithy.api#documentation": "\n

The aggregation Region is now called the home Region.

\n \n

Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops \noccurring from the linked Regions to the home Region.

\n

When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from \n the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region.\n

", "smithy.api#examples": [ { "title": "To delete a finding aggregator", @@ -23933,7 +23933,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes invitations received by the Amazon Web Services account to become a member account.

\n

A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.

\n

This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization.\n Organization accounts don't receive invitations.

", + "smithy.api#documentation": "\n

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. \n For information, see Managing Security Hub administrator and member accounts with Organizations \n in the Security Hub User Guide.

\n \n

Deletes invitations to become a Security Hub member account.

\n

A Security Hub administrator account can use this operation to delete invitations sent to one or more prospective member accounts.

\n

This operation is only used to delete invitations that are sent to prospective member accounts that aren't part of an Amazon Web Services organization.\n Organization accounts don't receive invitations.

", "smithy.api#examples": [ { "title": "To delete a custom insight", @@ -24370,7 +24370,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about product integrations in Security Hub.

\n

You can optionally provide an integration ARN. If you provide an integration ARN, then\n the results only include that integration.

\n

If you do not provide an integration ARN, then the results include all of the available\n product integrations.

", + "smithy.api#documentation": "

Returns information about product integrations in Security Hub.

\n

You can optionally provide an integration ARN. If you provide an integration ARN, then\n the results only include that integration.

\n

If you don't provide an integration ARN, then the results include all of the available\n product integrations.

", "smithy.api#examples": [ { "title": "To get information about Security Hub integrations", @@ -25291,7 +25291,7 @@ "EnableDefaultStandards": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "

Whether to enable the security standards that Security Hub has designated as automatically\n enabled. If you do not provide a value for EnableDefaultStandards, it is set\n to true. To not enable the automatically enabled standards, set\n EnableDefaultStandards to false.

" + "smithy.api#documentation": "

Whether to enable the security standards that Security Hub has designated as automatically\n enabled. If you don't provide a value for EnableDefaultStandards, it is set\n to true. To not enable the automatically enabled standards, set\n EnableDefaultStandards to false.

" } }, "ControlFindingGenerator": { @@ -25428,7 +25428,7 @@ } }, "traits": { - "smithy.api#documentation": "

A finding aggregator. A finding aggregator contains the configuration for finding aggregation.

" + "smithy.api#documentation": "

A finding aggregator is a Security Hub resource that specifies cross-Region aggregation settings, including the \nhome Region and any linked Regions.

" } }, "com.amazonaws.securityhub#FindingAggregatorList": { @@ -25458,7 +25458,7 @@ "UpdateSource": { "target": "com.amazonaws.securityhub#FindingHistoryUpdateSource", "traits": { - "smithy.api#documentation": "

Identifies the source of the event that changed the finding. For example, an integrated\n Amazon Web Servicesservice or third-party partner integration may call \n BatchImportFindings\n , or an Security Hub customer\n may call \n BatchUpdateFindings\n .

" + "smithy.api#documentation": "

Identifies the source of the event that changed the finding. For example, an integrated\n Amazon Web Services service or third-party partner integration may call \n BatchImportFindings\n , or an Security Hub customer\n may call \n BatchUpdateFindings\n .

" } }, "Updates": { @@ -25516,7 +25516,7 @@ "Type": { "target": "com.amazonaws.securityhub#FindingHistoryUpdateSourceType", "traits": { - "smithy.api#documentation": "

\n Describes the type of finding change event, such as a call to \n BatchImportFindings\n (by an integrated Amazon Web Servicesservice or third party partner integration) or \n BatchUpdateFindings\n (by a Security Hub customer). \n

" + "smithy.api#documentation": "

\n Describes the type of finding change event, such as a call to \n BatchImportFindings\n (by an integrated Amazon Web Services service or third party partner integration) or \n BatchUpdateFindings\n (by a Security Hub customer). \n

" } }, "Identity": { @@ -26222,7 +26222,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the current finding aggregation configuration.

", + "smithy.api#documentation": "\n

The aggregation Region is now called the home Region.

\n \n

Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes \nthe home Region and any linked Regions.

", "smithy.api#examples": [ { "title": "To get cross-Region aggregation details", @@ -26276,7 +26276,7 @@ "FindingAggregationRegion": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The aggregation Region.

" + "smithy.api#documentation": "

The home Region. Findings generated in linked Regions are replicated and sent to the home Region.

" } }, "RegionLinkingMode": { @@ -26415,7 +26415,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of findings that match the specified criteria.

\n

If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.

", + "smithy.api#documentation": "

Returns a list of findings that match the specified criteria.

\n

If cross-Region aggregation is enabled, then when you call GetFindings from the home Region, the results include all of the matching findings from both the home Region and linked Regions.

", "smithy.api#examples": [ { "title": "To get a list of findings", @@ -26761,7 +26761,7 @@ "InsightArns": { "target": "com.amazonaws.securityhub#ArnList", "traits": { - "smithy.api#documentation": "

The ARNs of the insights to describe. If you do not provide any insight ARNs, then\n GetInsights returns all of your custom insights. It does not return any\n managed insights.

" + "smithy.api#documentation": "

The ARNs of the insights to describe. If you don't provide any insight ARNs, then\n GetInsights returns all of your custom insights. It does not return any\n managed insights.

" } }, "NextToken": { @@ -26826,7 +26826,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the count of all Security Hub membership invitations that were sent to the\n current member account, not including the currently accepted invitation.

", + "smithy.api#documentation": "\n

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. \n For information, see Managing Security Hub administrator and member accounts with Organizations \n in the Security Hub User Guide.

\n \n

Returns the count of all Security Hub membership invitations that were sent to the\n calling member account, not including the currently accepted invitation.

", "smithy.api#examples": [ { "title": "To get a count of membership invitations", @@ -27463,7 +27463,7 @@ } ], "traits": { - "smithy.api#documentation": "

Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that\n the invitation is sent from.

\n

This operation is only used to invite accounts that do not belong to an organization.\n Organization accounts do not receive invitations.

\n

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

\n

When the account owner enables Security Hub and accepts the invitation to become a member\n account, the administrator account can view the findings generated from the member account.

", + "smithy.api#documentation": "\n

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. \n For information, see Managing Security Hub administrator and member accounts with Organizations \n in the Security Hub User Guide.

\n \n

Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that\n the invitation is sent from.

\n

This operation is only used to invite accounts that don't belong to an Amazon Web Services organization.\n Organization accounts don't receive invitations.

\n

Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub.

\n

When the account owner enables Security Hub and accepts the invitation to become a member\n account, the administrator account can view the findings generated in the member account.

", "smithy.api#examples": [ { "title": "To invite accounts to become members", @@ -28078,7 +28078,7 @@ } ], "traits": { - "smithy.api#documentation": "

If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.

", + "smithy.api#documentation": "

If cross-Region aggregation is enabled, then ListFindingAggregators returns the Amazon Resource Name (ARN) \nof the finding aggregator. You can run this operation from any Amazon Web Services Region.

", "smithy.api#examples": [ { "title": "To update the enablement status of a standard control", @@ -28170,7 +28170,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account.

\n

This operation is only used by accounts that are managed by invitation.\n Accounts that are managed using the integration with Organizations do not receive invitations.

", + "smithy.api#documentation": "\n

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. \n For information, see Managing Security Hub administrator and member accounts with Organizations \n in the Security Hub User Guide.

\n \n

Lists all Security Hub membership invitations that were sent to the calling account.

\n

Only accounts that are managed by invitation can use this operation.\n Accounts that are managed using the integration with Organizations don't receive invitations.

", "smithy.api#http": { "method": "GET", "uri": "/invitations", @@ -29732,7 +29732,7 @@ "SecurityHub": { "target": "com.amazonaws.securityhub#SecurityHubPolicy", "traits": { - "smithy.api#documentation": "

\n The Amazon Web Servicesservice that the configuration policy applies to.\n

" + "smithy.api#documentation": "

\n The Amazon Web Services service that the configuration policy applies to.\n

" } } }, @@ -30927,7 +30927,7 @@ "DestinationPrefixListId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

\n The prefix of the destination Amazon Web Servicesservice.\n

" + "smithy.api#documentation": "

\n The prefix of the destination Amazon Web Services service.\n

" } }, "EgressOnlyInternetGatewayId": { @@ -31534,7 +31534,7 @@ "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Servicesservice name and a \n number, such as APIGateway.3.\n

", + "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service name and a \n number, such as APIGateway.3.\n

", "smithy.api#required": {} } }, @@ -31642,7 +31642,7 @@ "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an \n Amazon Web Servicesservice name and a number (for example, APIGateway.3). This parameter differs from \n SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The \n ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).\n

", + "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an \n Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from \n SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The \n ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).\n

", "smithy.api#required": {} } }, @@ -32038,7 +32038,7 @@ "name": "securityhub" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps \n you assess your Amazon Web Services environment against security industry standards and best practices.

\n

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and \n supported third-party products and helps you analyze your security trends and identify the highest priority security \n issues.

\n

To help you manage the security state of your organization, Security Hub supports multiple security standards. \n These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services, \n and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data \n Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes \n several security controls, each of which represents a security best practice. Security Hub runs checks against \n security controls and generates control findings to help you assess your compliance against security best practices.

\n

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices, \n such as Amazon GuardDuty and Amazon Inspector, and \n supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You \n can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.

\n

Security Hub offers automation features that help you triage and remediate security issues. For example, \n you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with \n Amazon EventBridge to trigger automatic responses to specific findings.

\n

This guide, the Security Hub API Reference, provides\n information about the Security Hub API. This includes supported resources, HTTP methods, parameters,\n and schemas. If you're new to Security Hub, you might find it helpful to also review the \n Security Hub User Guide\n . The\n user guide explains key concepts and provides procedures\n that demonstrate how to use Security Hub features. It also provides information about topics such as\n integrating Security Hub with other Amazon Web Servicesservices.

\n

In addition to interacting with Security Hub by making calls to the Security Hub API, you can\n use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools \n and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,\n Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to\n Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests, \n managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools\n and SDKs, see Tools to Build on Amazon Web Services.

\n

With the exception of operations that are related to central configuration, Security Hub API requests are executed only in\n the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change\n that results from the operation is applied only to that Region. To make the same change in\n other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration, \nAPI requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of \ncentral configuration operations, see the Central configuration \nterms and concepts section of the Security Hub User Guide.

\n

The following throttling limits apply to Security Hub API operations.

\n
    \n
  • \n

    \n BatchEnableStandards - RateLimit of 1 request per\n second. BurstLimit of 1 request per second.

    \n
    • \n
  • \n

    \n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.

    \n
    • \n
  • \n

    \n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
  • \n

    \n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
  • \n

    \n UpdateStandardsControl - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.

    \n
    • \n
  • \n

    All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
", + "smithy.api#documentation": "

Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps \n you assess your Amazon Web Services environment against security industry standards and best practices.

\n

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, and \n supported third-party products and helps you analyze your security trends and identify the highest priority security \n issues.

\n

To help you manage the security state of your organization, Security Hub supports multiple security standards. \n These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services, \n and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data \n Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes \n several security controls, each of which represents a security best practice. Security Hub runs checks against \n security controls and generates control findings to help you assess your compliance against security best practices.

\n

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services, \n such as Amazon GuardDuty and Amazon Inspector, and \n supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You \n can also send Security Hub findings to other Amazon Web Services services and supported third-party products.

\n

Security Hub offers automation features that help you triage and remediate security issues. For example, \n you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with \n Amazon EventBridge to trigger automatic responses to specific findings.

\n

This guide, the Security Hub API Reference, provides\n information about the Security Hub API. This includes supported resources, HTTP methods, parameters,\n and schemas. If you're new to Security Hub, you might find it helpful to also review the \n Security Hub User Guide\n . The\n user guide explains key concepts and provides procedures\n that demonstrate how to use Security Hub features. It also provides information about topics such as\n integrating Security Hub with other Amazon Web Services services.

\n

In addition to interacting with Security Hub by making calls to the Security Hub API, you can\n use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools \n and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,\n Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to\n Security Hub and other Amazon Web Services services . They also handle tasks such as signing requests, \n managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools\n and SDKs, see Tools to Build on Amazon Web Services.

\n

With the exception of operations that are related to central configuration, Security Hub API requests are executed only in\n the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change\n that results from the operation is applied only to that Region. To make the same change in\n other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration, \nAPI requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of \ncentral configuration operations, see the Central configuration \nterms and concepts section of the Security Hub User Guide.

\n

The following throttling limits apply to Security Hub API operations.

\n
    \n
  • \n

    \n BatchEnableStandards - RateLimit of 1 request per\n second. BurstLimit of 1 request per second.

    \n
    • \n
  • \n

    \n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.

    \n
    • \n
  • \n

    \n BatchImportFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
  • \n

    \n BatchUpdateFindings - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
  • \n

    \n UpdateStandardsControl - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.

    \n
    • \n
  • \n

    All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.

    \n
    • \n
", "smithy.api#title": "AWS SecurityHub", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -33123,13 +33123,13 @@ "Label": { "target": "com.amazonaws.securityhub#SeverityLabel", "traits": { - "smithy.api#documentation": "

The severity value of the finding. The allowed values are the following.

\n
    \n
  • \n

    \n INFORMATIONAL - No issue was found.

    \n
    • \n
  • \n

    \n LOW - The issue does not require action on its own.

    \n
    • \n
  • \n

    \n MEDIUM - The issue must be addressed but not urgently.

    \n
    • \n
  • \n

    \n HIGH - The issue must be addressed as a priority.

    \n
    • \n
  • \n

    \n CRITICAL - The issue must be remediated immediately to avoid it\n escalating.

    \n
    • \n
\n

If you provide Normalized and do not provide Label, then\n Label is set automatically as follows.

\n
    \n
  • \n

    0 - INFORMATIONAL\n

    \n
    • \n
  • \n

    1–39 - LOW\n

    \n
    • \n
  • \n

    40–69 - MEDIUM\n

    \n
    • \n
  • \n

    70–89 - HIGH\n

    \n
    • \n
  • \n

    90–100 - CRITICAL\n

    \n
    • \n
" + "smithy.api#documentation": "

The severity value of the finding. The allowed values are the following.

\n
    \n
  • \n

    \n INFORMATIONAL - No issue was found.

    \n
    • \n
  • \n

    \n LOW - The issue does not require action on its own.

    \n
    • \n
  • \n

    \n MEDIUM - The issue must be addressed but not urgently.

    \n
    • \n
  • \n

    \n HIGH - The issue must be addressed as a priority.

    \n
    • \n
  • \n

    \n CRITICAL - The issue must be remediated immediately to avoid it\n escalating.

    \n
    • \n
\n

If you provide Normalized and don't provide Label, then\n Label is set automatically as follows.

\n
    \n
  • \n

    0 - INFORMATIONAL\n

    \n
    • \n
  • \n

    1–39 - LOW\n

    \n
    • \n
  • \n

    40–69 - MEDIUM\n

    \n
    • \n
  • \n

    70–89 - HIGH\n

    \n
    • \n
  • \n

    90–100 - CRITICAL\n

    \n
    • \n
" } }, "Normalized": { "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "

Deprecated. The normalized severity of a finding.\n Instead of providing Normalized, provide Label.

\n

The value of Normalized can be an integer between 0 and 100.

\n

If you provide Label and do not provide Normalized, then\n Normalized is set automatically as follows.

\n
    \n
  • \n

    \n INFORMATIONAL - 0

    \n
    • \n
  • \n

    \n LOW - 1

    \n
    • \n
  • \n

    \n MEDIUM - 40

    \n
    • \n
  • \n

    \n HIGH - 70

    \n
    • \n
  • \n

    \n CRITICAL - 90

    \n
    • \n
" + "smithy.api#documentation": "

Deprecated. The normalized severity of a finding.\n Instead of providing Normalized, provide Label.

\n

The value of Normalized can be an integer between 0 and 100.

\n

If you provide Label and don't provide Normalized, then\n Normalized is set automatically as follows.

\n
    \n
  • \n

    \n INFORMATIONAL - 0

    \n
    • \n
  • \n

    \n LOW - 1

    \n
    • \n
  • \n

    \n MEDIUM - 40

    \n
    • \n
  • \n

    \n HIGH - 70

    \n
    • \n
  • \n

    \n CRITICAL - 90

    \n
    • \n
" } }, "Original": { @@ -33213,7 +33213,7 @@ "Normalized": { "target": "com.amazonaws.securityhub#RatioScale", "traits": { - "smithy.api#documentation": "

The normalized severity for the finding. This attribute is to be deprecated in favor of\n Label.

\n

If you provide Normalized and do not provide Label,\n Label is set automatically as follows.

\n
    \n
  • \n

    0 - INFORMATIONAL\n

    \n
    • \n
  • \n

    1–39 - LOW\n

    \n
    • \n
  • \n

    40–69 - MEDIUM\n

    \n
    • \n
  • \n

    70–89 - HIGH\n

    \n
    • \n
  • \n

    90–100 - CRITICAL\n

    \n
    • \n
" + "smithy.api#documentation": "

The normalized severity for the finding. This attribute is to be deprecated in favor of\n Label.

\n

If you provide Normalized and don't provide Label,\n Label is set automatically as follows.

\n
    \n
  • \n

    0 - INFORMATIONAL\n

    \n
    • \n
  • \n

    1–39 - LOW\n

    \n
    • \n
  • \n

    40–69 - MEDIUM\n

    \n
    • \n
  • \n

    70–89 - HIGH\n

    \n
    • \n
  • \n

    90–100 - CRITICAL\n

    \n
    • \n
" } }, "Product": { @@ -33492,7 +33492,7 @@ "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Servicesservice \n name and a number, such as APIGateway.3.\n

", + "smithy.api#documentation": "

\n The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Services service \n name and a number, such as APIGateway.3.\n

", "smithy.api#required": {} } }, @@ -33610,7 +33610,7 @@ "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

\n A unique standard-agnostic identifier for a control. Values for this field typically consist of an \n Amazon Web Servicesservice and a number, such as APIGateway.5. This field doesn't reference a specific standard.\n

", + "smithy.api#documentation": "

\n A unique standard-agnostic identifier for a control. Values for this field typically consist of an \n Amazon Web Services service and a number, such as APIGateway.5. This field doesn't reference a specific standard.\n

", "smithy.api#required": {} } }, @@ -35361,7 +35361,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.

\n

You must run UpdateFindingAggregator from the current aggregation Region.\n

", + "smithy.api#documentation": "\n

The aggregation Region is now called the home Region.

\n \n

Updates cross-Region aggregation settings. You can use this operation to update the Region linking mode and the list \n of included or excluded Amazon Web Services Regions. However, you can't use this operation to change the home Region.

\n

You can invoke this operation from the current home Region only.\n

", "smithy.api#examples": [ { "title": "To update cross-Region aggregation settings", @@ -35414,7 +35414,7 @@ "Regions": { "target": "com.amazonaws.securityhub#StringList", "traits": { - "smithy.api#documentation": "

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

\n

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.

\n

An InvalidInputException error results if you populate this field while RegionLinkingMode is \n NO_REGIONS.

" + "smithy.api#documentation": "

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.

\n

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.

\n

An InvalidInputException error results if you populate this field while RegionLinkingMode is \n NO_REGIONS.

" } } }, @@ -35434,7 +35434,7 @@ "FindingAggregationRegion": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "

The aggregation Region.

" + "smithy.api#documentation": "

The home Region. Findings generated in linked Regions are replicated and sent to the home Region.

" } }, "RegionLinkingMode": { @@ -36343,7 +36343,7 @@ "Status": { "target": "com.amazonaws.securityhub#WorkflowStatus", "traits": { - "smithy.api#documentation": "

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

\n

The allowed values are the following.

\n
    \n
  • \n

    \n NEW - The initial state of a finding, before it is reviewed.

    \n

    Security Hub also resets the workflow status from NOTIFIED or\n RESOLVED to NEW in the following cases:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to\n ACTIVE.

      \n
      • \n
    • \n

      \n ComplianceStatus changes from PASSED to either\n WARNING, FAILED, or\n NOT_AVAILABLE.

      \n
      • \n
    \n
    • \n
  • \n

    \n NOTIFIED - Indicates that you notified the resource owner about the\n security issue. Used when the initial reviewer is not the resource owner, and needs\n intervention from the resource owner.

    \n
    • \n
  • \n

    \n SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.

    \n
    • \n
  • \n

    \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

\n

The allowed values are the following.

\n
    \n
  • \n

    \n NEW - The initial state of a finding, before it is reviewed.

    \n

    Security Hub also resets the workflow status from NOTIFIED or\n RESOLVED to NEW in the following cases:

    \n
      \n
    • \n

      \n RecordState changes from ARCHIVED to\n ACTIVE.

      \n
      • \n
    • \n

      \n ComplianceStatus changes from PASSED to either\n WARNING, FAILED, or\n NOT_AVAILABLE.

      \n
      • \n
    \n
    • \n
  • \n

    \n NOTIFIED - Indicates that you notified the resource owner about the\n security issue. Used when the initial reviewer is not the resource owner, and needs\n intervention from the resource owner.

    \n
    • \n
  • \n

    \n SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is needed. The finding is no longer updated.

    \n
    • \n
  • \n

    \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

    \n
    • \n
" } } }, @@ -36426,7 +36426,7 @@ "Status": { "target": "com.amazonaws.securityhub#WorkflowStatus", "traits": { - "smithy.api#documentation": "

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

\n

The allowed values are the following.

\n
    \n
  • \n

    \n NEW - The initial state of a finding, before it is reviewed.

    \n

    Security Hub also resets WorkFlowStatus from NOTIFIED or\n RESOLVED to NEW in the following cases:

    \n
      \n
    • \n

      The record state changes from ARCHIVED to\n ACTIVE.

      \n
      • \n
    • \n

      The compliance status changes from PASSED to either\n WARNING, FAILED, or\n NOT_AVAILABLE.

      \n
      • \n
    \n
    • \n
  • \n

    \n NOTIFIED - Indicates that you notified the resource owner about the\n security issue. Used when the initial reviewer is not the resource owner, and needs\n intervention from the resource owner.

    \n
    • \n
  • \n

    \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

    \n
    • \n
  • \n

    \n SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.

    \n
    • \n
" + "smithy.api#documentation": "

The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

\n

The allowed values are the following.

\n
    \n
  • \n

    \n NEW - The initial state of a finding, before it is reviewed.

    \n

    Security Hub also resets WorkFlowStatus from NOTIFIED or\n RESOLVED to NEW in the following cases:

    \n
      \n
    • \n

      The record state changes from ARCHIVED to\n ACTIVE.

      \n
      • \n
    • \n

      The compliance status changes from PASSED to either\n WARNING, FAILED, or\n NOT_AVAILABLE.

      \n
      • \n
    \n
    • \n
  • \n

    \n NOTIFIED - Indicates that you notified the resource owner about the\n security issue. Used when the initial reviewer is not the resource owner, and needs\n intervention from the resource owner.

    \n
    • \n
  • \n

    \n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.

    \n
    • \n
  • \n

    \n SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is needed. The finding is no longer updated.

    \n
    • \n
" } } }, diff --git a/codegen/sdk/aws-models/securitylake.json b/codegen/sdk/aws-models/securitylake.json index 91aa6e7dc08..b1029f35912 100644 --- a/codegen/sdk/aws-models/securitylake.json +++ b/codegen/sdk/aws-models/securitylake.json @@ -59,7 +59,7 @@ "min": 1, "max": 1011 }, - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):securitylake:[A-za-z0-9_/.\\-]{0,63}:[A-za-z0-9_/.\\-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.\\-]{0,127}$" + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):securitylake:[A-Za-z0-9_/.\\-]{0,63}:[A-Za-z0-9_/.\\-]{0,63}:[A-Za-z0-9][A-Za-z0-9_/.\\-]{0,127}$" } }, "com.amazonaws.securitylake#AwsAccountId": { @@ -79,20 +79,20 @@ "principal": { "target": "com.amazonaws.securitylake#AwsPrincipal", "traits": { - "smithy.api#documentation": "

The AWS identity principal.

", + "smithy.api#documentation": "

The Amazon Web Services identity principal.

", "smithy.api#required": {} } }, "externalId": { "target": "com.amazonaws.securitylake#ExternalId", "traits": { - "smithy.api#documentation": "

The external ID used to estalish trust relationship with the AWS identity.

", + "smithy.api#documentation": "

The external ID used to establish trust relationship with the Amazon Web Services identity.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The AWS identity.

" + "smithy.api#documentation": "

The Amazon Web Services identity.

" } }, "com.amazonaws.securitylake#AwsLogSourceConfiguration": { @@ -114,7 +114,7 @@ "sourceName": { "target": "com.amazonaws.securitylake#AwsLogSourceName", "traits": { - "smithy.api#documentation": "

The name for a Amazon Web Services source. This must be a Regionally unique value.

", + "smithy.api#documentation": "

The name for a Amazon Web Services source.

", "smithy.api#required": {} } }, @@ -122,12 +122,12 @@ "target": "com.amazonaws.securitylake#AwsLogSourceVersion", "traits": { "smithy.api#default": "latest", - "smithy.api#documentation": "

The version for a Amazon Web Services source. This must be a Regionally unique value.

" + "smithy.api#documentation": "

The version for a Amazon Web Services source.

" } } }, "traits": { - "smithy.api#documentation": "

The Security Lake logs source configuration file describes the information needed to generate Security Lake logs.

" + "smithy.api#documentation": "

To add a natively-supported Amazon Web Services service as a log source, use these\n parameters to specify the configuration settings for the log source.

" } }, "com.amazonaws.securitylake#AwsLogSourceConfigurationList": { @@ -212,7 +212,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.

" + "smithy.api#documentation": "

Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services\n services.

" } }, "com.amazonaws.securitylake#AwsLogSourceResourceList": { @@ -315,7 +315,7 @@ "glue:CreateTable", "glue:CreateDatabase" ], - "smithy.api#documentation": "

Adds a natively supported Amazon Web Service as an Amazon Security Lake source. Enables\n source types for member accounts in required Amazon Web Services Regions, based on the\n parameters you specify. You can choose any source type in any Region for either accounts\n that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Service as a source, Security Lake starts collecting logs and events from it.

\n

You can use this API only to enable natively supported Amazon Web Services as a\n source. Use CreateCustomLogSource to enable data collection from a custom\n source.

", + "smithy.api#documentation": "

Adds a natively supported Amazon Web Services service as an Amazon Security Lake source. Enables\n source types for member accounts in required Amazon Web Services Regions, based on the\n parameters you specify. You can choose any source type in any Region for either accounts\n that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Services service as a source, Security Lake starts collecting logs and events from it.

\n

You can use this API only to enable natively supported Amazon Web Services services as a\n source. Use CreateCustomLogSource to enable data collection from a custom\n source.

", "smithy.api#http": { "method": "POST", "uri": "/v1/datalake/logsources/aws", @@ -344,7 +344,7 @@ "failed": { "target": "com.amazonaws.securitylake#AccountList", "traits": { - "smithy.api#documentation": "

Lists all accounts in which enabling a natively supported Amazon Web Service as\n a Security Lake source failed. The failure occurred as these accounts are not part of an\n organization.

" + "smithy.api#documentation": "

Lists all accounts in which enabling a natively supported Amazon Web Services service as\n a Security Lake source failed. The failure occurred as these accounts are not part of an\n organization.

" } } }, @@ -414,7 +414,7 @@ "sourceName": { "target": "com.amazonaws.securitylake#CustomLogSourceName", "traits": { - "smithy.api#documentation": "

Specify the name for a third-party custom source. This must be a Regionally unique\n value.

", + "smithy.api#documentation": "

Specify the name for a third-party custom source. This must be a Regionally unique\n value. The sourceName you enter here, is used in the\n LogProviderRole name which follows the convention\n AmazonSecurityLake-Provider-{name of the custom source}-{region}. You must\n use a CustomLogSource name that is shorter than or equal to 20 characters.\n This ensures that the LogProviderRole name is below the 64 character\n limit.

", "smithy.api#required": {} } }, @@ -433,7 +433,7 @@ "configuration": { "target": "com.amazonaws.securitylake#CustomLogSourceConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for the third-party custom source.

", + "smithy.api#documentation": "

The configuration used for the third-party custom source.

", "smithy.api#required": {} } } @@ -448,7 +448,7 @@ "source": { "target": "com.amazonaws.securitylake#CustomLogSourceResource", "traits": { - "smithy.api#documentation": "

The created third-party custom source.

" + "smithy.api#documentation": "

The third-party custom source that was created.

" } } }, @@ -516,7 +516,7 @@ "lambda:CreateFunction", "lambda:CreateEventSourceMapping" ], - "smithy.api#documentation": "

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You\n can enable Security Lake in Amazon Web Services Regions with customized settings before enabling\n log collection in Regions. To specify particular Regions, configure these Regions using the\n configurations parameter. If you have already enabled Security Lake in a Region\n when you call this command, the command will update the Region if you provide new\n configuration parameters. If you have not already enabled Security Lake in the Region when you\n call this API, it will set up the data lake in the Region with the specified\n configurations.

\n

When you enable Security Lake, it starts ingesting security data after the\n CreateAwsLogSource call. This includes ingesting security data from\n sources, storing data, and making data accessible to subscribers. Security Lake also enables\n all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For\n more information, see the Amazon Security Lake User\n Guide.

", + "smithy.api#documentation": "

Initializes an Amazon Security Lake instance with the provided (or default) configuration. You\n can enable Security Lake in Amazon Web Services Regions with customized settings before enabling\n log collection in Regions. To specify particular Regions, configure these Regions using the\n configurations parameter. If you have already enabled Security Lake in a Region\n when you call this command, the command will update the Region if you provide new\n configuration parameters. If you have not already enabled Security Lake in the Region when you\n call this API, it will set up the data lake in the Region with the specified\n configurations.

\n

When you enable Security Lake, it starts ingesting security data after the\n CreateAwsLogSource call and after you create subscribers using the CreateSubscriber API. This includes ingesting security data from\n sources, storing data, and making data accessible to subscribers. Security Lake also enables\n all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For\n more information, see the Amazon Security Lake User\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/v1/datalake", @@ -554,7 +554,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get instant notifications about exceptions. Subscribes to the SNS topics for exception notifications", - "smithy.api#documentation": "

Creates the specified notification subscription in Amazon Security Lake for the organization\n you specify.

", + "smithy.api#documentation": "

Creates the specified notification subscription in Amazon Security Lake for the organization\n you specify. The notification subscription is created for exceptions that cannot be resolved by Security Lake automatically.

", "smithy.api#http": { "method": "POST", "uri": "/v1/datalake/exceptions/subscription", @@ -582,7 +582,7 @@ "exceptionTimeToLive": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The expiration period and time-to-live (TTL).

", + "smithy.api#documentation": "

The expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.

", "smithy.api#range": { "min": 1 } @@ -749,7 +749,7 @@ "ram:UpdateResourceShare", "ram:GetResourceShares" ], - "smithy.api#documentation": "

Creates a subscription permission for accounts that are already enabled in\n Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.

", + "smithy.api#documentation": "

Creates a subscriber for accounts that are already enabled in Amazon Security Lake. You can\n create a subscriber with access to data in the current Amazon Web Services Region.

", "smithy.api#http": { "method": "POST", "uri": "/v1/subscribers", @@ -880,7 +880,7 @@ "sources": { "target": "com.amazonaws.securitylake#LogSourceResourceList", "traits": { - "smithy.api#documentation": "

The supported Amazon Web Services from which logs and events are collected.\n Security Lake supports log and event collection for natively supported Amazon Web Services.

", + "smithy.api#documentation": "

The supported Amazon Web Services services from which logs and events are collected.\n Security Lake supports log and event collection for natively supported Amazon Web Services services.

", "smithy.api#required": {} } }, @@ -947,7 +947,7 @@ "crawlerConfiguration": { "target": "com.amazonaws.securitylake#CustomLogSourceCrawlerConfiguration", "traits": { - "smithy.api#documentation": "

The configuration for the Glue Crawler for the third-party custom source.

", + "smithy.api#documentation": "

The configuration used for the Glue Crawler for a third-party custom source.

", "smithy.api#required": {} } }, @@ -960,7 +960,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for the third-party custom source.

" + "smithy.api#documentation": "

The configuration used for the third-party custom source.

" } }, "com.amazonaws.securitylake#CustomLogSourceCrawlerConfiguration": { @@ -975,7 +975,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration for the Glue Crawler for the third-party custom source.

" + "smithy.api#documentation": "

The configuration used for the Glue Crawler for a third-party custom source.

" } }, "com.amazonaws.securitylake#CustomLogSourceName": { @@ -1187,7 +1187,7 @@ "kmsKeyId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake\n object.

" + "smithy.api#documentation": "

The identifier of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake\n object.

" } } }, @@ -1364,7 +1364,7 @@ "createStatus": { "target": "com.amazonaws.securitylake#DataLakeStatus", "traits": { - "smithy.api#documentation": "

Retrieves the status of the configuration operation for an account in Amazon Security Lake.

" + "smithy.api#documentation": "

Retrieves the status of the CreateDatalake API call for an account in Amazon Security Lake.

" } }, "updateStatus": { @@ -1396,7 +1396,7 @@ "sourceName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The supported Amazon Web Services from which logs and events are collected.\n Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

" + "smithy.api#documentation": "

The supported Amazon Web Services services from which logs and events are collected.\n Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services.

" } }, "eventClasses": { @@ -1413,7 +1413,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon Security Lake collects logs and events from supported Amazon Web Services and\n custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

" + "smithy.api#documentation": "

Amazon Security Lake collects logs and events from supported Amazon Web Services services and\n custom sources. For the list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.

" } }, "com.amazonaws.securitylake#DataLakeSourceList": { @@ -1556,7 +1556,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to disable any source type in any region for accounts that are part of a trusted organization or standalone accounts", - "smithy.api#documentation": "

Removes a natively supported Amazon Web Service as an Amazon Security Lake source. You\n can remove a source for one or more Regions. When you remove the source, Security Lake stops\n collecting data from that source in the specified Regions and accounts, and subscribers can\n no longer consume new data from the source. However, subscribers can still consume data\n that Security Lake collected from the source before removal.

\n

You can choose any source type in any Amazon Web Services Region for either accounts that\n are part of a trusted organization or standalone accounts.

", + "smithy.api#documentation": "

Removes a natively supported Amazon Web Services service as an Amazon Security Lake source. You\n can remove a source for one or more Regions. When you remove the source, Security Lake stops\n collecting data from that source in the specified Regions and accounts, and subscribers can\n no longer consume new data from the source. However, subscribers can still consume data\n that Security Lake collected from the source before removal.

\n

You can choose any source type in any Amazon Web Services Region for either accounts that\n are part of a trusted organization or standalone accounts.

", "smithy.api#http": { "method": "POST", "uri": "/v1/datalake/logsources/aws/delete", @@ -1945,7 +1945,7 @@ "sqs:DeleteQueue", "sqs:GetQueueUrl" ], - "smithy.api#documentation": "

Deletes the specified notification subscription in Amazon Security Lake for the organization\n you specify.

", + "smithy.api#documentation": "

Deletes the specified subscription notification in Amazon Security Lake for the organization\n you specify.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/subscribers/{subscriberId}/notification", @@ -2104,7 +2104,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to query the protocol and endpoint that were provided when subscribing to SNS topics for exception notifications", - "smithy.api#documentation": "

Retrieves the details of exception notifications for the account in Amazon Security Lake.

", + "smithy.api#documentation": "

Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.

", "smithy.api#http": { "method": "GET", "uri": "/v1/datalake/exceptions/subscription", @@ -2138,7 +2138,7 @@ "exceptionTimeToLive": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The expiration period and time-to-live (TTL).

" + "smithy.api#documentation": "

The expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.

" } } }, @@ -2201,7 +2201,7 @@ "autoEnableNewAccount": { "target": "com.amazonaws.securitylake#DataLakeAutoEnableNewAccountConfigurationList", "traits": { - "smithy.api#documentation": "

The configuration for new accounts.

" + "smithy.api#documentation": "

The configuration used for new accounts in Security Lake.

" } } }, @@ -2430,7 +2430,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configurations for HTTPS subscriber notification.

" + "smithy.api#documentation": "

The configurations used for HTTPS subscriber notification.

" } }, "com.amazonaws.securitylake#InternalServerException": { @@ -2505,13 +2505,13 @@ "target": "com.amazonaws.securitylake#MaxResults", "traits": { "smithy.api#default": 50, - "smithy.api#documentation": "

List the maximum number of failures in Security Lake.

" + "smithy.api#documentation": "

Lists the maximum number of failures in Security Lake.

" } }, "nextToken": { "target": "com.amazonaws.securitylake#NextToken", "traits": { - "smithy.api#documentation": "

List if there are more results available. The value of nextToken is a unique pagination\n token for each page. Repeat the call using the returned token to retrieve the next page.\n Keep all other arguments unchanged.

\n

Each pagination token expires after 24 hours. Using an expired pagination token will\n return an HTTP 400 InvalidToken error.

" + "smithy.api#documentation": "

Lists if there are more results available. The value of nextToken is a unique pagination\n token for each page. Repeat the call using the returned token to retrieve the next page.\n Keep all other arguments unchanged.

\n

Each pagination token expires after 24 hours. Using an expired pagination token will\n return an HTTP 400 InvalidToken error.

" } } }, @@ -2525,13 +2525,13 @@ "exceptions": { "target": "com.amazonaws.securitylake#DataLakeExceptionList", "traits": { - "smithy.api#documentation": "

Lists the failures that cannot be retried in the current Region.

" + "smithy.api#documentation": "

Lists the failures that cannot be retried.

" } }, "nextToken": { "target": "com.amazonaws.securitylake#NextToken", "traits": { - "smithy.api#documentation": "

List if there are more results available. The value of nextToken is a unique pagination\n token for each page. Repeat the call using the returned token to retrieve the next page.\n Keep all other arguments unchanged.

\n

Each pagination token expires after 24 hours. Using an expired pagination token will\n return an HTTP 400 InvalidToken error.

" + "smithy.api#documentation": "

Lists if there are more results available. The value of nextToken is a unique pagination\n token for each page. Repeat the call using the returned token to retrieve the next page.\n Keep all other arguments unchanged.

\n

Each pagination token expires after 24 hours. Using an expired pagination token will\n return an HTTP 400 InvalidToken error.

" } } }, @@ -2637,7 +2637,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to view the enabled accounts. You can view the enabled sources in the enabled regions", - "smithy.api#documentation": "

Retrieves the log sources in the current Amazon Web Services Region.

", + "smithy.api#documentation": "

Retrieves the log sources.

", "smithy.api#http": { "method": "POST", "uri": "/v1/datalake/logsources/list", @@ -2741,7 +2741,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list all subscribers", - "smithy.api#documentation": "

List all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list\n of subscriptions associated with a specific organization or Amazon Web Services account.

", + "smithy.api#documentation": "

Lists all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list\n of subscriptions associated with a specific organization or Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/v1/subscribers", @@ -2905,7 +2905,7 @@ "awsLogSource": { "target": "com.amazonaws.securitylake#AwsLogSourceResource", "traits": { - "smithy.api#documentation": "

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

" + "smithy.api#documentation": "

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the Amazon Security Lake User Guide.

" } }, "customLogSource": { @@ -2916,7 +2916,7 @@ } }, "traits": { - "smithy.api#documentation": "

The supported source types from which logs and events are collected in Amazon Security Lake.\n For a list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

" + "smithy.api#documentation": "

The supported source types from which logs and events are collected in Amazon Security Lake.\n For a list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.

" } }, "com.amazonaws.securitylake#LogSourceResourceList": { @@ -2954,7 +2954,7 @@ "httpsNotificationConfiguration": { "target": "com.amazonaws.securitylake#HttpsNotificationConfiguration", "traits": { - "smithy.api#documentation": "

The configurations for HTTPS subscriber notification.

" + "smithy.api#documentation": "

The configurations used for HTTPS subscriber notification.

" } } }, @@ -3219,7 +3219,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "

Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to\n automatically centralize security data from cloud, on-premises, and custom sources into a\n data lake that's stored in your Amazon Web Services account. Amazon Web Services Organizations\n is an account management service that lets you consolidate multiple Amazon Web Services\n accounts into an organization that you create and centrally manage. With Organizations, you\n can create member accounts and invite existing accounts to join your organization.\n Security Lake helps you analyze security data for a more complete understanding of your\n security posture across the entire organization. It can also help you improve the\n protection of your workloads, applications, and data.

\n

The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you\n retain ownership over your data.

\n

Amazon Security Lake integrates with CloudTrail, a service that provides a record of\n actions taken by a user, role, or an Amazon Web Services service. In Security Lake, CloudTrail captures API calls for Security Lake as events. The calls captured include calls\n from the Security Lake console and code calls to the Security Lake API operations. If you create a\n trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still\n view the most recent events in the CloudTrail console in Event history. Using the\n information collected by CloudTrail you can determine the request that was made to\n Security Lake, the IP address from which the request was made, who made the request, when it\n was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.

\n

Security Lake automates the collection of security-related log and event data from\n integrated Amazon Web Services and third-party services. It also helps you manage\n the lifecycle of data with customizable retention and replication settings. Security Lake\n converts ingested data into Apache Parquet format and a standard open-source schema called\n the Open Cybersecurity Schema Framework (OCSF).

\n

Other Amazon Web Services and third-party services can subscribe to the data that's stored in Security Lake for \n incident response and security data analytics.

", + "smithy.api#documentation": "

Amazon Security Lake is a fully managed security data lake service. You can use Security Lake to\n automatically centralize security data from cloud, on-premises, and custom sources into a\n data lake that's stored in your Amazon Web Services account. Amazon Web Services Organizations\n is an account management service that lets you consolidate multiple Amazon Web Services\n accounts into an organization that you create and centrally manage. With Organizations, you\n can create member accounts and invite existing accounts to join your organization.\n Security Lake helps you analyze security data for a more complete understanding of your\n security posture across the entire organization. It can also help you improve the\n protection of your workloads, applications, and data.

\n

The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets, and you\n retain ownership over your data.

\n

Amazon Security Lake integrates with CloudTrail, a service that provides a record of\n actions taken by a user, role, or an Amazon Web Services service. In Security Lake, CloudTrail captures API calls for Security Lake as events. The calls captured include calls\n from the Security Lake console and code calls to the Security Lake API operations. If you create a\n trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Security Lake. If you don't configure a trail, you can still\n view the most recent events in the CloudTrail console in Event history. Using the\n information collected by CloudTrail you can determine the request that was made to\n Security Lake, the IP address from which the request was made, who made the request, when it\n was made, and additional details. To learn more about Security Lake information in CloudTrail, see the Amazon Security Lake User Guide.

\n

Security Lake automates the collection of security-related log and event data from\n integrated Amazon Web Services services and third-party services. It also helps you manage\n the lifecycle of data with customizable retention and replication settings. Security Lake\n converts ingested data into Apache Parquet format and a standard open-source schema called\n the Open Cybersecurity Schema Framework (OCSF).

\n

Other Amazon Web Services services and third-party services can subscribe to the data that's stored in Security Lake for \n incident response and security data analytics.

", "smithy.api#title": "Amazon Security Lake", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3914,7 +3914,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The configurations for SQS subscriber notification.

" + "smithy.api#documentation": "

The configurations used for EventBridge subscriber notification.

" } }, "com.amazonaws.securitylake#Subscriber": { @@ -4001,7 +4001,7 @@ "sources": { "target": "com.amazonaws.securitylake#LogSourceResourceList", "traits": { - "smithy.api#documentation": "

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.

", + "smithy.api#documentation": "

Amazon Security Lake supports log and event collection for natively supported Amazon Web Services services. For more information, see the Amazon Security Lake User Guide.

", "smithy.api#required": {} } }, @@ -4421,7 +4421,7 @@ "lambda:CreateFunction", "lambda:CreateEventSourceMapping" ], - "smithy.api#documentation": "

Specifies where to store your security data and for how long. You can add a rollup\n Region to consolidate data from multiple Amazon Web Services Regions.

", + "smithy.api#documentation": "

You can use UpdateDataLake to specify where to store your security data, how it should\n be encrypted at rest and for how long. You can add a Rollup\n Region to consolidate data from multiple Amazon Web Services Regions, replace\n default encryption (SSE-S3) with Customer Manged Key,\n or specify transition and expiration actions through storage Lifecycle management. The UpdateDataLake API works as an \"upsert\" operation that performs an insert if the specified item or record does not exist, or an update if it\n already exists. Security Lake securely stores your data at rest using Amazon Web Services encryption solutions. For more details, see Data protection in Amazon Security Lake.

\n

For example, omitting the key encryptionConfiguration from a Region that is\n included in an update call that currently uses KMS will leave that Region's KMS key in\n place, but specifying encryptionConfiguration: {kmsKeyId: 'S3_MANAGED_KEY'}\n for that same Region will reset the key to S3-managed.

\n

For more details about lifecycle management and how to update retention settings for one or more Regions after enabling Security Lake, see the Amazon Security Lake User Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/datalake", @@ -4489,7 +4489,7 @@ "exceptionTimeToLive": { "target": "smithy.api#Long", "traits": { - "smithy.api#documentation": "

The time-to-live (TTL) for the exception message to remain.

", + "smithy.api#documentation": "

The time-to-live (TTL) for the exception message to remain. It is the duration of time until which the exception message remains.

", "smithy.api#range": { "min": 1 } @@ -4513,7 +4513,7 @@ "configurations": { "target": "com.amazonaws.securitylake#DataLakeConfigurationList", "traits": { - "smithy.api#documentation": "

Specify the Region or Regions that will contribute data to the rollup region.

", + "smithy.api#documentation": "

Specifies the Region or Regions that will contribute data to the rollup region.

", "smithy.api#required": {} } }, @@ -4710,7 +4710,7 @@ "subscriberIdentity": { "target": "com.amazonaws.securitylake#AwsIdentity", "traits": { - "smithy.api#documentation": "

The AWS identity used to access your data.

" + "smithy.api#documentation": "

The Amazon Web Services identity used to access your data.

" } }, "subscriberName": { @@ -4731,7 +4731,7 @@ "sources": { "target": "com.amazonaws.securitylake#LogSourceResourceList", "traits": { - "smithy.api#documentation": "

The supported Amazon Web Services from which logs and events are collected. For\n the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

" + "smithy.api#documentation": "

The supported Amazon Web Services services from which logs and events are collected. For\n the list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.

" } } }, diff --git a/codegen/sdk/aws-models/sesv2.json b/codegen/sdk/aws-models/sesv2.json index 98594547b26..dcffa149ffb 100644 --- a/codegen/sdk/aws-models/sesv2.json +++ b/codegen/sdk/aws-models/sesv2.json @@ -2820,6 +2820,12 @@ "traits": { "smithy.api#documentation": "

The name of the dedicated IP pool to associate with the configuration set.

" } + }, + "MaxDeliverySeconds": { + "target": "com.amazonaws.sesv2#MaxDeliverySeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email.\n If specified, the value must greater than or equal to 300 seconds (5 minutes)\n and less than or equal to 50400 seconds (840 minutes).\n

" + } } }, "traits": { @@ -5696,6 +5702,32 @@ "smithy.api#documentation": "

An object containing additional settings for your VDM configuration as applicable to\n the Guardian.

" } }, + "com.amazonaws.sesv2#HttpsPolicy": { + "type": "enum", + "members": { + "REQUIRE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRE" + } + }, + "REQUIRE_OPEN_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REQUIRE_OPEN_ONLY" + } + }, + "OPTIONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPTIONAL" + } + } + }, + "traits": { + "smithy.api#documentation": "

The https policy to use for tracking open and click events. If the value is OPTIONAL or HttpsPolicy is not\n specified, the open trackers use HTTP and click tracker use the original protocol of the link.\n If the value is REQUIRE, both open and click tracker uses HTTPS and if the value is REQUIRE_OPEN_ONLY\n open tracker uses HTTPS and link tracker is same as original protocol of the link.\n

" + } + }, "com.amazonaws.sesv2#Identity": { "type": "string", "traits": { @@ -7472,6 +7504,15 @@ "smithy.api#default": 0 } }, + "com.amazonaws.sesv2#MaxDeliverySeconds": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 300, + "max": 50400 + } + } + }, "com.amazonaws.sesv2#MaxItems": { "type": "integer" }, @@ -8455,6 +8496,12 @@ "traits": { "smithy.api#documentation": "

The name of the dedicated IP pool to associate with the configuration set.

" } + }, + "MaxDeliverySeconds": { + "target": "com.amazonaws.sesv2#MaxDeliverySeconds", + "traits": { + "smithy.api#documentation": "

The maximum amount of time, in seconds, that Amazon SES API v2 will attempt delivery of email.\n If specified, the value must greater than or equal to 300 seconds (5 minutes)\n and less than or equal to 50400 seconds (840 minutes).\n

" + } } }, "traits": { @@ -8693,6 +8740,9 @@ "traits": { "smithy.api#documentation": "

The domain to use to track open and click events.

" } + }, + "HttpsPolicy": { + "target": "com.amazonaws.sesv2#HttpsPolicy" } }, "traits": { @@ -11953,6 +12003,12 @@ "smithy.api#documentation": "

The domain to use for tracking open and click events.

", "smithy.api#required": {} } + }, + "HttpsPolicy": { + "target": "com.amazonaws.sesv2#HttpsPolicy", + "traits": { + "smithy.api#documentation": "

The https policy to use for tracking open and click events.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/socialmessaging.json b/codegen/sdk/aws-models/socialmessaging.json new file mode 100644 index 00000000000..ea5d80e8f27 --- /dev/null +++ b/codegen/sdk/aws-models/socialmessaging.json @@ -0,0 +1,2689 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.socialmessaging#AccessDeniedByMetaException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.socialmessaging#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.socialmessaging#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:.*$" + } + }, + "com.amazonaws.socialmessaging#AssociateInProgressToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccountInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccountOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#DependencyException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:ResourceTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/whatsapp/signup", + "code": 200 + } + } + }, + "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccountInput": { + "type": "structure", + "members": { + "signupCallback": { + "target": "com.amazonaws.socialmessaging#WhatsAppSignupCallback", + "traits": { + "smithy.api#documentation": "

Contains the callback access token.

" + } + }, + "setupFinalization": { + "target": "com.amazonaws.socialmessaging#WhatsAppSetupFinalization", + "traits": { + "smithy.api#documentation": "

A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccountOutput": { + "type": "structure", + "members": { + "signupCallbackResult": { + "target": "com.amazonaws.socialmessaging#WhatsAppSignupCallbackResult", + "traits": { + "smithy.api#documentation": "

Contains your WhatsApp registration status.

" + } + }, + "statusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The status code for the response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMedia": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" + }, + { + "target": "com.amazonaws.socialmessaging#DependencyException" + }, + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/whatsapp/media", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaInput": { + "type": "structure", + "members": { + "mediaId": { + "target": "com.amazonaws.socialmessaging#WhatsAppMediaId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.

", + "smithy.api#httpQuery": "mediaId", + "smithy.api#required": {} + } + }, + "originationPhoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the originating phone number associated with the media. Phone\n number identifiers are formatted as\n phone-number-id-01234567890123456789012345678901. Use\n GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.

", + "smithy.api#httpQuery": "originationPhoneNumberId", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMediaOutput": { + "type": "structure", + "members": { + "success": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Success indicator for deleting the media file.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#DependencyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

Thrown when performing an action because a dependency would be broken.

", + "smithy.api#error": "server", + "smithy.api#httpError": 502, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#DependencyException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/v1/whatsapp/waba/disassociate", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountInput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as\n waba-01234567890123456789012345678901. Use\n ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "WabaId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccountOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.socialmessaging#EventDestinationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:.*:[a-z-]+([/:](.*))?$" + } + }, + "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#DependencyException" + }, + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the details of your linked WhatsApp Business Account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/whatsapp/waba/details", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountInput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier, from Amazon Web Services, of the linked WhatsApp Business\n Account. WABA identifiers are formatted as\n waba-01234567890123456789012345678901. Use\n ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "WabaId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountOutput": { + "type": "structure", + "members": { + "account": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccount", + "traits": { + "smithy.api#documentation": "

The details of the linked WhatsApp Business Account.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumber": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#DependencyException" + }, + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Use your WhatsApp phone number id to get the WABA account id and phone number\n details.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/whatsapp/waba/phone/details", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberInput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the phone number. Phone number\n identifiers are formatted as phone-number-id-01234567890123456789012345678901.\n Use GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.

", + "smithy.api#httpQuery": "id", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumberOutput": { + "type": "structure", + "members": { + "phoneNumber": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetail" + }, + "linkedWhatsAppBusinessAccountId": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The WABA identifier linked to the phone number, formatted as\n waba-01234567890123456789012345678901.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#GetWhatsAppMessageMedia": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageMediaInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageMediaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" + }, + { + "target": "com.amazonaws.socialmessaging#DependencyException" + }, + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a media file from the WhatsApp service. On successful completion the media file is\n retrieved from Meta and stored in the specified Amazon S3 bucket. Use either\n destinationS3File or destinationS3PresignedUrl for the\n destination. If both are used then an InvalidParameterException is\n returned.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/whatsapp/media/get", + "code": 200 + } + } + }, + "com.amazonaws.socialmessaging#GetWhatsAppMessageMediaInput": { + "type": "structure", + "members": { + "mediaId": { + "target": "com.amazonaws.socialmessaging#WhatsAppMediaId", + "traits": { + "smithy.api#documentation": "

The unique identifier for the media file.

", + "smithy.api#required": {} + } + }, + "originationPhoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the originating phone number for the WhatsApp message media.\n The phone number identifiers are formatted as\n phone-number-id-01234567890123456789012345678901. Use\n GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" + } + }, + "metadataOnly": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Set to True to get only the metadata for the file.

" + } + }, + "destinationS3PresignedUrl": { + "target": "com.amazonaws.socialmessaging#S3PresignedUrl", + "traits": { + "smithy.api#documentation": "

The presign url of the media file.

" + } + }, + "destinationS3File": { + "target": "com.amazonaws.socialmessaging#S3File", + "traits": { + "smithy.api#documentation": "

The bucketName and key of the S3 media file.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#GetWhatsAppMessageMediaOutput": { + "type": "structure", + "members": { + "mimeType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The MIME type of the media.

" + } + }, + "fileSize": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The file size of the media, in KB.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#Headers": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.socialmessaging#InternalServiceException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or\n failure.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.socialmessaging#InvalidParametersException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

One or more parameters provided to the action are not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.socialmessaging#IsoCountryCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Z]{2}$" + } + }, + "com.amazonaws.socialmessaging#LinkedAccountWithIncompleteSetup": { + "type": "map", + "key": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId" + }, + "value": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountIdMetaData" + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccount": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountArn", + "traits": { + "smithy.api#documentation": "

The ARN of the linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

", + "smithy.api#required": {} + } + }, + "wabaId": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The WhatsApp Business Account ID from meta.

", + "smithy.api#required": {} + } + }, + "registrationStatus": { + "target": "com.amazonaws.socialmessaging#RegistrationStatus", + "traits": { + "smithy.api#documentation": "

The registration status of the linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "linkDate": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountLinkDate", + "traits": { + "smithy.api#documentation": "

The date the WhatsApp Business Account was linked.

", + "smithy.api#required": {} + } + }, + "wabaName": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", + "traits": { + "smithy.api#documentation": "

The name of the linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "eventDestinations": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations", + "traits": { + "smithy.api#documentation": "

The event destinations for the linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "phoneNumbers": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummaryList", + "traits": { + "smithy.api#documentation": "

The phone numbers associated with the Linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of your linked WhatsApp Business Account.

" + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:.*:waba/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$)" + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountIdMetaData": { + "type": "structure", + "members": { + "accountName": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", + "traits": { + "smithy.api#documentation": "

The name of your account.

" + } + }, + "registrationStatus": { + "target": "com.amazonaws.socialmessaging#RegistrationStatus", + "traits": { + "smithy.api#documentation": "

The registration status of the linked WhatsApp Business Account.

" + } + }, + "unregisteredWhatsAppPhoneNumbers": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetailList", + "traits": { + "smithy.api#documentation": "

The details for unregistered WhatsApp phone numbers.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains your WhatsApp registration status and details of any unregistered WhatsApp\n phone number.

" + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountResource": { + "type": "resource", + "identifiers": { + "WabaId": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId" + } + }, + "create": { + "target": "com.amazonaws.socialmessaging#AssociateWhatsAppBusinessAccount" + }, + "read": { + "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccount" + }, + "delete": { + "target": "com.amazonaws.socialmessaging#DisassociateWhatsAppBusinessAccount" + }, + "list": { + "target": "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccounts" + }, + "operations": [ + { + "target": "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinations" + } + ], + "traits": { + "aws.api#arn": { + "template": "waba/{WabaId}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "name": "waba", + "relativeDocumentation": "managing-wabas.html" + } + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountArn", + "traits": { + "smithy.api#documentation": "

The ARN of the linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

", + "smithy.api#required": {} + } + }, + "wabaId": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The WhatsApp Business Account ID provided by Meta.

", + "smithy.api#required": {} + } + }, + "registrationStatus": { + "target": "com.amazonaws.socialmessaging#RegistrationStatus", + "traits": { + "smithy.api#documentation": "

The registration status of the linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "linkDate": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountLinkDate", + "traits": { + "smithy.api#documentation": "

The date the WhatsApp Business Account was linked.

", + "smithy.api#required": {} + } + }, + "wabaName": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName", + "traits": { + "smithy.api#documentation": "

The name of the linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "eventDestinations": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations", + "traits": { + "smithy.api#documentation": "

The event destinations for the linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a linked WhatsApp Business Account.

" + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummary" + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:.*:phone-number-id/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource": { + "type": "resource", + "identifiers": { + "OriginationPhoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId" + } + }, + "read": { + "target": "com.amazonaws.socialmessaging#GetLinkedWhatsAppBusinessAccountPhoneNumber" + }, + "operations": [ + { + "target": "com.amazonaws.socialmessaging#DeleteWhatsAppMessageMedia" + }, + { + "target": "com.amazonaws.socialmessaging#GetWhatsAppMessageMedia" + }, + { + "target": "com.amazonaws.socialmessaging#PostWhatsAppMessageMedia" + }, + { + "target": "com.amazonaws.socialmessaging#SendWhatsAppMessage" + } + ], + "traits": { + "aws.api#arn": { + "template": "phone-number-id/{OriginationPhoneNumberId}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], + "aws.iam#iamResource": { + "name": "phone-number-id", + "relativeDocumentation": "managing-phone-numbers.html" + } + } + }, + "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccountsInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccountsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/whatsapp/waba/list", + "code": 200 + }, + "smithy.api#paginated": { + "items": "linkedAccounts" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccountsInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.socialmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The next token for pagination.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.socialmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#ListLinkedWhatsAppBusinessAccountsOutput": { + "type": "structure", + "members": { + "linkedAccounts": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountSummaryList", + "traits": { + "smithy.api#documentation": "

A list of WhatsApp Business Accounts linked to your Amazon Web Services account.

" + } + }, + "nextToken": { + "target": "com.amazonaws.socialmessaging#NextToken", + "traits": { + "smithy.api#documentation": "

The next token for pagination.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

List all tags associated with a resource, such as a phone number or WABA.

", + "smithy.api#http": { + "method": "GET", + "uri": "/v1/tags/list", + "code": 200 + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "ListTagsFailure", + "params": { + "resourceArn": "arn:aws:social-messaging:us-east-1:9923825:phone-number-id/45c1973a7577" + }, + "expect": { + "failure": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.socialmessaging#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.socialmessaging#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to retrieve the tags from.

", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The status code of the response.

" + } + }, + "tags": { + "target": "com.amazonaws.socialmessaging#TagList", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.socialmessaging#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 600 + } + } + }, + "com.amazonaws.socialmessaging#PhoneNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.socialmessaging#PostWhatsAppMessageMedia": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#PostWhatsAppMessageMediaInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#PostWhatsAppMessageMediaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#AccessDeniedByMetaException" + }, + { + "target": "com.amazonaws.socialmessaging#DependencyException" + }, + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Upload a media file to the WhatsApp service. Only the specified\n originationPhoneNumberId has the permissions to send the media file when\n using SendWhatsAppMessage. You must use either sourceS3File\n or sourceS3PresignedUrl for the source. If both or neither are specified then an\n InvalidParameterException is returned.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/whatsapp/media", + "code": 200 + } + } + }, + "com.amazonaws.socialmessaging#PostWhatsAppMessageMediaInput": { + "type": "structure", + "members": { + "originationPhoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "traits": { + "smithy.api#documentation": "

The ID of the phone number to associate with the WhatsApp media file. The phone number\n identifiers are formatted as phone-number-id-01234567890123456789012345678901.\n Use GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" + } + }, + "sourceS3PresignedUrl": { + "target": "com.amazonaws.socialmessaging#S3PresignedUrl", + "traits": { + "smithy.api#documentation": "

The source presign url of the media file.

" + } + }, + "sourceS3File": { + "target": "com.amazonaws.socialmessaging#S3File", + "traits": { + "smithy.api#documentation": "

The source S3 url for the media file.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#PostWhatsAppMessageMediaOutput": { + "type": "structure", + "members": { + "mediaId": { + "target": "com.amazonaws.socialmessaging#WhatsAppMediaId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the posted WhatsApp message.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinationsInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/whatsapp/waba/eventdestinations", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinationsInput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as\n waba-01234567890123456789012345678901. Use\n ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "WabaId" + } + }, + "eventDestinations": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations", + "traits": { + "smithy.api#documentation": "

An array of WhatsAppBusinessAccountEventDestination event destinations.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#PutWhatsAppBusinessAccountEventDestinationsOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#RegistrationStatus": { + "type": "enum", + "members": { + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "INCOMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCOMPLETE" + } + } + } + }, + "com.amazonaws.socialmessaging#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.socialmessaging#S3File": { + "type": "structure", + "members": { + "bucketName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The bucket name.

", + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][a-z0-9.-]*[a-z0-9]$", + "smithy.api#required": {} + } + }, + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The object key of the media file.

", + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information for the S3 bucket that contains media files.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.socialmessaging#S3PresignedUrl": { + "type": "structure", + "members": { + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The presign url to the object.

", + "smithy.api#length": { + "min": 1, + "max": 2000 + }, + "smithy.api#pattern": "^https://(.*)s3(.*).amazonaws.com/(.*)$", + "smithy.api#required": {} + } + }, + "headers": { + "target": "com.amazonaws.socialmessaging#Headers", + "traits": { + "smithy.api#documentation": "

A map of headers and their values. You must specify the Content-Type header when using PostWhatsAppMessageMedia. For a list of common headers, see Common Request Headers in the Amazon S3\n API Reference\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You can use presigned URLs to grant time-limited access to objects in Amazon S3 without updating your bucket policy. For more information, see Working with presigned URLs in the Amazon S3\n User Guide.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.socialmessaging#SendWhatsAppMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#SendWhatsAppMessageInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#SendWhatsAppMessageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#DependencyException" + }, + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Send a WhatsApp message. For examples of sending a message using the Amazon Web Services\n CLI, see Sending messages in the\n \n Amazon Web Services End User Messaging Social User Guide\n .

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/whatsapp/send", + "code": 200 + } + } + }, + "com.amazonaws.socialmessaging#SendWhatsAppMessageInput": { + "type": "structure", + "members": { + "originationPhoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "traits": { + "smithy.api#documentation": "

The ID of the phone number used to send the WhatsApp message. If you are sending a media\n file only the originationPhoneNumberId used to upload the file can be used.\n Phone number identifiers are formatted as\n phone-number-id-01234567890123456789012345678901. Use\n GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "OriginationPhoneNumberId" + } + }, + "message": { + "target": "com.amazonaws.socialmessaging#WhatsAppMessageBlob", + "traits": { + "smithy.api#documentation": "

The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp\n Message object, see Messages in the WhatsApp Business Platform Cloud API\n Reference.

", + "smithy.api#required": {} + } + }, + "metaApiVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see \n Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.socialmessaging#SendWhatsAppMessageOutput": { + "type": "structure", + "members": { + "messageId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the message.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#SocialMessaging": { + "type": "service", + "version": "2024-01-01", + "operations": [ + { + "target": "com.amazonaws.socialmessaging#ListTagsForResource" + }, + { + "target": "com.amazonaws.socialmessaging#TagResource" + }, + { + "target": "com.amazonaws.socialmessaging#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountResource" + }, + { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource" + } + ], + "errors": [ + { + "target": "com.amazonaws.socialmessaging#AccessDeniedException" + }, + { + "target": "com.amazonaws.socialmessaging#ValidationException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SocialMessaging", + "arnNamespace": "social-messaging", + "cloudTrailEventSource": "social-messaging.amazonaws.com", + "endpointPrefix": "social-messaging" + }, + "aws.auth#sigv4": { + "name": "social-messaging" + }, + "aws.iam#defineConditionKeys": { + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags associated with the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the tag keys that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "origin": "*", + "additionalAllowedHeaders": [ + "authorization", + "x-amz-date", + "x-amz-security-token", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id", + "content-length", + "x-api-key", + "amz-sdk-request", + "amz-sdk-invocation-id", + "Csrf-Token" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id", + "Csrf-Token" + ] + }, + "smithy.api#documentation": "

\n Amazon Web Services End User Messaging Social, also referred to as Social messaging, is a messaging service that enables\n application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the\n Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.

\n

The Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.

\n

If you're new to the Amazon Web Services End User Messaging Social API, it's also helpful to review What is\n Amazon Web Services End User Messaging Social in the Amazon Web Services End User Messaging Social User Guide. The\n Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use\n Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications.\n The guide also provides key information, such as integration with other Amazon Web Services\n services, and the quotas that apply to use of the service.

\n

\n Regional availability\n

\n

The Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated endpoint for each of these Regions. For a list of\n all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Web Services End User Messaging endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see\n Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.

\n

In each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These Availability\n Zones enable us to provide very high levels of availability and redundancy, while also\n minimizing latency. To learn more about the number of Availability Zones that are available\n in each Region, see Amazon Web Services Global Infrastructure.\n

", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#title": "AWS End User Messaging Social", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://social-messaging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://social-messaging-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://social-messaging.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://social-messaging.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://social-messaging-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://social-messaging.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://social-messaging-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://social-messaging.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://social-messaging-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://social-messaging.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://social-messaging.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.socialmessaging#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.socialmessaging#Tag": { + "type": "structure", + "members": { + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The tag key.

", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The tag value.

", + "smithy.api#length": { + "max": 256 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The tag for a resource.

" + } + }, + "com.amazonaws.socialmessaging#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#Tag" + } + }, + "com.amazonaws.socialmessaging#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:RequestTag/${TagKey}", + "aws:ResourceTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Adds or overwrites only the specified tags for the specified resource. When you specify\n an existing tag key, the value is overwritten with the new value.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/tags/tag-resource", + "code": 200 + } + } + }, + "com.amazonaws.socialmessaging#TagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.socialmessaging#Arn", + "traits": { + "aws.api#data": "tagging", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to tag.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.socialmessaging#TagList", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource", + "ids": { + "OriginationPhoneNumberId": "resourceArn" + } + }, + { + "resource": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountResource", + "ids": { + "WabaId": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.socialmessaging#TagResourceOutput": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The status code of the tag resource operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#ThrottledRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.socialmessaging#TwoFactorPin": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.socialmessaging#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.socialmessaging#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.socialmessaging#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.socialmessaging#InternalServiceException" + }, + { + "target": "com.amazonaws.socialmessaging#InvalidParametersException" + }, + { + "target": "com.amazonaws.socialmessaging#ThrottledRequestException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "

Removes the specified tags from a resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/tags/untag-resource", + "code": 200 + } + } + }, + "com.amazonaws.socialmessaging#UntagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.socialmessaging#Arn", + "traits": { + "aws.api#data": "tagging", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to remove tags from.

", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.socialmessaging#StringList", + "traits": { + "smithy.api#documentation": "

The keys of the tags to remove from the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberResource", + "ids": { + "OriginationPhoneNumberId": "resourceArn" + } + }, + { + "resource": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountResource", + "ids": { + "WabaId": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.socialmessaging#UntagResourceOutput": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The status code of the untag resource operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.socialmessaging#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.socialmessaging#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The request contains an invalid parameter value.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.socialmessaging#WabaPhoneNumberSetupFinalization": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumber", + "traits": { + "smithy.api#documentation": "

The unique identifier of the originating phone number associated with the media. Phone\n number identifiers are formatted as\n phone-number-id-01234567890123456789012345678901. Use\n GetLinkedWhatsAppBusinessAccount to find a phone number's\n id.

", + "smithy.api#required": {} + } + }, + "twoFactorPin": { + "target": "com.amazonaws.socialmessaging#TwoFactorPin", + "traits": { + "smithy.api#documentation": "

The PIN to use for two-step verification. To reset your PIN follow the directions in\n Updating PIN in the WhatsApp Business Platform Cloud API\n Reference.

", + "smithy.api#required": {} + } + }, + "dataLocalizationRegion": { + "target": "com.amazonaws.socialmessaging#IsoCountryCode", + "traits": { + "smithy.api#documentation": "

The two letter ISO region for the location of where Meta will store data.

\n

\n Asia–Pacific (APAC)\n

\n
    \n
  • \n

    Australia AU\n

    \n
    • \n
  • \n

    Indonesia ID\n

    \n
    • \n
  • \n

    India IN\n

    \n
    • \n
  • \n

    Japan JP\n

    \n
    • \n
  • \n

    Singapore SG\n

    \n
    • \n
  • \n

    South Korea KR\n

    \n
    • \n
\n

\n Europe\n

\n
    \n
  • \n

    Germany DE\n

    \n
    • \n
  • \n

    Switzerland CH\n

    \n
    • \n
  • \n

    United Kingdom GB\n

    \n
    • \n
\n

\n Latin America (LATAM)\n

\n
    \n
  • \n

    Brazil BR\n

    \n
    • \n
\n

\n Middle East and Africa (MEA)\n

\n
    \n
  • \n

    Bahrain BH\n

    \n
    • \n
  • \n

    South Africa ZA\n

    \n
    • \n
  • \n

    United Arab Emirates AE\n

    \n
    • \n
\n

\n North America (NORAM)\n

\n
    \n
  • \n

    Canada CA\n

    \n
    • \n
" + } + }, + "tags": { + "target": "com.amazonaws.socialmessaging#TagList", + "traits": { + "smithy.api#documentation": "

An array of key and value pair tags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The registration details for a linked phone number.

" + } + }, + "com.amazonaws.socialmessaging#WabaPhoneNumberSetupFinalizationList": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#WabaPhoneNumberSetupFinalization" + } + }, + "com.amazonaws.socialmessaging#WabaSetupFinalization": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

" + } + }, + "eventDestinations": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations", + "traits": { + "smithy.api#documentation": "

The event destinations for the linked WhatsApp Business Account.

" + } + }, + "tags": { + "target": "com.amazonaws.socialmessaging#TagList", + "traits": { + "smithy.api#documentation": "

An array of key and value pair tags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The registration details for a linked WhatsApp Business Account.

" + } + }, + "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestination": { + "type": "structure", + "members": { + "eventDestinationArn": { + "target": "com.amazonaws.socialmessaging#EventDestinationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the event destination.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on the event destination.

" + } + }, + "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestinations": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#WhatsAppBusinessAccountEventDestination" + }, + "traits": { + "smithy.api#length": { + "max": 1 + } + } + }, + "com.amazonaws.socialmessaging#WhatsAppBusinessAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.socialmessaging#WhatsAppBusinessAccountLinkDate": { + "type": "timestamp" + }, + "com.amazonaws.socialmessaging#WhatsAppBusinessAccountName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + } + } + }, + "com.amazonaws.socialmessaging#WhatsAppDisplayPhoneNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 20 + } + } + }, + "com.amazonaws.socialmessaging#WhatsAppMediaId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.socialmessaging#WhatsAppMessageBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.socialmessaging#WhatsAppPhoneNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetail": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberArn", + "traits": { + "smithy.api#documentation": "

The ARN of the WhatsApp phone number.

", + "smithy.api#required": {} + } + }, + "phoneNumber": { + "target": "com.amazonaws.socialmessaging#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number for sending WhatsApp.

", + "smithy.api#required": {} + } + }, + "phoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "traits": { + "smithy.api#documentation": "

The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.

", + "smithy.api#required": {} + } + }, + "metaPhoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number ID from Meta.

", + "smithy.api#required": {} + } + }, + "displayPhoneNumberName": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberName", + "traits": { + "smithy.api#documentation": "

The display name for this phone number.

", + "smithy.api#required": {} + } + }, + "displayPhoneNumber": { + "target": "com.amazonaws.socialmessaging#WhatsAppDisplayPhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number that appears in the recipients display.

", + "smithy.api#required": {} + } + }, + "qualityRating": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberQualityRating", + "traits": { + "smithy.api#documentation": "

The quality rating of the phone number.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of your WhatsApp phone number.

" + } + }, + "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberDetail" + } + }, + "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "(^phone-number-id-.*$)|(^arn:.*:phone-number-id/[0-9a-zA-Z]+$)" + } + }, + "com.amazonaws.socialmessaging#WhatsAppPhoneNumberName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 200 + } + } + }, + "com.amazonaws.socialmessaging#WhatsAppPhoneNumberQualityRating": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppPhoneNumberArn", + "traits": { + "smithy.api#documentation": "

The full Amazon Resource Name (ARN) for the phone number.

", + "smithy.api#required": {} + } + }, + "phoneNumber": { + "target": "com.amazonaws.socialmessaging#PhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number associated with the Linked WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "phoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberId", + "traits": { + "smithy.api#documentation": "

The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.

", + "smithy.api#required": {} + } + }, + "metaPhoneNumberId": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number ID from Meta.

", + "smithy.api#required": {} + } + }, + "displayPhoneNumberName": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberName", + "traits": { + "smithy.api#documentation": "

The display name for this phone number.

", + "smithy.api#required": {} + } + }, + "displayPhoneNumber": { + "target": "com.amazonaws.socialmessaging#WhatsAppDisplayPhoneNumber", + "traits": { + "smithy.api#documentation": "

The phone number that appears in the recipients display.

", + "smithy.api#required": {} + } + }, + "qualityRating": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberQualityRating", + "traits": { + "smithy.api#documentation": "

The quality rating of the phone number. This is from Meta.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of a linked phone number.

" + } + }, + "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.socialmessaging#WhatsAppPhoneNumberSummary" + } + }, + "com.amazonaws.socialmessaging#WhatsAppSetupFinalization": { + "type": "structure", + "members": { + "associateInProgressToken": { + "target": "com.amazonaws.socialmessaging#AssociateInProgressToken", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.

", + "smithy.api#required": {} + } + }, + "phoneNumbers": { + "target": "com.amazonaws.socialmessaging#WabaPhoneNumberSetupFinalizationList", + "traits": { + "smithy.api#documentation": "

An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.

", + "smithy.api#required": {} + } + }, + "phoneNumberParent": { + "target": "com.amazonaws.socialmessaging#LinkedWhatsAppBusinessAccountId", + "traits": { + "smithy.api#documentation": "

Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the waba field is present.

" + } + }, + "waba": { + "target": "com.amazonaws.socialmessaging#WabaSetupFinalization", + "traits": { + "smithy.api#documentation": "

Used to create a new WhatsApp Business Account and add a phone number. This field can't be used when the phoneNumberParent field is present.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of linking a WhatsApp Business Account to your Amazon Web Services account.

" + } + }, + "com.amazonaws.socialmessaging#WhatsAppSignupCallback": { + "type": "structure", + "members": { + "accessToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The access token for your WhatsApp Business Account. The accessToken value is provided by Meta.

", + "smithy.api#length": { + "max": 1000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the accessToken provided by Meta during signup.

" + } + }, + "com.amazonaws.socialmessaging#WhatsAppSignupCallbackResult": { + "type": "structure", + "members": { + "associateInProgressToken": { + "target": "com.amazonaws.socialmessaging#AssociateInProgressToken", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.

" + } + }, + "linkedAccountsWithIncompleteSetup": { + "target": "com.amazonaws.socialmessaging#LinkedAccountWithIncompleteSetup", + "traits": { + "smithy.api#documentation": "

A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the results of WhatsAppSignupCallback.

" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/supplychain.json b/codegen/sdk/aws-models/supplychain.json index bc17b51f2b4..966ea7a2c2e 100644 --- a/codegen/sdk/aws-models/supplychain.json +++ b/codegen/sdk/aws-models/supplychain.json @@ -14,6 +14,22 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.supplychain#AscResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws:scn(?::([a-z0-9-]+):([0-9]+):instance)?/([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})[-_./A-Za-z0-9]*$" + } + }, + "com.amazonaws.supplychain#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, "com.amazonaws.supplychain#BillOfMaterialsImportJob": { "type": "structure", "members": { @@ -233,7 +249,7 @@ "clientToken": { "target": "com.amazonaws.supplychain#ClientToken", "traits": { - "smithy.api#documentation": "

An idempotency token.

", + "smithy.api#documentation": "

An idempotency token ensures the API request is only completed no more than once. This way, retrying the request will not trigger the operation multiple times. A client token is a unique, case-sensitive string of 33 to 128 ASCII characters. To make an idempotent API request, specify a client token in the request. You should not reuse the same client token for other requests. If you retry a successful request with the same client token, the request will succeed with no further actions being taken, and you will receive the same API response as the original successful request.

", "smithy.api#idempotencyToken": {} } } @@ -259,164 +275,208 @@ "smithy.api#output": {} } }, - "com.amazonaws.supplychain#DataIntegrationEventData": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1048576 + "com.amazonaws.supplychain#CreateDataIntegrationFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#CreateDataIntegrationFlowRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#CreateDataIntegrationFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.supplychain#DataIntegrationEventGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.supplychain#DataIntegrationEventResource": { - "type": "resource", - "identifiers": { - "instanceId": { - "target": "com.amazonaws.supplychain#UUID" + { + "target": "com.amazonaws.supplychain#ConflictException" }, - "eventId": { - "target": "com.amazonaws.supplychain#UUID" - } - }, - "properties": { - "eventType": { - "target": "com.amazonaws.supplychain#DataIntegrationEventType" + { + "target": "com.amazonaws.supplychain#InternalServerException" }, - "data": { - "target": "com.amazonaws.supplychain#DataIntegrationEventData" + { + "target": "com.amazonaws.supplychain#ServiceQuotaExceededException" }, - "eventGroupId": { - "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId" + { + "target": "com.amazonaws.supplychain#ThrottlingException" }, - "eventTimestamp": { - "target": "smithy.api#Timestamp" + { + "target": "com.amazonaws.supplychain#ValidationException" } - }, - "create": { - "target": "com.amazonaws.supplychain#SendDataIntegrationEvent" - }, + ], "traits": { - "aws.api#arn": { - "template": "instance/{instanceId}/data-integration-events/{eventId}" - } + "smithy.api#documentation": "

Create DataIntegrationFlow to map one or more different sources to one target using the SQL transformation query.

", + "smithy.api#examples": [ + { + "title": "Successful CreateDataIntegrationFlow for s3 to dataset flow", + "input": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow", + "sources": [ + { + "sourceType": "S3", + "sourceName": "testSourceName", + "s3Source": { + "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f", + "prefix": "example-prefix" + } + } + ], + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT * FROM testSourceName" + } + }, + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset" + } + }, + "tags": { + "tagKey1": "tagValue1" + } + }, + "output": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow" + } + }, + { + "title": "Successful CreateDataIntegrationFlow for dataset to dataset flow", + "input": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "trading-partner", + "sources": [ + { + "sourceType": "DATASET", + "sourceName": "testSourceName1", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1" + } + }, + { + "sourceType": "DATASET", + "sourceName": "testSourceName2", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2" + } + } + ], + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT S1.id AS id, S1.poc_org_unit_description AS description, S1.company_id AS company_id, S1.tpartner_type AS tpartner_type, S1.geo_id AS geo_id, S1.eff_start_date AS eff_start_date, S1.eff_end_date AS eff_end_date FROM testSourceName1 AS S1 LEFT JOIN testSourceName2 as S2 ON S1.id=S2.id" + } + }, + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + } + }, + "tags": { + "tagKey1": "tagValue1" + } + }, + "output": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "trading-partner" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/api/data-integration/instance/{instanceId}/data-integration-flows/{name}" + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.supplychain#DataIntegrationEventType": { - "type": "enum", + "com.amazonaws.supplychain#CreateDataIntegrationFlowRequest": { + "type": "structure", "members": { - "FORECAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scn.data.forecast" - } - }, - "INVENTORY_LEVEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scn.data.inventorylevel" - } - }, - "INBOUND_ORDER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scn.data.inboundorder" - } - }, - "INBOUND_ORDER_LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scn.data.inboundorderline" - } - }, - "INBOUND_ORDER_LINE_SCHEDULE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scn.data.inboundorderlineschedule" - } - }, - "OUTBOUND_ORDER_LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scn.data.outboundorderline" - } - }, - "OUTBOUND_SHIPMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scn.data.outboundshipment" - } - }, - "PROCESS_HEADER": { - "target": "smithy.api#Unit", + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", "traits": { - "smithy.api#enumValue": "scn.data.processheader" + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "PROCESS_OPERATION": { - "target": "smithy.api#Unit", + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", "traits": { - "smithy.api#enumValue": "scn.data.processoperation" + "smithy.api#documentation": "

Name of the DataIntegrationFlow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "PROCESS_PRODUCT": { - "target": "smithy.api#Unit", + "sources": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSourceList", "traits": { - "smithy.api#enumValue": "scn.data.processproduct" + "smithy.api#documentation": "

The source configurations for DataIntegrationFlow.

", + "smithy.api#required": {} } }, - "RESERVATION": { - "target": "smithy.api#Unit", + "transformation": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTransformation", "traits": { - "smithy.api#enumValue": "scn.data.reservation" + "smithy.api#documentation": "

The transformation configurations for DataIntegrationFlow.

", + "smithy.api#required": {} } }, - "SHIPMENT": { - "target": "smithy.api#Unit", + "target": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTarget", "traits": { - "smithy.api#enumValue": "scn.data.shipment" + "smithy.api#documentation": "

The target configurations for DataIntegrationFlow.

", + "smithy.api#required": {} } }, - "SHIPMENT_STOP": { - "target": "smithy.api#Unit", + "tags": { + "target": "com.amazonaws.supplychain#TagMap", "traits": { - "smithy.api#enumValue": "scn.data.shipmentstop" + "smithy.api#documentation": "

The tags of the DataIntegrationFlow to be created

", + "smithy.api#notProperty": {} } - }, - "SHIPMENT_STOP_ORDER": { - "target": "smithy.api#Unit", + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for CreateDataIntegrationFlow.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#CreateDataIntegrationFlowResponse": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", "traits": { - "smithy.api#enumValue": "scn.data.shipmentstoporder" + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#required": {} } }, - "SUPPLY_PLAN": { - "target": "smithy.api#Unit", + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", "traits": { - "smithy.api#enumValue": "scn.data.supplyplan" + "smithy.api#documentation": "

The name of the DataIntegrationFlow created.

", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for CreateDataIntegrationFlow.

", + "smithy.api#output": {} } }, - "com.amazonaws.supplychain#GalaxyPublicAPIGateway": { - "type": "service", - "version": "2024-01-01", - "resources": [ - { - "target": "com.amazonaws.supplychain#BillOfMaterialsImportJobResource" - }, - { - "target": "com.amazonaws.supplychain#DataIntegrationEventResource" - } - ], + "com.amazonaws.supplychain#CreateDataLakeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#CreateDataLakeDatasetRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#CreateDataLakeDatasetResponse" + }, "errors": [ { "target": "com.amazonaws.supplychain#AccessDeniedException" @@ -427,9 +487,6 @@ { "target": "com.amazonaws.supplychain#InternalServerException" }, - { - "target": "com.amazonaws.supplychain#ResourceNotFoundException" - }, { "target": "com.amazonaws.supplychain#ServiceQuotaExceededException" }, @@ -441,148 +498,1932 @@ } ], "traits": { - "aws.api#service": { - "sdkId": "SupplyChain", - "arnNamespace": "scn", - "endpointPrefix": "scn" - }, - "aws.auth#sigv4": { - "name": "scn" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "content-type", - "x-amz-content-sha256", - "x-amz-user-agent", - "x-amzn-platform-id", - "x-amzn-trace-id" - ], - "additionalExposedHeaders": [ - "x-amzn-errortype", - "x-amzn-requestid", - "x-amzn-trace-id" - ], - "maxAge": 86400 - }, - "smithy.api#documentation": "

\n AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply Chain, you can connect and extract your inventory, supply, and demand related data from existing ERP or supply chain systems into a single data model.\n

\n

The AWS Supply Chain API supports configuration data import for Supply Planning.

\n

\n All AWS Supply chain API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies.\n

", - "smithy.api#title": "AWS Supply Chain", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" + "smithy.api#documentation": "

Create a data lake dataset.

", + "smithy.api#examples": [ + { + "title": "Create an AWS Supply Chain inbound order dataset", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order", + "description": "This is an AWS Supply Chain inbound order dataset", + "tags": { + "tagKey1": "tagValue1", + "tagKey2": "tagValue2" + } }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ + "output": { + "dataset": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order", + "description": "This is an AWS Supply Chain inbound order dataset", + "createdTime": 1.727116807751E9, + "lastModifiedTime": 1.727116807751E9, + "schema": { + "name": "InboundOrder", + "fields": [ { - "ref": "Endpoint" + "name": "id", + "type": "STRING", + "isRequired": true + }, + { + "name": "tpartner_id", + "type": "STRING", + "isRequired": true + }, + { + "name": "connection_id", + "type": "STRING", + "isRequired": true + }, + { + "name": "order_type", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_status", + "type": "STRING", + "isRequired": false + }, + { + "name": "inbound_order_url", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_creation_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "company_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "to_site_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_currency_uom", + "type": "STRING", + "isRequired": false + }, + { + "name": "vendor_currency_uom", + "type": "STRING", + "isRequired": false + }, + { + "name": "exchange_rate", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "exchange_rate_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "incoterm", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm2", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm_location_1", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm_location_2", + "type": "STRING", + "isRequired": false + }, + { + "name": "submitted_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "agreement_start_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "agreement_end_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "shipping_instr_code", + "type": "STRING", + "isRequired": false + }, + { + "name": "payment_terms_code", + "type": "STRING", + "isRequired": false + }, + { + "name": "std_terms_agreement", + "type": "STRING", + "isRequired": false + }, + { + "name": "std_terms_agreement_ver", + "type": "STRING", + "isRequired": false + }, + { + "name": "agreement_number", + "type": "STRING", + "isRequired": false + }, + { + "name": "source", + "type": "STRING", + "isRequired": false + }, + { + "name": "source_update_dttm", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "source_event_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "db_creation_dttm", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "db_updation_dttm", + "type": "TIMESTAMP", + "isRequired": false } ] } - ], - "rules": [ - { - "conditions": [ + } + } + }, + { + "title": "Create a custom dataset", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset", + "description": "This is a custom dataset", + "schema": { + "name": "MyDataset", + "fields": [ + { + "name": "id", + "type": "INT", + "isRequired": true + }, + { + "name": "description", + "type": "STRING", + "isRequired": true + }, + { + "name": "price", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "creation_time", + "type": "TIMESTAMP", + "isRequired": false + } + ] + }, + "tags": { + "tagKey1": "tagValue1", + "tagKey2": "tagValue2" + } + }, + "output": { + "dataset": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset", + "description": "This is a custom dataset", + "createdTime": 1.727116807751E9, + "lastModifiedTime": 1.727116807751E9, + "schema": { + "name": "MyDataset", + "fields": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "rules": [ + "name": "id", + "type": "INT", + "isRequired": true + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "name": "description", + "type": "STRING", + "isRequired": true }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "name": "price", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "creation_time", + "type": "TIMESTAMP", + "isRequired": false } - ], - "type": "tree" + ] } - ], - "type": "tree" + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#CreateDataLakeDatasetRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "traits": { + "smithy.api#documentation": "

The name space of the dataset.

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "schema": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchema", + "traits": { + "smithy.api#documentation": "

The custom schema of the data lake dataset and is only required when the name space is default.

" + } + }, + "description": { + "target": "com.amazonaws.supplychain#DataLakeDatasetDescription", + "traits": { + "smithy.api#documentation": "

The description of the dataset.

" + } + }, + "tags": { + "target": "com.amazonaws.supplychain#TagMap", + "traits": { + "smithy.api#documentation": "

The tags of the dataset.

", + "smithy.api#notProperty": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for CreateDataLakeDataset.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#CreateDataLakeDatasetResponse": { + "type": "structure", + "members": { + "dataset": { + "target": "com.amazonaws.supplychain#DataLakeDataset", + "traits": { + "smithy.api#documentation": "

The detail of created dataset.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters of CreateDataLakeDataset.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#CreateInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#CreateInstanceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#CreateInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#ConflictException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a new instance for AWS Supply Chain. This is an asynchronous operation. Upon receiving a CreateInstance request, AWS Supply Chain immediately returns the instance resource, with instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance.

", + "smithy.api#examples": [ + { + "title": "Successful CreateInstance request with all input data", + "input": { + "instanceName": "example instance name", + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "tags": { + "tagKey1": "tagValue1" + } }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" + "output": { + "instance": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "Initializing", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceName": "example instance name", + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 + } + } + }, + { + "title": "Successful CreateInstance request with no input data", + "output": { + "instance": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "Initializing", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceDescription": "", + "kmsKeyArn": "arn:aws:kms:us-west-2:456789012345:key/7372eb6d-874c-4212-8d49-7804282d33a8", + "versionNumber": 2.0 + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/api/instance" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#CreateInstanceRequest": { + "type": "structure", + "members": { + "instanceName": { + "target": "com.amazonaws.supplychain#InstanceName", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance name.

" + } + }, + "instanceDescription": { + "target": "com.amazonaws.supplychain#InstanceDescription", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance description.

" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.supplychain#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon Web Services owned KMS key. If you don't provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key.

" + } + }, + "tags": { + "target": "com.amazonaws.supplychain#TagMap", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services tags of an instance to be created.

", + "smithy.api#notProperty": {} + } + }, + "clientToken": { + "target": "com.amazonaws.supplychain#ClientToken", + "traits": { + "smithy.api#documentation": "

The client token for idempotency.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for CreateInstance.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#CreateInstanceResponse": { + "type": "structure", + "members": { + "instance": { + "target": "com.amazonaws.supplychain#Instance", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance resource data details.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for CreateInstance.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#DataIntegrationEventData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1048576 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.supplychain#DataIntegrationEventGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventResource": { + "type": "resource", + "identifiers": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID" + }, + "eventId": { + "target": "com.amazonaws.supplychain#UUID" + } + }, + "properties": { + "eventType": { + "target": "com.amazonaws.supplychain#DataIntegrationEventType" + }, + "data": { + "target": "com.amazonaws.supplychain#DataIntegrationEventData" + }, + "eventGroupId": { + "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId" + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp" + } + }, + "create": { + "target": "com.amazonaws.supplychain#SendDataIntegrationEvent" + }, + "traits": { + "aws.api#arn": { + "template": "instance/{instanceId}/data-integration-events/{eventId}" + } + } + }, + "com.amazonaws.supplychain#DataIntegrationEventType": { + "type": "enum", + "members": { + "FORECAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.forecast" + } + }, + "INVENTORY_LEVEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inventorylevel" + } + }, + "INBOUND_ORDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorder" + } + }, + "INBOUND_ORDER_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorderline" + } + }, + "INBOUND_ORDER_LINE_SCHEDULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.inboundorderlineschedule" + } + }, + "OUTBOUND_ORDER_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.outboundorderline" + } + }, + "OUTBOUND_SHIPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.outboundshipment" + } + }, + "PROCESS_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.processheader" + } + }, + "PROCESS_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.processoperation" + } + }, + "PROCESS_PRODUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.processproduct" + } + }, + "RESERVATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.reservation" + } + }, + "SHIPMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.shipment" + } + }, + "SHIPMENT_STOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.shipmentstop" + } + }, + "SHIPMENT_STOP_ORDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.shipmentstoporder" + } + }, + "SUPPLY_PLAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scn.data.supplyplan" + } + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlow": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow instance ID.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "instanceId" + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow name.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "name" + } + }, + "sources": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSourceList", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow source configurations.

", + "smithy.api#required": {} + } + }, + "transformation": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTransformation", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow transformation configurations.

", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTarget", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow target configuration.

", + "smithy.api#required": {} + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow creation timestamp.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow last modified timestamp.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow details.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowDatasetOptions": { + "type": "structure", + "members": { + "loadType": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowLoadType", + "traits": { + "smithy.api#documentation": "

The dataset data load type in dataset options.

" + } + }, + "dedupeRecords": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

The dataset load option to remove duplicates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dataset options used in dataset source and target configurations.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowDatasetSourceConfiguration": { + "type": "structure", + "members": { + "datasetIdentifier": { + "target": "com.amazonaws.supplychain#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "

The ARN of the dataset.

", + "smithy.api#required": {} + } + }, + "options": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowDatasetOptions", + "traits": { + "smithy.api#documentation": "

The dataset DataIntegrationFlow source options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dataset DataIntegrationFlow source configuration parameters.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowDatasetTargetConfiguration": { + "type": "structure", + "members": { + "datasetIdentifier": { + "target": "com.amazonaws.supplychain#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "

The dataset ARN.

", + "smithy.api#required": {} + } + }, + "options": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowDatasetOptions", + "traits": { + "smithy.api#documentation": "

The dataset DataIntegrationFlow target options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dataset DataIntegrationFlow target configuration parameters.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowFileType": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataIntegrationFlow" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowLoadType": { + "type": "enum", + "members": { + "INCREMENTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL" + } + }, + "REPLACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REPLACE" + } + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]+$" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowResource": { + "type": "resource", + "identifiers": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID" + }, + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName" + } + }, + "properties": { + "sources": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSourceList" + }, + "transformation": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTransformation" + }, + "target": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTarget" + }, + "createdTime": { + "target": "smithy.api#Timestamp" + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp" + } + }, + "put": { + "target": "com.amazonaws.supplychain#CreateDataIntegrationFlow" + }, + "read": { + "target": "com.amazonaws.supplychain#GetDataIntegrationFlow" + }, + "update": { + "target": "com.amazonaws.supplychain#UpdateDataIntegrationFlow" + }, + "delete": { + "target": "com.amazonaws.supplychain#DeleteDataIntegrationFlow" + }, + "list": { + "target": "com.amazonaws.supplychain#ListDataIntegrationFlows" + }, + "traits": { + "aws.api#arn": { + "template": "instance/{instanceId}/data-integration-flows/{name}" + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowS3Options": { + "type": "structure", + "members": { + "fileType": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowFileType", + "traits": { + "smithy.api#documentation": "

The Amazon S3 file type in S3 options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 options used in S3 source and target configurations.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowS3Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 700 + }, + "smithy.api#pattern": "^[/A-Za-z0-9._-]+$" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowS3SourceConfiguration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.supplychain#S3BucketName", + "traits": { + "smithy.api#documentation": "

The bucketName of the S3 source objects.

", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowS3Prefix", + "traits": { + "smithy.api#documentation": "

The prefix of the S3 source objects.

", + "smithy.api#required": {} + } + }, + "options": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowS3Options", + "traits": { + "smithy.api#documentation": "

The other options of the S3 DataIntegrationFlow source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The S3 DataIntegrationFlow source configuration parameters.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowS3TargetConfiguration": { + "type": "structure", + "members": { + "bucketName": { + "target": "com.amazonaws.supplychain#S3BucketName", + "traits": { + "smithy.api#documentation": "

The bucketName of the S3 target objects.

", + "smithy.api#required": {} + } + }, + "prefix": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowS3Prefix", + "traits": { + "smithy.api#documentation": "

The prefix of the S3 target objects.

", + "smithy.api#required": {} + } + }, + "options": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowS3Options", + "traits": { + "smithy.api#documentation": "

The S3 DataIntegrationFlow target options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The S3 DataIntegrationFlow target configuration parameters.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowSQLQuery": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowSQLTransformationConfiguration": { + "type": "structure", + "members": { + "query": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSQLQuery", + "traits": { + "smithy.api#documentation": "

The transformation SQL query body based on SparkSQL.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The SQL DataIntegrationFlow transformation configuration parameters.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowSource": { + "type": "structure", + "members": { + "sourceType": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSourceType", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow source type.

", + "smithy.api#required": {} + } + }, + "sourceName": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSourceName", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow source name that can be used as table alias in SQL transformation query.

", + "smithy.api#required": {} + } + }, + "s3Source": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowS3SourceConfiguration", + "traits": { + "smithy.api#documentation": "

The S3 DataIntegrationFlow source.

" + } + }, + "datasetSource": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowDatasetSourceConfiguration", + "traits": { + "smithy.api#documentation": "

The dataset DataIntegrationFlow source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow source parameters.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSource" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowSourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9_]+$" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowSourceType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET" + } + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowTarget": { + "type": "structure", + "members": { + "targetType": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTargetType", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow target type.

", + "smithy.api#required": {} + } + }, + "s3Target": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowS3TargetConfiguration", + "traits": { + "smithy.api#documentation": "

The S3 DataIntegrationFlow target.

" + } + }, + "datasetTarget": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowDatasetTargetConfiguration", + "traits": { + "smithy.api#documentation": "

The dataset DataIntegrationFlow target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow target parameters.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowTargetType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET" + } + } + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowTransformation": { + "type": "structure", + "members": { + "transformationType": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTransformationType", + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow transformation type.

", + "smithy.api#required": {} + } + }, + "sqlTransformation": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSQLTransformationConfiguration", + "traits": { + "smithy.api#documentation": "

The SQL DataIntegrationFlow transformation configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The DataIntegrationFlow transformation parameters.

" + } + }, + "com.amazonaws.supplychain#DataIntegrationFlowTransformationType": { + "type": "enum", + "members": { + "SQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.supplychain#DataLakeDataset": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "instanceId" + } + }, + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "traits": { + "smithy.api#documentation": "

The name space of the dataset. The available values are:

\n ", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "namespace" + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "name" + } + }, + "arn": { + "target": "com.amazonaws.supplychain#AscResourceArn", + "traits": { + "smithy.api#documentation": "

The arn of the dataset.

", + "smithy.api#required": {} + } + }, + "schema": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchema", + "traits": { + "smithy.api#documentation": "

The schema of the dataset.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.supplychain#DataLakeDatasetDescription", + "traits": { + "smithy.api#documentation": "

The description of the dataset.

" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The creation time of the dataset.

", + "smithy.api#required": {} + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The last modified time of the dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The data lake dataset details.

" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataLakeDataset" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 75 + }, + "smithy.api#pattern": "^[a-z0-9_]+$" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-z]+$" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetResource": { + "type": "resource", + "identifiers": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID" + }, + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace" + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetName" + } + }, + "properties": { + "arn": { + "target": "com.amazonaws.supplychain#AscResourceArn" + }, + "schema": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchema" + }, + "description": { + "target": "com.amazonaws.supplychain#DataLakeDatasetDescription" + }, + "createdTime": { + "target": "smithy.api#Timestamp" + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp" + } + }, + "put": { + "target": "com.amazonaws.supplychain#CreateDataLakeDataset" + }, + "read": { + "target": "com.amazonaws.supplychain#GetDataLakeDataset" + }, + "update": { + "target": "com.amazonaws.supplychain#UpdateDataLakeDataset" + }, + "delete": { + "target": "com.amazonaws.supplychain#DeleteDataLakeDataset" + }, + "list": { + "target": "com.amazonaws.supplychain#ListDataLakeDatasets" + }, + "traits": { + "aws.api#arn": { + "template": "instance/{instanceId}/namespaces/{namespace}/datasets/{name}" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchema": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchemaName", + "traits": { + "smithy.api#documentation": "

The name of the dataset schema.

", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldList", + "traits": { + "smithy.api#documentation": "

The list of field details of the dataset schema.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The schema details of the dataset.

" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchemaField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldName", + "traits": { + "smithy.api#documentation": "

The dataset field name.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldType", + "traits": { + "smithy.api#documentation": "

The dataset field type.

", + "smithy.api#required": {} + } + }, + "isRequired": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicate if the field is required or not.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The dataset field details.

" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#DataLakeDatasetSchemaField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[a-z0-9_]+$" + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchemaFieldType": { + "type": "enum", + "members": { + "INT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INT" + } + }, + "DOUBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTAMP" + } + } + } + }, + "com.amazonaws.supplychain#DataLakeDatasetSchemaName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.supplychain#DatasetIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^[-_/A-Za-z0-9:]+$" + } + }, + "com.amazonaws.supplychain#DeleteDataIntegrationFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#DeleteDataIntegrationFlowRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#DeleteDataIntegrationFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete the DataIntegrationFlow.

", + "smithy.api#examples": [ + { + "title": "Successful DeleteDataIntegrationFlow", + "input": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow" + }, + "output": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/api/data-integration/instance/{instanceId}/data-integration-flows/{name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#DeleteDataIntegrationFlowRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", + "traits": { + "smithy.api#documentation": "

The name of the DataIntegrationFlow to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for DeleteDataIntegrationFlow.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#DeleteDataIntegrationFlowResponse": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", + "traits": { + "smithy.api#documentation": "

The name of the DataIntegrationFlow deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for DeleteDataIntegrationFlow.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#DeleteDataLakeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#DeleteDataLakeDatasetRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#DeleteDataLakeDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete a data lake dataset.

", + "smithy.api#examples": [ + { + "title": "Delete an AWS Supply Chain inbound_order dataset", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order" + }, + "output": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order" + } + }, + { + "title": "Delete a custom dataset", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset" + }, + "output": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#DeleteDataLakeDatasetRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the dataset. The available values are:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset. If the namespace is asc, the name must be one of the supported data entities\n .

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters of DeleteDataLakeDataset.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#DeleteDataLakeDatasetResponse": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance identifier.

", + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of deleted dataset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetName", + "traits": { + "smithy.api#documentation": "

The name of deleted dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters of DeleteDataLakeDataset.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#DeleteInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#DeleteInstanceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#DeleteInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete the instance. This is an asynchronous operation. Upon receiving a DeleteInstance request, AWS Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use the GetInstance action to check the instance status.

", + "smithy.api#examples": [ + { + "title": "Successful DeleteInstance request", + "input": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793" + }, + "output": { + "instance": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "Deleting", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceName": "updated example instance name", + "instanceDescription": "updated example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/api/instance/{instanceId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#DeleteInstanceRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for DeleteInstance.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#DeleteInstanceResponse": { + "type": "structure", + "members": { + "instance": { + "target": "com.amazonaws.supplychain#Instance", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance resource data details.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for DeleteInstance.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#GalaxyPublicAPIGateway": { + "type": "service", + "version": "2024-01-01", + "operations": [ + { + "target": "com.amazonaws.supplychain#ListTagsForResource" + }, + { + "target": "com.amazonaws.supplychain#TagResource" + }, + { + "target": "com.amazonaws.supplychain#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.supplychain#BillOfMaterialsImportJobResource" + }, + { + "target": "com.amazonaws.supplychain#DataIntegrationEventResource" + }, + { + "target": "com.amazonaws.supplychain#DataIntegrationFlowResource" + }, + { + "target": "com.amazonaws.supplychain#DataLakeDatasetResource" + }, + { + "target": "com.amazonaws.supplychain#InstanceResource" + } + ], + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#ConflictException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SupplyChain", + "arnNamespace": "scn", + "endpointPrefix": "scn" + }, + "aws.auth#sigv4": { + "name": "scn" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "

\n AWS Supply Chain is a cloud-based application that works with your enterprise resource planning (ERP) and supply chain management systems. Using AWS Supply Chain, you can connect and extract your inventory, supply, and demand related data from existing ERP or supply chain systems into a single data model.\n

\n

The AWS Supply Chain API supports configuration data import for Supply Planning.

\n

\n All AWS Supply chain API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies.\n

", + "smithy.api#title": "AWS Supply Chain", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" } ], "assign": "PartitionResult" @@ -805,342 +2646,2405 @@ ], "type": "tree" } - ], - "type": "tree" + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scn-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scn.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scn-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scn.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scn-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://scn.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://scn.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.supplychain#GetBillOfMaterialsImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#GetBillOfMaterialsImportJobRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#GetBillOfMaterialsImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get status and details of a BillOfMaterialsImportJob.

", + "smithy.api#examples": [ + { + "title": "Invoke GetBillOfMaterialsImportJob for a successful job", + "input": { + "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", + "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4" + }, + "output": { + "job": { + "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", + "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4", + "status": "SUCCESS", + "s3uri": "s3://mybucketname/pathelemene/file.csv", + "message": "Import job completed successfully." + } + } + }, + { + "title": "Invoke GetBillOfMaterialsImportJob for an in-progress job", + "input": { + "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", + "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4" + }, + "output": { + "job": { + "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", + "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4", + "status": "IN_PROGRESS", + "s3uri": "s3://mybucketname/pathelemene/file.csv" + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/configuration/instances/{instanceId}/bill-of-materials-import-jobs/{jobId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#GetBillOfMaterialsImportJobRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The BillOfMaterialsImportJob identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for GetBillOfMaterialsImportJob.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#GetBillOfMaterialsImportJobResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.supplychain#BillOfMaterialsImportJob", + "traits": { + "smithy.api#documentation": "

The BillOfMaterialsImportJob.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for GetBillOfMaterialsImportJob.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#GetDataIntegrationFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#GetDataIntegrationFlowRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#GetDataIntegrationFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

View the DataIntegrationFlow details.

", + "smithy.api#examples": [ + { + "title": "Successful GetDataIntegrationFlow", + "input": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow" + }, + "output": { + "flow": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow", + "sources": [ + { + "sourceType": "S3", + "sourceName": "testSourceName", + "s3Source": { + "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f", + "prefix": "example-prefix" + } + } + ], + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset" + } }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT * FROM testSourceName" + } + }, + "createdTime": 1.72495640044E9, + "lastModifiedTime": 1.72495640044E9 + } } - ] + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/data-integration/instance/{instanceId}/data-integration-flows/{name}" }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://scn-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#GetDataIntegrationFlowRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", + "traits": { + "smithy.api#documentation": "

The name of the DataIntegrationFlow created.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for GetDataIntegrationFlow.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#GetDataIntegrationFlowResponse": { + "type": "structure", + "members": { + "flow": { + "target": "com.amazonaws.supplychain#DataIntegrationFlow", + "traits": { + "smithy.api#documentation": "

The details of the DataIntegrationFlow returned.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for GetDataIntegrationFlow.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#GetDataLakeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#GetDataLakeDatasetRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#GetDataLakeDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get a data lake dataset.

", + "smithy.api#examples": [ + { + "title": "Get properties of an existing AWS Supply Chain inbound order dataset", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://scn.us-east-1.api.aws" + "output": { + "dataset": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order", + "description": "This is an AWS Supply Chain inbound order dataset", + "createdTime": 1.727116807751E9, + "lastModifiedTime": 1.727116807751E9, + "schema": { + "name": "InboundOrder", + "fields": [ + { + "name": "id", + "type": "STRING", + "isRequired": true + }, + { + "name": "tpartner_id", + "type": "STRING", + "isRequired": true + }, + { + "name": "connection_id", + "type": "STRING", + "isRequired": true + }, + { + "name": "order_type", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_status", + "type": "STRING", + "isRequired": false + }, + { + "name": "inbound_order_url", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_creation_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "company_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "to_site_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_currency_uom", + "type": "STRING", + "isRequired": false + }, + { + "name": "vendor_currency_uom", + "type": "STRING", + "isRequired": false + }, + { + "name": "exchange_rate", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "exchange_rate_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "incoterm", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm2", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm_location_1", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm_location_2", + "type": "STRING", + "isRequired": false + }, + { + "name": "submitted_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "agreement_start_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "agreement_end_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "shipping_instr_code", + "type": "STRING", + "isRequired": false + }, + { + "name": "payment_terms_code", + "type": "STRING", + "isRequired": false + }, + { + "name": "std_terms_agreement", + "type": "STRING", + "isRequired": false + }, + { + "name": "std_terms_agreement_ver", + "type": "STRING", + "isRequired": false + }, + { + "name": "agreement_number", + "type": "STRING", + "isRequired": false + }, + { + "name": "source", + "type": "STRING", + "isRequired": false + }, + { + "name": "source_update_dttm", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "source_event_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "db_creation_dttm", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "db_updation_dttm", + "type": "TIMESTAMP", + "isRequired": false + } + ] } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true } + } + }, + { + "title": "Get proporties of an existing custom dataset", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn.us-east-1.amazonaws.com" + "output": { + "dataset": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset", + "description": "This is a custom dataset", + "createdTime": 1.727116807751E9, + "lastModifiedTime": 1.727116807751E9, + "schema": { + "name": "MyDataset", + "fields": [ + { + "name": "id", + "type": "INT", + "isRequired": true + }, + { + "name": "description", + "type": "STRING", + "isRequired": true + }, + { + "name": "price", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "creation_time", + "type": "TIMESTAMP", + "isRequired": false + } + ] } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#GetDataLakeDatasetRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "traits": { + "smithy.api#documentation": "

The name space of the dataset. The available values are:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetName", + "traits": { + "smithy.api#documentation": "

The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for GetDataLakeDataset.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#GetDataLakeDatasetResponse": { + "type": "structure", + "members": { + "dataset": { + "target": "com.amazonaws.supplychain#DataLakeDataset", + "traits": { + "smithy.api#documentation": "

The fetched dataset details.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for UpdateDataLakeDataset.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#GetInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#GetInstanceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#GetInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Get the AWS Supply Chain instance details.

", + "smithy.api#examples": [ + { + "title": "Successful GetInstance request", + "input": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793" }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://scn-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true + "output": { + "instance": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "Active", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceName": "example instance name", + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/instance/{instanceId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#GetInstanceRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance identifier

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for GetInstance.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#GetInstanceResponse": { + "type": "structure", + "members": { + "instance": { + "target": "com.amazonaws.supplychain#Instance", + "traits": { + "smithy.api#documentation": "

The instance resource data details.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for GetInstance.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#Instance": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "instanceId" + } + }, + "awsAccountId": { + "target": "com.amazonaws.supplychain#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that owns the instance.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.supplychain#InstanceState", + "traits": { + "smithy.api#documentation": "

The state of the instance.

", + "smithy.api#required": {} + } + }, + "webAppDnsDomain": { + "target": "com.amazonaws.supplychain#InstanceWebAppDnsDomain", + "traits": { + "smithy.api#documentation": "

The WebApp DNS domain name of the instance.

" + } + }, + "createdTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The instance creation timestamp.

" + } + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The instance last modified timestamp.

" + } + }, + "instanceName": { + "target": "com.amazonaws.supplychain#InstanceName", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance name.

" + } + }, + "instanceDescription": { + "target": "com.amazonaws.supplychain#InstanceDescription", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance description.

" + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.supplychain#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

" + } + }, + "versionNumber": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The version number of the instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details of the instance.

" + } + }, + "com.amazonaws.supplychain#InstanceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 501 + }, + "smithy.api#pattern": "^([a-zA-Z0-9., _ʼ'%-]){0,500}$" + } + }, + "com.amazonaws.supplychain#InstanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#Instance" + } + }, + "com.amazonaws.supplychain#InstanceMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 10, + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.supplychain#InstanceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + }, + "smithy.api#pattern": "^(?![ _ʼ'%-])[a-zA-Z0-9 _ʼ'%-]{0,62}[a-zA-Z0-9]$" + } + }, + "com.amazonaws.supplychain#InstanceNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#InstanceName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.supplychain#InstanceNextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.supplychain#InstanceResource": { + "type": "resource", + "identifiers": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID" + } + }, + "properties": { + "awsAccountId": { + "target": "com.amazonaws.supplychain#AwsAccountId" + }, + "webAppDnsDomain": { + "target": "com.amazonaws.supplychain#InstanceWebAppDnsDomain" + }, + "state": { + "target": "com.amazonaws.supplychain#InstanceState" + }, + "createdTime": { + "target": "smithy.api#Timestamp" + }, + "lastModifiedTime": { + "target": "smithy.api#Timestamp" + }, + "instanceName": { + "target": "com.amazonaws.supplychain#InstanceName" + }, + "instanceDescription": { + "target": "com.amazonaws.supplychain#InstanceDescription" + }, + "kmsKeyArn": { + "target": "com.amazonaws.supplychain#KmsKeyArn" + }, + "versionNumber": { + "target": "smithy.api#Double" + } + }, + "create": { + "target": "com.amazonaws.supplychain#CreateInstance" + }, + "read": { + "target": "com.amazonaws.supplychain#GetInstance" + }, + "update": { + "target": "com.amazonaws.supplychain#UpdateInstance" + }, + "delete": { + "target": "com.amazonaws.supplychain#DeleteInstance" + }, + "list": { + "target": "com.amazonaws.supplychain#ListInstances" + }, + "traits": { + "aws.api#arn": { + "template": "instance/{instanceId}" + } + } + }, + "com.amazonaws.supplychain#InstanceState": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Initializing" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreateFailed" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeleteFailed" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleting" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deleted" + } + } + } + }, + "com.amazonaws.supplychain#InstanceStateList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#InstanceState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 + } + } + }, + "com.amazonaws.supplychain#InstanceWebAppDnsDomain": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9]+(.[A-Za-z0-9]+)+$" + } + }, + "com.amazonaws.supplychain#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

Unexpected error during processing of request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.supplychain#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:[a-z0-9][-.a-z0-9]{0,62}:kms:([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:key/.{0,1019}$" + } + }, + "com.amazonaws.supplychain#ListDataIntegrationFlows": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#ListDataIntegrationFlowsRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#ListDataIntegrationFlowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the DataIntegrationFlows in a paginated way.

", + "smithy.api#examples": [ + { + "title": "Successful ListDataIntegrationFlow", + "input": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d" }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn-fips.cn-north-1.amazonaws.com.cn" + "output": { + "flows": [ + { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow", + "sources": [ + { + "sourceType": "S3", + "sourceName": "testSourceName", + "s3Source": { + "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f", + "prefix": "example-prefix" + } + } + ], + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset" + } + }, + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT * FROM testSourceName" + } + }, + "createdTime": 1.72495640044E9, + "lastModifiedTime": 1.72495640044E9 + }, + { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "trading-partner", + "sources": [ + { + "sourceType": "DATASET", + "sourceName": "testSourceName1", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1" + } + }, + { + "sourceType": "DATASET", + "sourceName": "testSourceName2", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2" + } + } + ], + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT S1.id AS id, S1.poc_org_unit_description AS description, S1.company_id AS company_id, S1.tpartner_type AS tpartner_type, S1.geo_id AS geo_id, S1.eff_start_date AS eff_start_date, S1.eff_end_date AS eff_end_date FROM testSourceName1 AS S1 LEFT JOIN testSourceName2 as S2 ON S1.id=S2.id" + } + }, + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + } + }, + "createdTime": 1.723576350688E10, + "lastModifiedTime": 1.723576350688E10 } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/data-integration/instance/{instanceId}/data-integration-flows" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flows" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#ListDataIntegrationFlowsRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to fetch the next page of the DataIntegrationFlows.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowMaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "

Specify the maximum number of DataIntegrationFlows to fetch in one paginated request.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for ListDataIntegrationFlows.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#ListDataIntegrationFlowsResponse": { + "type": "structure", + "members": { + "flows": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowList", + "traits": { + "smithy.api#documentation": "

The response parameters for ListDataIntegrationFlows.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to fetch the next page of the DataIntegrationFlows.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for ListDataIntegrationFlows.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#ListDataLakeDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#ListDataLakeDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#ListDataLakeDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List the data lake datasets for a specific instance and name space.

", + "smithy.api#examples": [ + { + "title": "List AWS Supply Chain datasets", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://scn.cn-north-1.api.amazonwebservices.com.cn" + "output": { + "datasets": [ + { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order", + "description": "This is an AWS Supply Chain inbound order dataset", + "createdTime": 1.727116807751E9, + "lastModifiedTime": 1.727116807751E9, + "schema": { + "name": "InboundOrder", + "fields": [ + { + "name": "id", + "type": "STRING", + "isRequired": true + }, + { + "name": "tpartner_id", + "type": "STRING", + "isRequired": true + }, + { + "name": "connection_id", + "type": "STRING", + "isRequired": true + }, + { + "name": "order_type", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_status", + "type": "STRING", + "isRequired": false + }, + { + "name": "inbound_order_url", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_creation_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "company_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "to_site_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_currency_uom", + "type": "STRING", + "isRequired": false + }, + { + "name": "vendor_currency_uom", + "type": "STRING", + "isRequired": false + }, + { + "name": "exchange_rate", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "exchange_rate_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "incoterm", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm2", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm_location_1", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm_location_2", + "type": "STRING", + "isRequired": false + }, + { + "name": "submitted_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "agreement_start_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "agreement_end_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "shipping_instr_code", + "type": "STRING", + "isRequired": false + }, + { + "name": "payment_terms_code", + "type": "STRING", + "isRequired": false + }, + { + "name": "std_terms_agreement", + "type": "STRING", + "isRequired": false + }, + { + "name": "std_terms_agreement_ver", + "type": "STRING", + "isRequired": false + }, + { + "name": "agreement_number", + "type": "STRING", + "isRequired": false + }, + { + "name": "source", + "type": "STRING", + "isRequired": false + }, + { + "name": "source_update_dttm", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "source_event_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "db_creation_dttm", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "db_updation_dttm", + "type": "TIMESTAMP", + "isRequired": false + } + ] + } } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } + ] + } + }, + { + "title": "List custom datasets using pagination", + "input": { + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "maxResults": 2, + "nextToken": "next_token_returned_from_previous_list_request" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn.cn-north-1.amazonaws.com.cn" + "output": { + "datasets": [ + { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset", + "description": "This is a custom dataset", + "createdTime": 1.727116807751E9, + "lastModifiedTime": 1.727116807751E9, + "schema": { + "name": "MyDataset", + "fields": [ + { + "name": "id", + "type": "INT", + "isRequired": true + }, + { + "name": "description", + "type": "STRING", + "isRequired": true + }, + { + "name": "price", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "creation_time", + "type": "TIMESTAMP", + "isRequired": false + } + ] + } + }, + { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset_2", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset_2", + "description": "This is a custom dataset 2", + "createdTime": 1.727116907751E9, + "lastModifiedTime": 1.727116907751E9, + "schema": { + "name": "MyDataset2", + "fields": [ + { + "name": "id", + "type": "INT", + "isRequired": true + }, + { + "name": "description", + "type": "STRING", + "isRequired": true + } + ] + } } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://scn-fips.us-gov-east-1.api.aws" + ], + "nextToken": "next_token_for_next_list_request" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "datasets" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#ListDataLakeDatasetsRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the dataset. The available values are:

\n ", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to fetch next page of datasets.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.supplychain#DataLakeDatasetMaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "

The max number of datasets to fetch in this paginated request.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters of ListDataLakeDatasets.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#ListDataLakeDatasetsResponse": { + "type": "structure", + "members": { + "datasets": { + "target": "com.amazonaws.supplychain#DataLakeDatasetList", + "traits": { + "smithy.api#documentation": "

The list of fetched dataset details.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to fetch next page of datasets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters of ListDataLakeDatasets.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#ListInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#ListInstancesRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#ListInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all the AWS Supply Chain instances in a paginated way.

", + "smithy.api#examples": [ + { + "title": "Successful ListInstance request with no input data", + "output": { + "instances": [ + { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "Active", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceName": "example instance name", + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 + }, + { + "instanceId": "3ad8116a-644d-4172-8dcb-20e51d314c14", + "awsAccountId": "123456789012", + "state": "Initializing", + "createdTime": 17261674383136, + "lastModifiedTime": 17261674383136, + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } + ] + } + }, + { + "title": "Successful ListInstance request with filters", + "input": { + "instanceNameFilter": [ + "example instance name" + ], + "instanceStateFilter": [ + "Active" + ] }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn-fips.us-gov-east-1.amazonaws.com" + "output": { + "instances": [ + { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "Active", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceName": "example instance name", + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } + ] + } + }, + { + "title": "Successful ListInstance request with maxResult override", + "input": { + "maxResults": 1 }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://scn.us-gov-east-1.api.aws" + "output": { + "instances": [ + { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "Active", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceName": "example instance name", + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + ], + "nextToken": "AAQA-EFRSURBSGhtcng0c0dxbENwUHdnckVIbkFYNU1QVjRTZWN2ak5iMFVicC8zemlHOVF3SEpjSC9WTWJVVXBMV2Z1N3ZvZlQ0WEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTJibW9LemgrSWZTY0RaZEdBZ0VRZ0R2dDhsQnVGbGJ0dnFTZityWmNSWEVPbG93emJoSjhxOGNMbGQ1UGMvY0VRbWlTR3pQUFd4N2RraXY5Y0ovcS9vSmFYZVBGdWVHaU0zWmd0dz09n-rC1ejA5--7ltJxpDT2xP_i8xGqDPMOZfjpp8q6l5NuP9_bnBURvwwYhdqDriMK5_f96LuPEnPbuML-ItfgEiCcUy0p2tApvpZkZqOG5fbqP-4C5aDYPTffHLyq-MMqvfrGVJzL1nvkpZcnTkVR9VJsu5b8I0qqDW0H8EMKGgTo78U9lr4sj3Usi9VMwZxgKCBmr03HhFLYXOW--XMbIx0CTZF0fYIcRxmA_sVS6J7gpaB9yMcnzs5VUKokoA5JTcAPY5d1Y1VyE8KKxv51cfPgXw8OYCDbFQncw8mZPmE-VqxjFbksmk_FmghpPn9j2Ppoe-zr0LQ%3D" + } + }, + { + "title": "Successful ListInstance request with nextToken", + "input": { + "nextToken": "AAQA-EFRSURBSGhtcng0c0dxbENwUHdnckVIbkFYNU1QVjRTZWN2ak5iMFVicC8zemlHOVF3SEpjSC9WTWJVVXBMV2Z1N3ZvZlQ0WEFBQUFmakI4QmdrcWhraUc5dzBCQndhZ2J6QnRBZ0VBTUdnR0NTcUdTSWIzRFFFSEFUQWVCZ2xnaGtnQlpRTUVBUzR3RVFRTTJibW9LemgrSWZTY0RaZEdBZ0VRZ0R2dDhsQnVGbGJ0dnFTZityWmNSWEVPbG93emJoSjhxOGNMbGQ1UGMvY0VRbWlTR3pQUFd4N2RraXY5Y0ovcS9vSmFYZVBGdWVHaU0zWmd0dz09n-rC1ejA5--7ltJxpDT2xP_i8xGqDPMOZfjpp8q6l5NuP9_bnBURvwwYhdqDriMK5_f96LuPEnPbuML-ItfgEiCcUy0p2tApvpZkZqOG5fbqP-4C5aDYPTffHLyq-MMqvfrGVJzL1nvkpZcnTkVR9VJsu5b8I0qqDW0H8EMKGgTo78U9lr4sj3Usi9VMwZxgKCBmr03HhFLYXOW--XMbIx0CTZF0fYIcRxmA_sVS6J7gpaB9yMcnzs5VUKokoA5JTcAPY5d1Y1VyE8KKxv51cfPgXw8OYCDbFQncw8mZPmE-VqxjFbksmk_FmghpPn9j2Ppoe-zr0LQ%3D", + "maxResults": 1 }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn.us-gov-east-1.amazonaws.com" + "output": { + "instances": [ + { + "instanceId": "3ad8116a-644d-4172-8dcb-20e51d314c14", + "awsAccountId": "123456789012", + "state": "Initializing", + "createdTime": 17261674383136, + "lastModifiedTime": 17261674383136, + "instanceDescription": "example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false + ] + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/instance" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "instances" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#ListInstancesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.supplychain#InstanceNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to fetch the next page of instances.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.supplychain#InstanceMaxResults", + "traits": { + "smithy.api#default": 10, + "smithy.api#documentation": "

Specify the maximum number of instances to fetch in this paginated request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "instanceNameFilter": { + "target": "com.amazonaws.supplychain#InstanceNameList", + "traits": { + "smithy.api#documentation": "

The filter to ListInstances based on their names.

", + "smithy.api#httpQuery": "instanceNameFilter" + } + }, + "instanceStateFilter": { + "target": "com.amazonaws.supplychain#InstanceStateList", + "traits": { + "smithy.api#documentation": "

The filter to ListInstances based on their state.

", + "smithy.api#httpQuery": "instanceStateFilter" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for ListInstances.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#ListInstancesResponse": { + "type": "structure", + "members": { + "instances": { + "target": "com.amazonaws.supplychain#InstanceList", + "traits": { + "smithy.api#documentation": "

The list of instances resource data details.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.supplychain#InstanceNextToken", + "traits": { + "smithy.api#documentation": "

The pagination token to fetch the next page of instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for ListInstances.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all the tags for an Amazon Web ServicesSupply Chain resource.

", + "smithy.api#examples": [ + { + "title": "Successful ListTagsForResource", + "input": { + "resourceArn": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/data-integration-flows/my_flow1" + }, + "output": { + "tags": { + "tagKey1": "tagValue1" } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/api/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.supplychain#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.supplychain#AscResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply chain resource ARN that needs tags to be listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters of ListTagsForResource.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.supplychain#TagMap", + "traits": { + "smithy.api#documentation": "

The tags added to an Amazon Web Services Supply Chain resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters of ListTagsForResource.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

Request references a resource which does not exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.supplychain#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][a-z0-9.-]*[a-z0-9]$" + } + }, + "com.amazonaws.supplychain#SendDataIntegrationEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#SendDataIntegrationEventRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#SendDataIntegrationEventResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#ConflictException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. \n New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.

", + "smithy.api#examples": [ + { + "title": "Successful SendDataIntegrationEvent for inboundorder event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.inboundorder", + "data": "{\"id\": \"inbound-order-id-test-123\", \"tpartner_id\": \"partner-id-test-123\" }", + "eventGroupId": "inboundOrderId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "c4132c1d-8f60-44a2-9932-f723c4f7b8a7" + } + }, + { + "title": "Successful SendDataIntegrationEvent for inboundorderline event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.inboundorderline", + "data": "{\"id\": \"inbound-order-line-id-test-123\", \"order_id\": \"order-id-test-123\", \"tpartner_id\": \"partner-id-test-123\", \"product_id\": \"product-id-test-123\", \"quantity_submitted\": \"100.0\" }", + "eventGroupId": "inboundOrderLineId", + "eventTimestamp": 1.515531081123E9 + }, + "output": { + "eventId": "45d95db2-d106-40e0-aa98-f1204230a691" + } + }, + { + "title": "Successful SendDataIntegrationEvent for inboundorderlineschedule event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.inboundorderlineschedule", + "data": "{\"id\": \"inbound-order-line-schedule-id-test-123\", \"order_id\": \"order-id-test-123\", \"order_line_id\": \"order-line-id-test-123\", \"product_id\": \"product-id-test-123\"}", + "eventGroupId": "inboundOrderLineScheduleId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "output": { + "eventId": "5abba995-7735-4d1e-95c4-7cc93e48cf9f" + } + }, + { + "title": "Successful SendDataIntegrationEvent for forecast event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.forecast", + "data": "{\"snapshot_date\": \"1672470400000\", \"product_id\": \"product-id-test-123\", \"site_id\": \"site-id-test-123\", \"region_id\": \"region-id-test-123\", \"product_group_id\": \"product-group-id-test-123\", \"forecast_start_dttm\": \"1672470400000\", \"forecast_end_dttm\": \"1672470400000\" }", + "eventGroupId": "forecastId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "eventId": "29312d5b-f499-4dcd-b017-3dab3cd34d61" + } + }, + { + "title": "Successful SendDataIntegrationEvent for inventorylevel event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.inventorylevel", + "data": "{\"snapshot_date\": \"1672470400000\", \"site_id\": \"site-id-test-123\", \"product_id\": \"product-id-test-123\", \"on_hand_inventory\": \"100.0\", \"inv_condition\": \"good\", \"lot_number\": \"lot-number-test-123\"}", + "eventGroupId": "inventoryLevelId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "eventId": "3aa78324-acd8-4fdd-a19e-231ea003c2b3" + } + }, + { + "title": "Successful SendDataIntegrationEvent for outboundorderline event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.outboundorderline", + "data": "{\"id\": \"outbound-orderline-id-test-123\", \"cust_order_id\": \"cust-order-id-test-123\", \"product_id\": \"product-id-test-123\" }", + "eventGroupId": "outboundOrderLineId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "eventId": "959b7ef9-5e2d-4795-b1ca-5b16a3eb6b89" + } + }, + { + "title": "Successful SendDataIntegrationEvent for outboundshipment event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.outboundshipment", + "data": "{\"id\": \"outbound-shipment-id-test-123\", \"cust_order_id\": \"cust-order-id-test-123\", \"cust_order_line_id\": \"cust-order-line-id-test-123\", \"product_id\": \"product-id-test-123\" }", + "eventGroupId": "outboundShipmentId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "output": { + "eventId": "59feded3-5e46-4126-81bf-0137ca176ee0" + } + }, + { + "title": "Successful SendDataIntegrationEvent for processheader event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.processheader", + "data": "{\"process_id\": \"process-id-test-123\" }", + "eventGroupId": "processHeaderId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "eventId": "564130eb-2d8a-4550-a768-ddf0daf7b4a9" + } + }, + { + "title": "Successful SendDataIntegrationEvent for processoperation event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.processoperation", + "data": "{\"process_operation_id\": \"process-operation-id-test-123\", \"process_id\": \"process-id-test-123\" }", + "eventGroupId": "processOperationId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "eventId": "db5df408-89c7-4b9f-a326-016f6c2b3396" + } + }, + { + "title": "Successful SendDataIntegrationEvent for processproduct event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.processproduct", + "data": "{\"process_product_id\": \"process-product-id-test-123\", \"process_id\": \"process-id-test-123\" }", + "eventGroupId": "processProductId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://scn.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "eventId": "6929b275-485e-4035-a798-99077ca6d669" + } + }, + { + "title": "Successful SendDataIntegrationEvent for reservation event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.reservation", + "data": "{\"reservation_id\": \"reservation-id-test-123\", \"reservation_detail_id\": \"reservation-detail-id-test-123\" }", + "eventGroupId": "reservationId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "output": { + "eventId": "f6c55a8b-fde2-44f6-848a-9b4336c77209" + } + }, + { + "title": "Successful SendDataIntegrationEvent for shipment event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.shipment", + "data": "{\"id\": \"shipment-id-test-123\", \"supplier_tpartner_id\": \"supplier-tpartner-id-test-123\", \"product_id\": \"product-id-test-123\", \"order_id\": \"order-id-test-123\", \"order_line_id\": \"order-line-id-test-123\", \"package_id\": \"package-id-test-123\" }", + "eventGroupId": "shipmentId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "output": { + "eventId": "61d079d8-3f56-49bb-b35a-c0271a4e4f0a" + } + }, + { + "title": "Successful SendDataIntegrationEvent for shipmentstop event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.shipmentstop", + "data": "{\"shipment_stop_id\": \"shipment-stop-id-test-123\", \"shipment_id\": \"shipment-id-test-123\" }", + "eventGroupId": "shipmentStopId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "output": { + "eventId": "3610992a-fc2f-4da4-9beb-724994622ba1" + } + }, + { + "title": "Successful SendDataIntegrationEvent for shipmentstoporder event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.shipmentstoporder", + "data": "{\"shipment_stop_order_id\": \"shipment-stop-order-id-test-123\", \"shipment_stop_id\": \"shipment-stop-id-test-123\", \"shipment_id\": \"shipment-id-test-123\" }", + "eventGroupId": "shipmentStopOrderId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "output": { + "eventId": "1d550a60-9321-4d25-a132-9dd4b2d9e934" + } + }, + { + "title": "Successful SendDataIntegrationEvent for supplyplan event type", + "input": { + "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", + "eventType": "scn.data.supplyplan", + "data": "{\"supply_plan_id\": \"supply-plan-id-test-123\" }", + "eventGroupId": "supplyPlanId", + "eventTimestamp": 1.515531081123E9 }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "output": { + "eventId": "9abaee56-5dc4-4c31-8250-3206a651d8a1" } - ], - "version": "1.0" + } + ], + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/api-data/data-integration/instance/{instanceId}/data-integration-events" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#SendDataIntegrationEventRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "eventType": { + "target": "com.amazonaws.supplychain#DataIntegrationEventType", + "traits": { + "smithy.api#documentation": "

The data event type.

", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.supplychain#DataIntegrationEventData", + "traits": { + "smithy.api#documentation": "

The data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain\n .

", + "smithy.api#required": {} + } + }, + "eventGroupId": { + "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId", + "traits": { + "smithy.api#documentation": "

Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.

", + "smithy.api#required": {} + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The event timestamp (in epoch seconds).

", + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "clientToken": { + "target": "com.amazonaws.supplychain#ClientToken", + "traits": { + "smithy.api#documentation": "

The idempotent client token.

", + "smithy.api#idempotencyToken": {} + } } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for SendDataIntegrationEvent.

", + "smithy.api#input": {} } }, - "com.amazonaws.supplychain#GetBillOfMaterialsImportJob": { + "com.amazonaws.supplychain#SendDataIntegrationEventResponse": { + "type": "structure", + "members": { + "eventId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The unique event identifier.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for SendDataIntegrationEvent.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

Request would cause a service quota to be exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.supplychain#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.supplychain#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.supplychain#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.supplychain#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.supplychain#TagKey" + }, + "value": { + "target": "com.amazonaws.supplychain#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.supplychain#TagResource": { "type": "operation", "input": { - "target": "com.amazonaws.supplychain#GetBillOfMaterialsImportJobRequest" + "target": "com.amazonaws.supplychain#TagResourceRequest" }, "output": { - "target": "com.amazonaws.supplychain#GetBillOfMaterialsImportJobResponse" + "target": "com.amazonaws.supplychain#TagResourceResponse" }, "errors": [ { @@ -1160,141 +5064,191 @@ } ], "traits": { - "smithy.api#documentation": "

Get status and details of a BillOfMaterialsImportJob.

", + "smithy.api#documentation": "

Create tags for an Amazon Web Services Supply chain resource.

", "smithy.api#examples": [ { - "title": "Invoke GetBillOfMaterialsImportJob for a successful job", + "title": "Successful TagResource", "input": { - "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", - "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4" - }, - "output": { - "job": { - "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", - "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4", - "status": "SUCCESS", - "s3uri": "s3://mybucketname/pathelemene/file.csv", - "message": "Import job completed successfully." + "resourceArn": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/data-integration-flows/my_flow1", + "tags": { + "tagKey1": "tagValue1" } - } - }, - { - "title": "Invoke GetBillOfMaterialsImportJob for an in-progress job", - "input": { - "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", - "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4" }, - "output": { - "job": { - "instanceId": "60f82bbd-71f7-4fcd-a941-472f574c5243", - "jobId": "f79b359b-1515-4436-a3bf-bae7b33e47b4", - "status": "IN_PROGRESS", - "s3uri": "s3://mybucketname/pathelemene/file.csv" - } - } + "output": {} } ], "smithy.api#http": { "code": 200, - "method": "GET", - "uri": "/api/configuration/instances/{instanceId}/bill-of-materials-import-jobs/{jobId}" - }, - "smithy.api#readonly": {} + "method": "POST", + "uri": "/api/tags/{resourceArn}" + } } }, - "com.amazonaws.supplychain#GetBillOfMaterialsImportJobRequest": { + "com.amazonaws.supplychain#TagResourceRequest": { "type": "structure", "members": { - "instanceId": { - "target": "com.amazonaws.supplychain#UUID", + "resourceArn": { + "target": "com.amazonaws.supplychain#AscResourceArn", "traits": { - "smithy.api#documentation": "

The AWS Supply Chain instance identifier.

", + "smithy.api#documentation": "

The Amazon Web Services Supply chain resource ARN that needs to be tagged.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "jobId": { - "target": "com.amazonaws.supplychain#UUID", + "tags": { + "target": "com.amazonaws.supplychain#TagMap", "traits": { - "smithy.api#documentation": "

The BillOfMaterialsImportJob identifier.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The tags of the Amazon Web Services Supply chain resource to be created.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request parameters for GetBillOfMaterialsImportJob.

", + "smithy.api#documentation": "

The request parameters of TagResource.

", "smithy.api#input": {} } }, - "com.amazonaws.supplychain#GetBillOfMaterialsImportJobResponse": { + "com.amazonaws.supplychain#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The response parameters for TagResource.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.supplychain#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "

Request was denied due to request throttling.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.supplychain#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.supplychain#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Delete tags for an Amazon Web Services Supply chain resource.

", + "smithy.api#examples": [ + { + "title": "Successful UntagResource", + "input": { + "resourceArn": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/data-integration-flows/my_flow1", + "tagKeys": [ + "tagKey1" + ] + }, + "output": {} + } + ], + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/api/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.supplychain#UntagResourceRequest": { "type": "structure", "members": { - "job": { - "target": "com.amazonaws.supplychain#BillOfMaterialsImportJob", + "resourceArn": { + "target": "com.amazonaws.supplychain#AscResourceArn", "traits": { - "smithy.api#documentation": "

The BillOfMaterialsImportJob.

", - "smithy.api#nestedProperties": {}, + "smithy.api#documentation": "

The Amazon Web Services Supply chain resource ARN that needs to be untagged.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.supplychain#TagKeyList", + "traits": { + "smithy.api#documentation": "

The list of tag keys to be deleted for an Amazon Web Services Supply Chain resource.

", + "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The response parameters for GetBillOfMaterialsImportJob.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.supplychain#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

Unexpected error during processing of request.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500, - "smithy.api#retryable": {} + "smithy.api#documentation": "

The request parameters of UntagResource.

", + "smithy.api#input": {} } }, - "com.amazonaws.supplychain#ResourceNotFoundException": { + "com.amazonaws.supplychain#UntagResourceResponse": { "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } - }, + "members": {}, "traits": { - "smithy.api#documentation": "

Request references a resource which does not exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "

The response parameters of UntagResource.

", + "smithy.api#output": {} } }, - "com.amazonaws.supplychain#SendDataIntegrationEvent": { + "com.amazonaws.supplychain#UpdateDataIntegrationFlow": { "type": "operation", "input": { - "target": "com.amazonaws.supplychain#SendDataIntegrationEventRequest" + "target": "com.amazonaws.supplychain#UpdateDataIntegrationFlowRequest" }, "output": { - "target": "com.amazonaws.supplychain#SendDataIntegrationEventResponse" + "target": "com.amazonaws.supplychain#UpdateDataIntegrationFlowResponse" }, "errors": [ { "target": "com.amazonaws.supplychain#AccessDeniedException" }, - { - "target": "com.amazonaws.supplychain#ConflictException" - }, { "target": "com.amazonaws.supplychain#InternalServerException" }, { "target": "com.amazonaws.supplychain#ResourceNotFoundException" }, - { - "target": "com.amazonaws.supplychain#ServiceQuotaExceededException" - }, { "target": "com.amazonaws.supplychain#ThrottlingException" }, @@ -1303,317 +5257,619 @@ } ], "traits": { - "smithy.api#documentation": "

Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. \n New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.

", + "smithy.api#documentation": "

Update the DataIntegrationFlow.

", "smithy.api#examples": [ { - "title": "Successful SendDataIntegrationEvent for inboundorder event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.inboundorder", - "data": "{\"id\": \"inbound-order-id-test-123\", \"tpartner_id\": \"partner-id-test-123\" }", - "eventGroupId": "inboundOrderId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "c4132c1d-8f60-44a2-9932-f723c4f7b8a7" - } - }, - { - "title": "Successful SendDataIntegrationEvent for inboundorderline event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.inboundorderline", - "data": "{\"id\": \"inbound-order-line-id-test-123\", \"order_id\": \"order-id-test-123\", \"tpartner_id\": \"partner-id-test-123\", \"product_id\": \"product-id-test-123\", \"quantity_submitted\": \"100.0\" }", - "eventGroupId": "inboundOrderLineId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "45d95db2-d106-40e0-aa98-f1204230a691" - } - }, - { - "title": "Successful SendDataIntegrationEvent for inboundorderlineschedule event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.inboundorderlineschedule", - "data": "{\"id\": \"inbound-order-line-schedule-id-test-123\", \"order_id\": \"order-id-test-123\", \"order_line_id\": \"order-line-id-test-123\", \"product_id\": \"product-id-test-123\"}", - "eventGroupId": "inboundOrderLineScheduleId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "5abba995-7735-4d1e-95c4-7cc93e48cf9f" - } - }, - { - "title": "Successful SendDataIntegrationEvent for forecast event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.forecast", - "data": "{\"snapshot_date\": \"1672470400000\", \"product_id\": \"product-id-test-123\", \"site_id\": \"site-id-test-123\", \"region_id\": \"region-id-test-123\", \"product_group_id\": \"product-group-id-test-123\", \"forecast_start_dttm\": \"1672470400000\", \"forecast_end_dttm\": \"1672470400000\" }", - "eventGroupId": "forecastId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "29312d5b-f499-4dcd-b017-3dab3cd34d61" - } - }, - { - "title": "Successful SendDataIntegrationEvent for inventorylevel event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.inventorylevel", - "data": "{\"snapshot_date\": \"1672470400000\", \"site_id\": \"site-id-test-123\", \"product_id\": \"product-id-test-123\", \"on_hand_inventory\": \"100.0\", \"inv_condition\": \"good\", \"lot_number\": \"lot-number-test-123\"}", - "eventGroupId": "inventoryLevelId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "3aa78324-acd8-4fdd-a19e-231ea003c2b3" - } - }, - { - "title": "Successful SendDataIntegrationEvent for outboundorderline event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.outboundorderline", - "data": "{\"id\": \"outbound-orderline-id-test-123\", \"cust_order_id\": \"cust-order-id-test-123\", \"product_id\": \"product-id-test-123\" }", - "eventGroupId": "outboundOrderLineId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "959b7ef9-5e2d-4795-b1ca-5b16a3eb6b89" - } - }, - { - "title": "Successful SendDataIntegrationEvent for outboundshipment event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.outboundshipment", - "data": "{\"id\": \"outbound-shipment-id-test-123\", \"cust_order_id\": \"cust-order-id-test-123\", \"cust_order_line_id\": \"cust-order-line-id-test-123\", \"product_id\": \"product-id-test-123\" }", - "eventGroupId": "outboundShipmentId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "59feded3-5e46-4126-81bf-0137ca176ee0" - } - }, - { - "title": "Successful SendDataIntegrationEvent for processheader event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.processheader", - "data": "{\"process_id\": \"process-id-test-123\" }", - "eventGroupId": "processHeaderId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "564130eb-2d8a-4550-a768-ddf0daf7b4a9" - } - }, - { - "title": "Successful SendDataIntegrationEvent for processoperation event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.processoperation", - "data": "{\"process_operation_id\": \"process-operation-id-test-123\", \"process_id\": \"process-id-test-123\" }", - "eventGroupId": "processOperationId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "db5df408-89c7-4b9f-a326-016f6c2b3396" - } - }, - { - "title": "Successful SendDataIntegrationEvent for processproduct event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.processproduct", - "data": "{\"process_product_id\": \"process-product-id-test-123\", \"process_id\": \"process-id-test-123\" }", - "eventGroupId": "processProductId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "6929b275-485e-4035-a798-99077ca6d669" - } - }, - { - "title": "Successful SendDataIntegrationEvent for reservation event type", - "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.reservation", - "data": "{\"reservation_id\": \"reservation-id-test-123\", \"reservation_detail_id\": \"reservation-detail-id-test-123\" }", - "eventGroupId": "reservationId", - "eventTimestamp": 1.515531081123E9 - }, - "output": { - "eventId": "f6c55a8b-fde2-44f6-848a-9b4336c77209" - } - }, - { - "title": "Successful SendDataIntegrationEvent for shipment event type", + "title": "Successful UpdateDataIntegrationFlow for s3 to dataset flow to update SQL transformation", "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.shipment", - "data": "{\"id\": \"shipment-id-test-123\", \"supplier_tpartner_id\": \"supplier-tpartner-id-test-123\", \"product_id\": \"product-id-test-123\", \"order_id\": \"order-id-test-123\", \"order_line_id\": \"order-line-id-test-123\", \"package_id\": \"package-id-test-123\" }", - "eventGroupId": "shipmentId", - "eventTimestamp": 1.515531081123E9 + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow", + "sources": [ + { + "sourceType": "S3", + "sourceName": "testSourceName", + "s3Source": { + "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f", + "prefix": "example-prefix" + } + } + ], + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT connection_id, bukrs AS id, txtmd AS description FROM testSourceName WHERE langu = 'E'" + } + }, + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset" + } + } }, "output": { - "eventId": "61d079d8-3f56-49bb-b35a-c0271a4e4f0a" + "flow": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "testStagingFlow", + "sources": [ + { + "sourceType": "S3", + "sourceName": "testSourceName", + "s3Source": { + "bucketName": "aws-supply-chain-data-b8c7bb28-a576-4334-b481-6d6e8e47371f", + "prefix": "example-prefix" + } + } + ], + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset" + } + }, + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT connection_id, bukrs AS id, txtmd AS description FROM testSourceName WHERE langu = 'E'" + } + }, + "createdTime": 1.72495640044E9, + "lastModifiedTime": 1.73245640577E9 + } } }, { - "title": "Successful SendDataIntegrationEvent for shipmentstop event type", + "title": "Successful UpdateDataIntegrationFlow for dataset to dataset flow to update sources", "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.shipmentstop", - "data": "{\"shipment_stop_id\": \"shipment-stop-id-test-123\", \"shipment_id\": \"shipment-id-test-123\" }", - "eventGroupId": "shipmentStopId", - "eventTimestamp": 1.515531081123E9 + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "trading-partner", + "sources": [ + { + "sourceType": "DATASET", + "sourceName": "testSourceName1", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1" + } + }, + { + "sourceType": "DATASET", + "sourceName": "testSourceName2", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2_updated" + } + } + ], + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT S1.id AS id, S1.poc_org_unit_description AS description, S1.company_id AS company_id, S1.tpartner_type AS tpartner_type, S1.geo_id AS geo_id, S1.eff_start_date AS eff_start_date, S1.eff_end_date AS eff_end_date FROM testSourceName1 AS S1 LEFT JOIN testSourceName2 as S2 ON S1.id=S2.id" + } + }, + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + } + } }, "output": { - "eventId": "3610992a-fc2f-4da4-9beb-724994622ba1" + "flow": { + "instanceId": "8850c54e-e187-4fa7-89d4-6370f165174d", + "name": "trading-partner", + "sources": [ + { + "sourceType": "DATASET", + "sourceName": "testSourceName1", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset1" + } + }, + { + "sourceType": "DATASET", + "sourceName": "testSourceName2", + "datasetSource": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/default/datasets/my_staging_dataset2_updated" + } + } + ], + "transformation": { + "transformationType": "SQL", + "sqlTransformation": { + "query": "SELECT S1.id AS id, S1.poc_org_unit_description AS description, S1.company_id AS company_id, S1.tpartner_type AS tpartner_type, S1.geo_id AS geo_id, S1.eff_start_date AS eff_start_date, S1.eff_end_date AS eff_end_date FROM testSourceName1 AS S1 LEFT JOIN testSourceName2 as S2 ON S1.id=S2.id" + } + }, + "target": { + "targetType": "DATASET", + "datasetTarget": { + "datasetIdentifier": "arn:aws:scn:us-east-1:123456789012:instance/8850c54e-e187-4fa7-89d4-6370f165174d/namespaces/asc/datasets/trading_partner" + } + }, + "createdTime": 1.72495640044E9, + "lastModifiedTime": 1.73245640577E9 + } } - }, + } + ], + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/api/data-integration/instance/{instanceId}/data-integration-flows/{name}" + } + } + }, + "com.amazonaws.supplychain#UpdateDataIntegrationFlowRequest": { + "type": "structure", + "members": { + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowName", + "traits": { + "smithy.api#documentation": "

The name of the DataIntegrationFlow to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sources": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowSourceList", + "traits": { + "smithy.api#documentation": "

The new source configurations for the DataIntegrationFlow.

" + } + }, + "transformation": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTransformation", + "traits": { + "smithy.api#documentation": "

The new transformation configurations for the DataIntegrationFlow.

" + } + }, + "target": { + "target": "com.amazonaws.supplychain#DataIntegrationFlowTarget", + "traits": { + "smithy.api#documentation": "

The new target configurations for the DataIntegrationFlow.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request parameters for UpdateDataIntegrationFlow.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.supplychain#UpdateDataIntegrationFlowResponse": { + "type": "structure", + "members": { + "flow": { + "target": "com.amazonaws.supplychain#DataIntegrationFlow", + "traits": { + "smithy.api#documentation": "

The details of the updated DataIntegrationFlow.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response parameters for UpdateDataIntegrationFlow.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.supplychain#UpdateDataLakeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#UpdateDataLakeDatasetRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#UpdateDataLakeDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a data lake dataset.

", + "smithy.api#examples": [ { - "title": "Successful SendDataIntegrationEvent for shipmentstoporder event type", + "title": "Update description of an existing AWS Supply Chain inbound order dataset", "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.shipmentstoporder", - "data": "{\"shipment_stop_order_id\": \"shipment-stop-order-id-test-123\", \"shipment_stop_id\": \"shipment-stop-id-test-123\", \"shipment_id\": \"shipment-id-test-123\" }", - "eventGroupId": "shipmentStopOrderId", - "eventTimestamp": 1.515531081123E9 + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order", + "description": "This is an updated AWS Supply Chain inbound order dataset" }, "output": { - "eventId": "1d550a60-9321-4d25-a132-9dd4b2d9e934" + "dataset": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/asc/datasets/inbound_order", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "asc", + "name": "inbound_order", + "description": "This is an updated AWS Supply Chain inbound order dataset", + "createdTime": 1.727116807751E9, + "lastModifiedTime": 1.727117453568E9, + "schema": { + "name": "InboundOrder", + "fields": [ + { + "name": "id", + "type": "STRING", + "isRequired": true + }, + { + "name": "tpartner_id", + "type": "STRING", + "isRequired": true + }, + { + "name": "connection_id", + "type": "STRING", + "isRequired": true + }, + { + "name": "order_type", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_status", + "type": "STRING", + "isRequired": false + }, + { + "name": "inbound_order_url", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_creation_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "company_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "to_site_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "order_currency_uom", + "type": "STRING", + "isRequired": false + }, + { + "name": "vendor_currency_uom", + "type": "STRING", + "isRequired": false + }, + { + "name": "exchange_rate", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "exchange_rate_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "incoterm", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm2", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm_location_1", + "type": "STRING", + "isRequired": false + }, + { + "name": "incoterm_location_2", + "type": "STRING", + "isRequired": false + }, + { + "name": "submitted_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "agreement_start_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "agreement_end_date", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "shipping_instr_code", + "type": "STRING", + "isRequired": false + }, + { + "name": "payment_terms_code", + "type": "STRING", + "isRequired": false + }, + { + "name": "std_terms_agreement", + "type": "STRING", + "isRequired": false + }, + { + "name": "std_terms_agreement_ver", + "type": "STRING", + "isRequired": false + }, + { + "name": "agreement_number", + "type": "STRING", + "isRequired": false + }, + { + "name": "source", + "type": "STRING", + "isRequired": false + }, + { + "name": "source_update_dttm", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "source_event_id", + "type": "STRING", + "isRequired": false + }, + { + "name": "db_creation_dttm", + "type": "TIMESTAMP", + "isRequired": false + }, + { + "name": "db_updation_dttm", + "type": "TIMESTAMP", + "isRequired": false + } + ] + } + } } }, { - "title": "Successful SendDataIntegrationEvent for supplyplan event type", + "title": "Update description of an existing custom dataset", "input": { - "instanceId": "8928ae12-15e5-4441-825d-ec2184f0a43a", - "eventType": "scn.data.supplyplan", - "data": "{\"supply_plan_id\": \"supply-plan-id-test-123\" }", - "eventGroupId": "supplyPlanId", - "eventTimestamp": 1.515531081123E9 + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset", + "description": "This is an updated custom dataset" }, "output": { - "eventId": "9abaee56-5dc4-4c31-8250-3206a651d8a1" + "dataset": { + "arn": "arn:aws:scn:us-east-1:012345678910:instance/1877dd20-dee9-4639-8e99-cb67acf21fe5/namespaces/default/datasets/my_dataset", + "instanceId": "1877dd20-dee9-4639-8e99-cb67acf21fe5", + "namespace": "default", + "name": "my_dataset", + "description": "This is an updated custom dataset", + "createdTime": 1.727116807751E9, + "lastModifiedTime": 1.727117453568E9, + "schema": { + "name": "MyDataset", + "fields": [ + { + "name": "id", + "type": "INT", + "isRequired": true + }, + { + "name": "description", + "type": "STRING", + "isRequired": true + }, + { + "name": "price", + "type": "DOUBLE", + "isRequired": false + }, + { + "name": "creation_time", + "type": "TIMESTAMP", + "isRequired": false + } + ] + } + } } } ], "smithy.api#http": { "code": 200, - "method": "POST", - "uri": "/api-data/data-integration/instance/{instanceId}/data-integration-events" - }, - "smithy.api#idempotent": {} + "method": "PATCH", + "uri": "/api/datalake/instance/{instanceId}/namespaces/{namespace}/datasets/{name}" + } } }, - "com.amazonaws.supplychain#SendDataIntegrationEventRequest": { + "com.amazonaws.supplychain#UpdateDataLakeDatasetRequest": { "type": "structure", "members": { "instanceId": { "target": "com.amazonaws.supplychain#UUID", "traits": { - "smithy.api#documentation": "

The AWS Supply Chain instance identifier.

", + "smithy.api#documentation": "

The Amazon Web Services Chain instance identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "eventType": { - "target": "com.amazonaws.supplychain#DataIntegrationEventType", - "traits": { - "smithy.api#documentation": "

The data event type.

", - "smithy.api#required": {} - } - }, - "data": { - "target": "com.amazonaws.supplychain#DataIntegrationEventData", + "namespace": { + "target": "com.amazonaws.supplychain#DataLakeDatasetNamespace", "traits": { - "smithy.api#documentation": "

The data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain\n .

", + "smithy.api#documentation": "

The name space of the dataset. The available values are:

\n ", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "eventGroupId": { - "target": "com.amazonaws.supplychain#DataIntegrationEventGroupId", + "name": { + "target": "com.amazonaws.supplychain#DataLakeDatasetName", "traits": { - "smithy.api#documentation": "

Event identifier (for example, orderId for InboundOrder) used for data sharing or partitioning.

", + "smithy.api#documentation": "

The name of the dataset. For asc name space, the name must be one of the supported data entities under https://docs.aws.amazon.com/aws-supply-chain/latest/userguide/data-model-asc.html.

", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "eventTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The event timestamp (in epoch seconds).

", - "smithy.api#timestampFormat": "epoch-seconds" - } - }, - "clientToken": { - "target": "com.amazonaws.supplychain#ClientToken", + "description": { + "target": "com.amazonaws.supplychain#DataLakeDatasetDescription", "traits": { - "smithy.api#documentation": "

The idempotent client token.

", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "

The updated description of the data lake dataset.

" } } }, "traits": { - "smithy.api#documentation": "

The request parameters for SendDataIntegrationEvent.

", + "smithy.api#documentation": "

The request parameters of UpdateDataLakeDataset.

", "smithy.api#input": {} } }, - "com.amazonaws.supplychain#SendDataIntegrationEventResponse": { + "com.amazonaws.supplychain#UpdateDataLakeDatasetResponse": { "type": "structure", "members": { - "eventId": { - "target": "com.amazonaws.supplychain#UUID", + "dataset": { + "target": "com.amazonaws.supplychain#DataLakeDataset", "traits": { - "smithy.api#documentation": "

The unique event identifier.

", + "smithy.api#documentation": "

The updated dataset details.

", + "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The response parameters for SendDataIntegrationEvent.

", + "smithy.api#documentation": "

The response parameters of UpdateDataLakeDataset.

", "smithy.api#output": {} } }, - "com.amazonaws.supplychain#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } + "com.amazonaws.supplychain#UpdateInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.supplychain#UpdateInstanceRequest" + }, + "output": { + "target": "com.amazonaws.supplychain#UpdateInstanceResponse" }, + "errors": [ + { + "target": "com.amazonaws.supplychain#AccessDeniedException" + }, + { + "target": "com.amazonaws.supplychain#InternalServerException" + }, + { + "target": "com.amazonaws.supplychain#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.supplychain#ThrottlingException" + }, + { + "target": "com.amazonaws.supplychain#ValidationException" + } + ], "traits": { - "smithy.api#documentation": "

Request would cause a service quota to be exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 + "smithy.api#documentation": "

Update the instance.

", + "smithy.api#examples": [ + { + "title": "Successful UpdateInstance request", + "input": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "instanceName": "updated example instance name", + "instanceDescription": "updated example instance description" + }, + "output": { + "instance": { + "instanceId": "9e193580-7cc5-45f7-9609-c43ba0ada793", + "awsAccountId": "123456789012", + "state": "Active", + "createdTime": 172615383136, + "lastModifiedTime": 172615383136, + "instanceName": "updated example instance name", + "instanceDescription": "updated example instance description", + "kmsKeyArn": "arn:aws:kms:us-west-2:123456789012:key/b14ffc39-b7d4-45ab-991a-6257a7f0d24d", + "versionNumber": 2.0 + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/api/instance/{instanceId}" + } } }, - "com.amazonaws.supplychain#ThrottlingException": { + "com.amazonaws.supplychain#UpdateInstanceRequest": { "type": "structure", "members": { - "message": { - "target": "smithy.api#String" + "instanceId": { + "target": "com.amazonaws.supplychain#UUID", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance identifier.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "instanceName": { + "target": "com.amazonaws.supplychain#InstanceName", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance name.

" + } + }, + "instanceDescription": { + "target": "com.amazonaws.supplychain#InstanceDescription", + "traits": { + "smithy.api#documentation": "

The AWS Supply Chain instance description.

" + } } }, "traits": { - "smithy.api#documentation": "

Request was denied due to request throttling.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429, - "smithy.api#retryable": { - "throttling": true - } + "smithy.api#documentation": "

The request parameters for UpdateInstance.

", + "smithy.api#input": {} } }, - "com.amazonaws.supplychain#UUID": { - "type": "string", + "com.amazonaws.supplychain#UpdateInstanceResponse": { + "type": "structure", + "members": { + "instance": { + "target": "com.amazonaws.supplychain#Instance", + "traits": { + "smithy.api#documentation": "

The instance resource data details.

", + "smithy.api#nestedProperties": {}, + "smithy.api#required": {} + } + } + }, "traits": { - "smithy.api#length": { - "min": 36, - "max": 36 - }, - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + "smithy.api#documentation": "

The response parameters for UpdateInstance.

", + "smithy.api#output": {} } }, "com.amazonaws.supplychain#ValidationException": { diff --git a/codegen/sdk/aws-models/timestream-influxdb.json b/codegen/sdk/aws-models/timestream-influxdb.json index e75ee836497..b7ca551f5c9 100644 --- a/codegen/sdk/aws-models/timestream-influxdb.json +++ b/codegen/sdk/aws-models/timestream-influxdb.json @@ -939,6 +939,13 @@ "traits": { "smithy.api#documentation": "

A list of key-value pairs to associate with the DB instance.

" } + }, + "port": { + "target": "com.amazonaws.timestreaminfluxdb#Port", + "traits": { + "smithy.api#default": 8086, + "smithy.api#documentation": "

The port number on which InfluxDB accepts connections.

\n

Valid Values: 1024-65535

\n

Default: 8086

\n

Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680

" + } } }, "traits": { @@ -986,6 +993,12 @@ "smithy.api#documentation": "

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

" } }, + "port": { + "target": "com.amazonaws.timestreaminfluxdb#Port", + "traits": { + "smithy.api#documentation": "

The port number on which InfluxDB accepts connections. The default value is 8086.

" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -1212,7 +1225,7 @@ "min": 3, "max": 40 }, - "smithy.api#pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" } }, "com.amazonaws.timestreaminfluxdb#DbInstanceResource": { @@ -1282,6 +1295,12 @@ "smithy.api#documentation": "

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

" } }, + "port": { + "target": "com.amazonaws.timestreaminfluxdb#Port", + "traits": { + "smithy.api#documentation": "

The port number on which InfluxDB accepts connections.

" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -1397,7 +1416,7 @@ "min": 3, "max": 64 }, - "smithy.api#pattern": "^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" } }, "com.amazonaws.timestreaminfluxdb#DbParameterGroupResource": { @@ -1577,6 +1596,12 @@ "smithy.api#documentation": "

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

" } }, + "port": { + "target": "com.amazonaws.timestreaminfluxdb#Port", + "traits": { + "smithy.api#documentation": "

The port number on which InfluxDB accepts connections.

" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -1672,6 +1697,60 @@ } } }, + "com.amazonaws.timestreaminfluxdb#Duration": { + "type": "structure", + "members": { + "durationType": { + "target": "com.amazonaws.timestreaminfluxdb#DurationType", + "traits": { + "smithy.api#documentation": "

The type of duration for InfluxDB parameters.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The value of duration for InfluxDB parameters.

", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Duration for InfluxDB parameters in Timestream for InfluxDB.

" + } + }, + "com.amazonaws.timestreaminfluxdb#DurationType": { + "type": "enum", + "members": { + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hours" + } + }, + "MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "minutes" + } + }, + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "seconds" + } + }, + "MILLISECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "milliseconds" + } + } + } + }, "com.amazonaws.timestreaminfluxdb#GetDbInstance": { "type": "operation", "input": { @@ -1757,6 +1836,12 @@ "smithy.api#documentation": "

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

" } }, + "port": { + "target": "com.amazonaws.timestreaminfluxdb#Port", + "traits": { + "smithy.api#documentation": "

The port number on which InfluxDB accepts connections.

" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -1977,6 +2062,228 @@ "traits": { "smithy.api#documentation": "

Disable the HTTP /metrics endpoint which exposes internal InfluxDB metrics.

\n

Default: false

" } + }, + "httpIdleTimeout": { + "target": "com.amazonaws.timestreaminfluxdb#Duration", + "traits": { + "smithy.api#documentation": "

Maximum duration the server should keep established connections alive while waiting for new requests. Set to 0 for no timeout.

\n

Default: 3 minutes

" + } + }, + "httpReadHeaderTimeout": { + "target": "com.amazonaws.timestreaminfluxdb#Duration", + "traits": { + "smithy.api#documentation": "

Maximum duration the server should try to read HTTP headers for new requests. Set to 0 for no timeout.

\n

Default: 10 seconds

" + } + }, + "httpReadTimeout": { + "target": "com.amazonaws.timestreaminfluxdb#Duration", + "traits": { + "smithy.api#documentation": "

Maximum duration the server should try to read the entirety of new requests. Set to 0 for no timeout.

\n

Default: 0

" + } + }, + "httpWriteTimeout": { + "target": "com.amazonaws.timestreaminfluxdb#Duration", + "traits": { + "smithy.api#documentation": "

Maximum duration the server should spend processing and responding to write requests. Set to 0 for no timeout.

\n

Default: 0

" + } + }, + "influxqlMaxSelectBuckets": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Maximum number of group by time buckets a SELECT statement can create. 0 allows an unlimited number of buckets.

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "influxqlMaxSelectPoint": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Maximum number of points a SELECT statement can process. 0 allows an unlimited number of points. InfluxDB checks the point count every second (so queries exceeding the maximum aren’t immediately aborted).

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "influxqlMaxSelectSeries": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Maximum number of series a SELECT statement can return. 0 allows an unlimited number of series.

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "pprofDisabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Disable the /debug/pprof HTTP endpoint. This endpoint provides runtime profiling data and can be helpful when debugging.

\n

Default: false

" + } + }, + "queryInitialMemoryBytes": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Initial bytes of memory allocated for a query.

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "queryMaxMemoryBytes": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Maximum number of queries allowed in execution queue. When queue limit is reached, new queries are rejected. Setting to 0 allows an unlimited number of queries in the queue.

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "queryMemoryBytes": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Maximum bytes of memory allowed for a single query. Must be greater or equal to queryInitialMemoryBytes.

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "sessionLength": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Specifies the Time to Live (TTL) in minutes for newly created user sessions.

\n

Default: 60

", + "smithy.api#range": { + "min": 1, + "max": 2880 + } + } + }, + "sessionRenewDisabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Disables automatically extending a user’s session TTL on each request. By default, every request sets the session’s expiration time to five minutes from now. When disabled, sessions expire after the specified session length and the user is redirected to the login page, even if recently active.

\n

Default: false

" + } + }, + "storageCacheMaxMemorySize": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Maximum size (in bytes) a shard’s cache can reach before it starts rejecting writes. Must be greater than storageCacheSnapShotMemorySize and lower than instance’s total memory capacity. We recommend setting it to below 15% of the total memory capacity.

\n

Default: 1073741824

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "storageCacheSnapshotMemorySize": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Size (in bytes) at which the storage engine will snapshot the cache and write it to a TSM file to make more memory available. Must not be greater than storageCacheMaxMemorySize.

\n

Default: 26214400

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "storageCacheSnapshotWriteColdDuration": { + "target": "com.amazonaws.timestreaminfluxdb#Duration", + "traits": { + "smithy.api#documentation": "

Duration at which the storage engine will snapshot the cache and write it to a new TSM file if the shard hasn’t received writes or deletes.

\n

Default: 10 minutes

" + } + }, + "storageCompactFullWriteColdDuration": { + "target": "com.amazonaws.timestreaminfluxdb#Duration", + "traits": { + "smithy.api#documentation": "

Duration at which the storage engine will compact all TSM files in a shard if it hasn't received writes or deletes.

\n

Default: 4 hours

" + } + }, + "storageCompactThroughputBurst": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Rate limit (in bytes per second) that TSM compactions can write to disk.

\n

Default: 50331648

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "storageMaxConcurrentCompactions": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Maximum number of full and level compactions that can run concurrently. A value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater than zero limits compactions to that value. This setting does not apply to cache snapshotting.

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 64 + } + } + }, + "storageMaxIndexLogFileSize": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Size (in bytes) at which an index write-ahead log (WAL) file will compact into an index file. Lower sizes will cause log files to be compacted more quickly and result in lower heap usage at the expense of write throughput.

\n

Default: 1048576

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "storageNoValidateFieldSize": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Skip field size validation on incoming write requests.

\n

Default: false

" + } + }, + "storageRetentionCheckInterval": { + "target": "com.amazonaws.timestreaminfluxdb#Duration", + "traits": { + "smithy.api#documentation": "

Interval of retention policy enforcement checks. Must be greater than 0.

\n

Default: 30 minutes

" + } + }, + "storageSeriesFileMaxConcurrentSnapshotCompactions": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Maximum number of snapshot compactions that can run concurrently across all series partitions in a database.

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 64 + } + } + }, + "storageSeriesIdSetCacheSize": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Size of the internal cache used in the TSI index to store previously calculated series results. Cached results are returned quickly rather than needing to be recalculated when a subsequent query with the same tag key/value predicate is executed. Setting this value to 0 will disable the cache and may decrease query performance.

\n

Default: 100

", + "smithy.api#range": { + "min": 0, + "max": 1000000000000 + } + } + }, + "storageWalMaxConcurrentWrites": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Maximum number writes to the WAL directory to attempt at the same time. Setting this value to 0 results in number of processing units available x2.

\n

Default: 0

", + "smithy.api#range": { + "min": 0, + "max": 256 + } + } + }, + "storageWalMaxWriteDelay": { + "target": "com.amazonaws.timestreaminfluxdb#Duration", + "traits": { + "smithy.api#documentation": "

Maximum amount of time a write request to the WAL directory will wait when the maximum number of concurrent active writes to the WAL directory has been met. Set to 0 to disable the timeout.

\n

Default: 10 minutes

" + } + }, + "uiDisabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Disable the InfluxDB user interface (UI). The UI is enabled by default.

\n

Default: false

" + } } }, "traits": { @@ -2193,7 +2500,21 @@ } }, "traits": { - "smithy.api#input": {} + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.timestreaminfluxdb#DbInstanceResource", + "ids": { + "dbInstanceIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.timestreaminfluxdb#DbParameterGroupResource", + "ids": { + "dbParameterGroupIdentifier": "resourceArn" + } + } + ] } }, "com.amazonaws.timestreaminfluxdb#ListTagsForResourceResponse": { @@ -2299,6 +2620,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.timestreaminfluxdb#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1024, + "max": 65535 + } + } + }, "com.amazonaws.timestreaminfluxdb#RequestTagMap": { "type": "map", "key": { @@ -2523,7 +2853,21 @@ } }, "traits": { - "smithy.api#input": {} + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.timestreaminfluxdb#DbInstanceResource", + "ids": { + "dbInstanceIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.timestreaminfluxdb#DbParameterGroupResource", + "ids": { + "dbParameterGroupIdentifier": "resourceArn" + } + } + ] } }, "com.amazonaws.timestreaminfluxdb#TagValue": { @@ -2619,7 +2963,21 @@ } }, "traits": { - "smithy.api#input": {} + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.timestreaminfluxdb#DbInstanceResource", + "ids": { + "dbInstanceIdentifier": "resourceArn" + } + }, + { + "resource": "com.amazonaws.timestreaminfluxdb#DbParameterGroupResource", + "ids": { + "dbParameterGroupIdentifier": "resourceArn" + } + } + ] } }, "com.amazonaws.timestreaminfluxdb#UpdateDbInstance": { @@ -2681,6 +3039,12 @@ "smithy.api#documentation": "

The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

" } }, + "port": { + "target": "com.amazonaws.timestreaminfluxdb#Port", + "traits": { + "smithy.api#documentation": "

The port number on which InfluxDB accepts connections.

\n

If you change the Port value, your database restarts immediately.

\n

Valid Values: 1024-65535

\n

Default: 8086

\n

Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680

" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { @@ -2739,6 +3103,12 @@ "smithy.api#documentation": "

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

" } }, + "port": { + "target": "com.amazonaws.timestreaminfluxdb#Port", + "traits": { + "smithy.api#documentation": "

The port number on which InfluxDB accepts connections.

" + } + }, "dbInstanceType": { "target": "com.amazonaws.timestreaminfluxdb#DbInstanceType", "traits": { diff --git a/codegen/sdk/aws-models/transcribe-streaming.json b/codegen/sdk/aws-models/transcribe-streaming.json index aba0f389cca..aaba2505c66 100644 --- a/codegen/sdk/aws-models/transcribe-streaming.json +++ b/codegen/sdk/aws-models/transcribe-streaming.json @@ -108,7 +108,7 @@ } }, "traits": { - "smithy.api#documentation": "

One or more arguments to the StartStreamTranscription, \n StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription \n operation was not valid. For example, MediaEncoding or LanguageCode \n used not valid values. Check the specified parameters and try your request again.

", + "smithy.api#documentation": "

One or more arguments to the StartStreamTranscription, \n StartMedicalStreamTranscription, or StartCallAnalyticsStreamTranscription \n operation was not valid. For example, MediaEncoding or LanguageCode \n used unsupported values. Check the specified parameters and try your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -317,7 +317,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains detailed information about your Call Analytics streaming session. These details are \n provided in the UtteranceEvent and CategoryEvent objects.

", + "smithy.api#documentation": "

Contains detailed information about your real-time Call Analytics session. These details are \n provided in the UtteranceEvent and CategoryEvent objects.

", "smithy.api#streaming": {} } }, @@ -421,7 +421,7 @@ "PostCallAnalyticsSettings": { "target": "com.amazonaws.transcribestreaming#PostCallAnalyticsSettings", "traits": { - "smithy.api#documentation": "

Provides additional optional settings for your Call Analytics post-call request, including \n encryption and output locations for your redacted and unredacted transcript.

" + "smithy.api#documentation": "

Provides additional optional settings for your Call Analytics post-call request, including \n encryption and output locations for your redacted transcript.

\n

\n PostCallAnalyticsSettings provides you with the same insights as a \n Call Analytics post-call transcription. Refer to Post-call analytics for more information \n on this feature.

" } } }, @@ -732,16 +732,256 @@ "smithy.api#enumValue": "zh-CN" } }, + "TH_TH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "th-TH" + } + }, + "ES_ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es-ES" + } + }, + "AR_SA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ar-SA" + } + }, + "PT_PT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pt-PT" + } + }, + "CA_ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-ES" + } + }, + "AR_AE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ar-AE" + } + }, "HI_IN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "hi-IN" } }, - "TH_TH": { + "ZH_HK": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "th-TH" + "smithy.api#enumValue": "zh-HK" + } + }, + "NL_NL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nl-NL" + } + }, + "NO_NO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "no-NO" + } + }, + "SV_SE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sv-SE" + } + }, + "PL_PL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pl-PL" + } + }, + "FI_FI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fi-FI" + } + }, + "ZH_TW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zh-TW" + } + }, + "EN_IN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-IN" + } + }, + "EN_IE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-IE" + } + }, + "EN_NZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-NZ" + } + }, + "EN_AB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-AB" + } + }, + "EN_ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-ZA" + } + }, + "EN_WL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "en-WL" + } + }, + "DE_CH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "de-CH" + } + }, + "AF_ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-ZA" + } + }, + "EU_ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-ES" + } + }, + "HR_HR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hr-HR" + } + }, + "CS_CZ": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cs-CZ" + } + }, + "DA_DK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "da-DK" + } + }, + "FA_IR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fa-IR" + } + }, + "GL_ES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gl-ES" + } + }, + "EL_GR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "el-GR" + } + }, + "HE_IL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "he-IL" + } + }, + "ID_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "id-ID" + } + }, + "LV_LV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lv-LV" + } + }, + "MS_MY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ms-MY" + } + }, + "RO_RO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ro-RO" + } + }, + "RU_RU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ru-RU" + } + }, + "SR_RS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sr-RS" + } + }, + "SK_SK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sk-SK" + } + }, + "SO_SO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "so-SO" + } + }, + "TL_PH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tl-PH" + } + }, + "UK_UA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "uk-UA" + } + }, + "VI_VN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "vi-VN" + } + }, + "ZU_ZA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "zu-ZA" } } } @@ -1200,12 +1440,12 @@ "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribestreaming#String", "traits": { - "smithy.api#documentation": "

The KMS key you want to use to encrypt your Call Analytics post-call\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

Note that the user making the request must\n have permission to use the specified KMS key.

" + "smithy.api#documentation": "

The KMS key you want to use to encrypt your Call Analytics post-call\n output.

\n

If using a key located in the current\n Amazon Web Services account, you can specify your KMS key in one of four\n ways:

\n
    \n
  1. \n

    Use the KMS key ID itself. For example,\n 1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use an alias for the KMS key ID. For example,\n alias/ExampleAlias.

    \n
    3. \n
  3. \n

    Use the Amazon Resource Name (ARN) for the KMS key ID. For\n example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    4. \n
  4. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    5. \n
\n

If using a key located in a different\n Amazon Web Services account than the current Amazon Web Services account, you can specify\n your KMS key in one of two ways:

\n
    \n
  1. \n

    Use the ARN for the KMS key ID. For example,\n arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    \n
    2. \n
  2. \n

    Use the ARN for the KMS key alias. For example,\n arn:aws:kms:region:account-ID:alias/ExampleAlias.

    \n
    3. \n
\n

Note that the role making the \n request must have permission to use the specified KMS key.

" } } }, "traits": { - "smithy.api#documentation": "

Allows you to specify additional settings for your streaming Call Analytics \n post-call request, including output locations for your redacted and unredacted \n transcript, which IAM role to use, and, optionally, which encryption key to \n use.

\n

\n ContentRedactionOutput, DataAccessRoleArn, and\n OutputLocation are required fields.

" + "smithy.api#documentation": "

Allows you to specify additional settings for your Call Analytics post-call request, \n including output locations for your redacted transcript, which IAM role to use, \n and which encryption key to use.

\n

\n DataAccessRoleArn and OutputLocation are required \n fields.

\n

\n PostCallAnalyticsSettings provides you with the same insights as a \n Call Analytics post-call transcription. Refer to Post-call analytics for more information \n on this feature.

" } }, "com.amazonaws.transcribestreaming#RequestId": { @@ -1412,7 +1652,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribestreaming#CallAnalyticsLanguageCode", "traits": { - "smithy.api#documentation": "

Specify the language code that represents the language spoken in your audio.

\n

If you're unsure of the language spoken in your audio, consider using \n IdentifyLanguage to enable automatic language identification.

\n

For a list of languages supported with streaming Call Analytics, refer to the \n Supported \n languages table.

", + "smithy.api#documentation": "

Specify the language code that represents the language spoken in your audio.

\n

For a list of languages supported with real-time Call Analytics, refer to the \n Supported \n languages table.

", "smithy.api#httpHeader": "x-amzn-transcribe-language-code", "smithy.api#required": {} } @@ -1443,13 +1683,14 @@ "SessionId": { "target": "com.amazonaws.transcribestreaming#SessionId", "traits": { - "smithy.api#documentation": "

Specify a name for your Call Analytics transcription session. If you don't include this parameter\n in your request, Amazon Transcribe generates an ID and returns it in the response.

\n

You can use a session ID to retry a streaming session.

", + "smithy.api#documentation": "

Specify a name for your Call Analytics transcription session. If you don't include this parameter\n in your request, Amazon Transcribe generates an ID and returns it in the response.

", "smithy.api#httpHeader": "x-amzn-transcribe-session-id" } }, "AudioStream": { "target": "com.amazonaws.transcribestreaming#AudioStream", "traits": { + "smithy.api#documentation": "

An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket \n data frames.

\n

For more information, see Transcribing streaming audio.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -1493,21 +1734,21 @@ "ContentIdentificationType": { "target": "com.amazonaws.transcribestreaming#ContentIdentificationType", "traits": { - "smithy.api#documentation": "

Labels all personally identifiable information (PII) identified in your transcript.

\n

Content identification is performed at the segment level; PII specified in \n PiiEntityTypes is flagged upon complete transcription of an audio segment.

\n

You can’t set ContentIdentificationType and ContentRedactionType\n in the same request. If you set both, your request returns a\n BadRequestException.

\n

For more information, see Redacting or identifying personally identifiable\n information.

", + "smithy.api#documentation": "

Labels all personally identifiable information (PII) identified in your transcript.

\n

Content identification is performed at the segment level; PII specified in \n PiiEntityTypes is flagged upon complete transcription of an audio segment. If you don't\n include PiiEntityTypes in your request, all PII is identified.

\n

You can’t set ContentIdentificationType and ContentRedactionType\n in the same request. If you set both, your request returns a\n BadRequestException.

\n

For more information, see Redacting or identifying personally identifiable\n information.

", "smithy.api#httpHeader": "x-amzn-transcribe-content-identification-type" } }, "ContentRedactionType": { "target": "com.amazonaws.transcribestreaming#ContentRedactionType", "traits": { - "smithy.api#documentation": "

Redacts all personally identifiable information (PII) identified in your transcript.

\n

Content redaction is performed at the segment level; PII specified in \n PiiEntityTypes is redacted upon complete transcription of an audio segment.

\n

You can’t set ContentRedactionType and ContentIdentificationType\n in the same request. If you set both, your request returns a\n BadRequestException.

\n

For more information, see Redacting or identifying personally identifiable\n information.

", + "smithy.api#documentation": "

Redacts all personally identifiable information (PII) identified in your transcript.

\n

Content redaction is performed at the segment level; PII specified in \n PiiEntityTypes is redacted upon complete transcription of an audio segment. If you don't\n include PiiEntityTypes in your request, all PII is redacted.

\n

You can’t set ContentRedactionType and ContentIdentificationType\n in the same request. If you set both, your request returns a BadRequestException.

\n

For more information, see Redacting or identifying personally identifiable\n information.

", "smithy.api#httpHeader": "x-amzn-transcribe-content-redaction-type" } }, "PiiEntityTypes": { "target": "com.amazonaws.transcribestreaming#PiiEntityTypes", "traits": { - "smithy.api#documentation": "

Specify which types of personally identifiable information (PII) you want to redact in your \n transcript. You can include as many types as you'd like, or you can select \n ALL.

\n

To include PiiEntityTypes in your Call Analytics request, you must also include \n either ContentIdentificationType or ContentRedactionType.

\n

Values must be comma-separated and can include:\n BANK_ACCOUNT_NUMBER, BANK_ROUTING,\n CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, \n CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, \n SSN, or ALL.

", + "smithy.api#documentation": "

Specify which types of personally identifiable information (PII) you want to redact in your \n transcript. You can include as many types as you'd like, or you can select \n ALL.

\n

Values must be comma-separated and can include: ADDRESS, \n BANK_ACCOUNT_NUMBER, BANK_ROUTING,\n CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY,\n CREDIT_DEBIT_NUMBER, EMAIL, \n NAME, PHONE, PIN, \n SSN, or ALL.

\n

Note that if you include PiiEntityTypes in your request, you must also include \n ContentIdentificationType or ContentRedactionType.

\n

If you include ContentRedactionType or \n ContentIdentificationType in your request, but do not include \n PiiEntityTypes, all PII is redacted or identified.

", "smithy.api#httpHeader": "x-amzn-transcribe-pii-entity-types" } } @@ -1522,7 +1763,7 @@ "RequestId": { "target": "com.amazonaws.transcribestreaming#RequestId", "traits": { - "smithy.api#documentation": "

Provides the identifier for your Call Analytics streaming request.

", + "smithy.api#documentation": "

Provides the identifier for your real-time Call Analytics request.

", "smithy.api#httpHeader": "x-amzn-request-id" } }, @@ -1564,7 +1805,7 @@ "CallAnalyticsTranscriptResultStream": { "target": "com.amazonaws.transcribestreaming#CallAnalyticsTranscriptResultStream", "traits": { - "smithy.api#documentation": "

Provides detailed information about your Call Analytics streaming session.

", + "smithy.api#documentation": "

Provides detailed information about your real-time Call Analytics session.

", "smithy.api#httpPayload": {} } }, @@ -1725,7 +1966,7 @@ "SessionId": { "target": "com.amazonaws.transcribestreaming#SessionId", "traits": { - "smithy.api#documentation": "

Specify a name for your transcription session. If you don't include this parameter in \n your request, Amazon Transcribe Medical generates an ID and returns it in the\n response.

\n

You can use a session ID to retry a streaming session.

", + "smithy.api#documentation": "

Specify a name for your transcription session. If you don't include this parameter in \n your request, Amazon Transcribe Medical generates an ID and returns it in the\n response.

", "smithy.api#httpHeader": "x-amzn-transcribe-session-id" } }, @@ -1740,14 +1981,14 @@ "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then appends\n the output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio is \n transcribed in a continuous manner and your transcript is not separated by channel.

\n

For more information, see Transcribing multi-channel audio.

", + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then appends\n the output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio is \n transcribed in a continuous manner and your transcript is not separated by channel.

\n

If you include EnableChannelIdentification in your request, you must also \n include NumberOfChannels.

\n

For more information, see Transcribing multi-channel audio.

", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, "NumberOfChannels": { "target": "com.amazonaws.transcribestreaming#NumberOfChannels", "traits": { - "smithy.api#documentation": "

Specify the number of channels in your audio stream. Up to two channels are\n supported.

", + "smithy.api#documentation": "

Specify the number of channels in your audio stream. This value must be \n 2, as only two channels are supported. If your audio doesn't contain \n multiple channels, do not include this parameter in your request.

\n

If you include NumberOfChannels in your request, you must also \n include EnableChannelIdentification.

", "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" } }, @@ -1934,7 +2175,7 @@ "SessionId": { "target": "com.amazonaws.transcribestreaming#SessionId", "traits": { - "smithy.api#documentation": "

Specify a name for your transcription session. If you don't include this parameter in your request, \n Amazon Transcribe generates an ID and returns it in the response.

\n

You can use a session ID to retry a streaming session.

", + "smithy.api#documentation": "

Specify a name for your transcription session. If you don't include this parameter in your request, \n Amazon Transcribe generates an ID and returns it in the response.

", "smithy.api#httpHeader": "x-amzn-transcribe-session-id" } }, @@ -1972,14 +2213,14 @@ "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then appends the \n output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio is \n transcribed in a continuous manner and your transcript is not separated by channel.

\n

For more information, see Transcribing multi-channel audio.

", + "smithy.api#documentation": "

Enables channel identification in multi-channel audio.

\n

Channel identification transcribes the audio on each channel independently, then appends the \n output for each channel into one transcript.

\n

If you have multi-channel audio and do not enable channel identification, your audio is \n transcribed in a continuous manner and your transcript is not separated by channel.

\n

If you include EnableChannelIdentification in your request, you must also \n include NumberOfChannels.

\n

For more information, see Transcribing multi-channel audio.

", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, "NumberOfChannels": { "target": "com.amazonaws.transcribestreaming#NumberOfChannels", "traits": { - "smithy.api#documentation": "

Specify the number of channels in your audio stream. Up to two channels are\n supported.

", + "smithy.api#documentation": "

Specify the number of channels in your audio stream. This value must be \n 2, as only two channels are supported. If your audio doesn't contain \n multiple channels, do not include this parameter in your request.

\n

If you include NumberOfChannels in your request, you must also \n include EnableChannelIdentification.

", "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" } }, @@ -2001,21 +2242,21 @@ "ContentIdentificationType": { "target": "com.amazonaws.transcribestreaming#ContentIdentificationType", "traits": { - "smithy.api#documentation": "

Labels all personally identifiable information (PII) identified in your transcript.

\n

Content identification is performed at the segment level; PII specified in \n PiiEntityTypes is flagged upon complete transcription of an audio segment.

\n

You can’t set ContentIdentificationType and ContentRedactionType\n in the same request. If you set both, your request returns a\n BadRequestException.

\n

For more information, see Redacting or identifying personally identifiable\n information.

", + "smithy.api#documentation": "

Labels all personally identifiable information (PII) identified in your transcript.

\n

Content identification is performed at the segment level; PII specified in \n PiiEntityTypes is flagged upon complete transcription of an audio segment. If you don't\n include PiiEntityTypes in your request, all PII is identified.

\n

You can’t set ContentIdentificationType and ContentRedactionType\n in the same request. If you set both, your request returns a\n BadRequestException.

\n

For more information, see Redacting or identifying personally identifiable\n information.

", "smithy.api#httpHeader": "x-amzn-transcribe-content-identification-type" } }, "ContentRedactionType": { "target": "com.amazonaws.transcribestreaming#ContentRedactionType", "traits": { - "smithy.api#documentation": "

Redacts all personally identifiable information (PII) identified in your transcript.

\n

Content redaction is performed at the segment level; PII specified in \n PiiEntityTypes is redacted upon complete transcription of an audio segment.

\n

You can’t set ContentRedactionType and ContentIdentificationType\n in the same request. If you set both, your request returns a\n BadRequestException.

\n

For more information, see Redacting or identifying personally identifiable\n information.

", + "smithy.api#documentation": "

Redacts all personally identifiable information (PII) identified in your transcript.

\n

Content redaction is performed at the segment level; PII specified in \n PiiEntityTypes is redacted upon complete transcription of an audio segment. If you don't\n include PiiEntityTypes in your request, all PII is redacted.

\n

You can’t set ContentRedactionType and ContentIdentificationType\n in the same request. If you set both, your request returns a BadRequestException.

\n

For more information, see Redacting or identifying personally identifiable\n information.

", "smithy.api#httpHeader": "x-amzn-transcribe-content-redaction-type" } }, "PiiEntityTypes": { "target": "com.amazonaws.transcribestreaming#PiiEntityTypes", "traits": { - "smithy.api#documentation": "

Specify which types of personally identifiable information (PII) you want to redact in your \n transcript. You can include as many types as you'd like, or you can select \n ALL.

\n

To include PiiEntityTypes in your request, you must also include either \n ContentIdentificationType or ContentRedactionType.

\n

Values must be comma-separated and can include:\n BANK_ACCOUNT_NUMBER, BANK_ROUTING,\n CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, \n CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, \n SSN, or ALL.

", + "smithy.api#documentation": "

Specify which types of personally identifiable information (PII) you want to redact in your \n transcript. You can include as many types as you'd like, or you can select \n ALL.

\n

Values must be comma-separated and can include: ADDRESS, \n BANK_ACCOUNT_NUMBER, BANK_ROUTING,\n CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY,\n CREDIT_DEBIT_NUMBER, EMAIL, \n NAME, PHONE, PIN, \n SSN, or ALL.

\n

Note that if you include PiiEntityTypes in your request, you must also include \n ContentIdentificationType or ContentRedactionType.

\n

If you include ContentRedactionType or \n ContentIdentificationType in your request, but do not include \n PiiEntityTypes, all PII is redacted or identified.

", "smithy.api#httpHeader": "x-amzn-transcribe-pii-entity-types" } }, @@ -2030,14 +2271,14 @@ "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Enables automatic language identification for your transcription.

\n

If you include IdentifyLanguage, you can optionally include a list of \n language codes, using LanguageOptions, that you think may be present in \n your audio stream. Including language options can improve transcription accuracy.

\n

You can also include a preferred language using PreferredLanguage. Adding a \n preferred language can help Amazon Transcribe identify the language faster than if you omit this \n parameter.

\n

If you have multi-channel audio that contains different languages on each channel, and you've \n enabled channel identification, automatic language identification identifies the dominant language on \n each audio channel.

\n

Note that you must include either LanguageCode or \n IdentifyLanguage or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job\n fails.

\n

Streaming language identification can't be combined with custom language models or \n redaction.

", + "smithy.api#documentation": "

Enables automatic language identification for your transcription.

\n

If you include IdentifyLanguage, you must include a list of\n language codes, using LanguageOptions, that you think may be present in \n your audio stream.

\n

You can also include a preferred language using PreferredLanguage. Adding a \n preferred language can help Amazon Transcribe identify the language faster than if you omit this \n parameter.

\n

If you have multi-channel audio that contains different languages on each channel, and you've \n enabled channel identification, automatic language identification identifies the dominant language on \n each audio channel.

\n

Note that you must include either LanguageCode or \n IdentifyLanguage or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job\n fails.

\n

Streaming language identification can't be combined with custom language models or \n redaction.

", "smithy.api#httpHeader": "x-amzn-transcribe-identify-language" } }, "LanguageOptions": { "target": "com.amazonaws.transcribestreaming#LanguageOptions", "traits": { - "smithy.api#documentation": "

Specify two or more language codes that represent the languages you think may be present \n in your media; including more than five is not recommended. If you're unsure what languages are present, do\n not include this parameter.

\n

Including language options can improve the accuracy of language identification.

\n

If you include LanguageOptions in your request, you must also include \n IdentifyLanguage.

\n

For a list of languages supported with Amazon Transcribe streaming, refer to the \n Supported \n languages table.

\n \n

You can only include one language dialect per language per stream. For example, you\n cannot include en-US and en-AU in the same request.

\n ", + "smithy.api#documentation": "

Specify two or more language codes that represent the languages you think may be present \n in your media; including more than five is not recommended.

\n

Including language options can improve the accuracy of language identification.

\n

If you include LanguageOptions in your request, you must also include \n IdentifyLanguage or IdentifyMultipleLanguages.

\n

For a list of languages supported with Amazon Transcribe streaming, refer to the \n Supported \n languages table.

\n \n

You can only include one language dialect per language per stream. For example, you\n cannot include en-US and en-AU in the same request.

\n ", "smithy.api#httpHeader": "x-amzn-transcribe-language-options" } }, @@ -2052,7 +2293,7 @@ "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.

\n

If you include IdentifyMultipleLanguages, you can optionally include a list of language codes, using LanguageOptions, that you think may be present in your stream. Including LanguageOptions restricts IdentifyMultipleLanguages to only the language options that you specify, which can improve transcription accuracy.

\n

If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include VocabularyNames or VocabularyFilterNames.

\n

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

", + "smithy.api#documentation": "

Enables automatic multi-language identification in your transcription job request. Use this parameter if your stream contains more than one language. If your stream contains only one language, use IdentifyLanguage instead.

\n

If you include IdentifyMultipleLanguages, you must include a list of language codes, using LanguageOptions, that you think may be present in your stream.

\n

If you want to apply a custom vocabulary or a custom vocabulary filter to your automatic multiple language identification request, include VocabularyNames or VocabularyFilterNames.

\n

Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.

", "smithy.api#httpHeader": "x-amzn-transcribe-identify-multiple-languages" } }, @@ -2153,7 +2394,7 @@ "target": "com.amazonaws.transcribestreaming#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Shows whether channel identification was enabled for your transcription.

", + "smithy.api#documentation": "

Shows whether channel identification was enabled for your transcription.

", "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" } }, diff --git a/codegen/sdk/aws-models/transfer.json b/codegen/sdk/aws-models/transfer.json index 9ae16fbdda8..d14a5802192 100644 --- a/codegen/sdk/aws-models/transfer.json +++ b/codegen/sdk/aws-models/transfer.json @@ -431,6 +431,52 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.transfer#ConnectorFileTransferResult": { + "type": "structure", + "members": { + "FilePath": { + "target": "com.amazonaws.transfer#FilePath", + "traits": { + "smithy.api#documentation": "

The filename and path to where the file was sent to or retrieved from.

", + "smithy.api#required": {} + } + }, + "StatusCode": { + "target": "com.amazonaws.transfer#TransferTableStatus", + "traits": { + "smithy.api#documentation": "

The current status for the transfer.

", + "smithy.api#required": {} + } + }, + "FailureCode": { + "target": "com.amazonaws.transfer#FailureCode", + "traits": { + "smithy.api#documentation": "

For transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND\n

" + } + }, + "FailureMessage": { + "target": "com.amazonaws.transfer#Message", + "traits": { + "smithy.api#documentation": "

For transfers that fail, this parameter describes the reason for the failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the details for files transferred using an SFTP connector, during a single transfer.

" + } + }, + "com.amazonaws.transfer#ConnectorFileTransferResults": { + "type": "list", + "member": { + "target": "com.amazonaws.transfer#ConnectorFileTransferResult" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, "com.amazonaws.transfer#ConnectorId": { "type": "string", "traits": { @@ -698,7 +744,7 @@ "BaseDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

The landing directory (folder) for files transferred by using the AS2 protocol.

\n

A BaseDirectory example is\n /DOC-EXAMPLE-BUCKET/home/mydirectory.

", + "smithy.api#documentation": "

The landing directory (folder) for files transferred by using the AS2 protocol.

\n

A BaseDirectory example is\n /amzn-s3-demo-bucket/home/mydirectory.

", "smithy.api#required": {} } }, @@ -3669,7 +3715,7 @@ } }, "traits": { - "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your file\n transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server\n and resources only within your VPC. To control incoming internet traffic, invoke the\n UpdateServer API and attach an Elastic IP address to your server's\n endpoint.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n " + "smithy.api#documentation": "

The virtual private cloud (VPC) endpoint settings that are configured for your file\n transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server\n and resources only within your VPC. To control incoming internet traffic, invoke the\n UpdateServer API and attach an Elastic IP address to your server's\n endpoint.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n

It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

\n " } }, "com.amazonaws.transfer#EndpointType": { @@ -3880,6 +3926,9 @@ "smithy.api#pattern": "^S-1-[\\d-]+$" } }, + "com.amazonaws.transfer#FailureCode": { + "type": "string" + }, "com.amazonaws.transfer#FileLocation": { "type": "structure", "members": { @@ -4879,6 +4928,97 @@ "smithy.api#output": {} } }, + "com.amazonaws.transfer#ListFileTransferResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.transfer#ListFileTransferResultsRequest" + }, + "output": { + "target": "com.amazonaws.transfer#ListFileTransferResultsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transfer#InternalServiceError" + }, + { + "target": "com.amazonaws.transfer#InvalidRequestException" + }, + { + "target": "com.amazonaws.transfer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.transfer#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Returns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. \n You specify the file transfer by providing its ConnectorId and its TransferId.

\n \n

File transfer results are available up to 7 days after an operation has been requested.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/listFileTransferResults" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FileTransferResults", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.transfer#ListFileTransferResultsRequest": { + "type": "structure", + "members": { + "ConnectorId": { + "target": "com.amazonaws.transfer#ConnectorId", + "traits": { + "smithy.api#documentation": "

A unique identifier for a connector. This value should match the value supplied to the corresponding StartFileTransfer call.

", + "smithy.api#required": {} + } + }, + "TransferId": { + "target": "com.amazonaws.transfer#TransferId", + "traits": { + "smithy.api#documentation": "

A unique identifier for a file transfer. This value should match the value supplied to the corresponding StartFileTransfer call.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "

If there are more file details than returned in this call, use this value for a subsequent call to ListFileTransferResults to retrieve them.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.transfer#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of files to return in a single page. Note that currently you can specify a maximum of 10 file paths in a single\n StartFileTransfer operation. Thus, the maximum\n number of file transfer results that can be returned in a single page is 10.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.transfer#ListFileTransferResultsResponse": { + "type": "structure", + "members": { + "FileTransferResults": { + "target": "com.amazonaws.transfer#ConnectorFileTransferResults", + "traits": { + "smithy.api#documentation": "

Returns the details for the files transferred in the transfer identified by the TransferId and ConnectorId specified.

\n
    \n
  • \n

    \n FilePath: the filename and path to where the file was sent to or retrieved from.

    \n
    • \n
  • \n

    \n StatusCode: current status for the transfer. The status returned is one of the following values:QUEUED,\n IN_PROGRESS, COMPLETED, or FAILED\n

    \n
    • \n
  • \n

    \n FailureCode: for transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND\n

    \n
    • \n
  • \n

    \n FailureMessage: for transfers that fail, this parameter describes the reason for the failure.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.transfer#NextToken", + "traits": { + "smithy.api#documentation": "

Returns a token that you can use to call ListFileTransferResults again and receive\n additional results, if there are any (against the same TransferId.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.transfer#ListHostKeys": { "type": "operation", "input": { @@ -7244,7 +7384,7 @@ "SendFilePaths": { "target": "com.amazonaws.transfer#FilePaths", "traits": { - "smithy.api#documentation": "

One or more source paths for the Amazon S3 storage. Each string represents a source\n file path for one outbound file transfer. For example,\n \n DOC-EXAMPLE-BUCKET/myfile.txt\n .

\n \n

Replace \n DOC-EXAMPLE-BUCKET\n with one of your actual buckets.

\n " + "smithy.api#documentation": "

One or more source paths for the Amazon S3 storage. Each string represents a source\n file path for one outbound file transfer. For example,\n \n amzn-s3-demo-bucket/myfile.txt\n .

\n \n

Replace \n amzn-s3-demo-bucket\n with one of your actual buckets.

\n " } }, "RetrieveFilePaths": { @@ -7851,6 +7991,9 @@ { "target": "com.amazonaws.transfer#ListExecutions" }, + { + "target": "com.amazonaws.transfer#ListFileTransferResults" + }, { "target": "com.amazonaws.transfer#ListHostKeys" }, @@ -7930,7 +8073,7 @@ "name": "transfer" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Transfer Family is a fully managed service that enables the transfer of files over the File\n Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File\n Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.\n Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.\n Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating\n with existing authentication systems, and providing DNS routing with Amazon Route 53 so\n nothing changes for your customers and partners, or their applications. With your data in\n Amazon S3, you can use it with Amazon Web Services for processing, analytics, machine learning, and\n archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and\n set up.

", + "smithy.api#documentation": "

Transfer Family is a fully managed service that enables the transfer of files over the File\n Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File\n Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3) or Amazon EFS.\n Additionally, you can use Applicability Statement 2 (AS2) to transfer files into and out of Amazon S3.\n Amazon Web Services helps you seamlessly migrate your file transfer workflows to Transfer Family by integrating\n with existing authentication systems, and providing DNS routing with Amazon Route 53 so\n nothing changes for your customers and partners, or their applications. With your data in\n Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning, and\n archiving. Getting started with Transfer Family is easy since there is no infrastructure to buy and\n set up.

", "smithy.api#title": "AWS Transfer Family", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -8913,6 +9056,35 @@ } } }, + "com.amazonaws.transfer#TransferTableStatus": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, "com.amazonaws.transfer#UntagResource": { "type": "operation", "input": { @@ -9153,7 +9325,7 @@ "BaseDirectory": { "target": "com.amazonaws.transfer#HomeDirectory", "traits": { - "smithy.api#documentation": "

To change the landing directory (folder) for files that are transferred, provide the\n bucket folder that you want to use; for example,\n /DOC-EXAMPLE-BUCKET/home/mydirectory\n .

" + "smithy.api#documentation": "

To change the landing directory (folder) for files that are transferred, provide the\n bucket folder that you want to use; for example,\n /amzn-s3-demo-bucket/home/mydirectory\n .

" } }, "AccessRole": { @@ -9611,7 +9783,7 @@ "EndpointType": { "target": "com.amazonaws.transfer#EndpointType", "traits": { - "smithy.api#documentation": "

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n

It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

\n " + "smithy.api#documentation": "

The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC)\n or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and \n resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.

\n \n

After May 19, 2021, you won't be able to create a server using\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account if your account hasn't already\n done so before May 19, 2021. If you have already created servers with\n EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May 19, 2021,\n you will not be affected. After this date, use\n EndpointType=VPC.

\n

For more information, see\n https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.

\n

It is recommended that you use VPC as the EndpointType. With\n this endpoint type, you have the option to directly associate up to three Elastic IPv4\n addresses (BYO IP included) with your server's endpoint and use VPC security groups to\n restrict traffic by the client's public IP address. This is not possible with\n EndpointType set to VPC_ENDPOINT.

\n " } }, "HostKey": { @@ -9975,13 +10147,13 @@ "OnUpload": { "target": "com.amazonaws.transfer#OnUploadWorkflowDetails", "traits": { - "smithy.api#documentation": "

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

\n

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

\n

\n aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'\n

" + "smithy.api#documentation": "

A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.

\n

To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.

\n

\n aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{\"OnUpload\":[]}'\n

\n \n

\n OnUpload can contain a maximum of one WorkflowDetail object.

\n " } }, "OnPartialUpload": { "target": "com.amazonaws.transfer#OnPartialUploadWorkflowDetails", "traits": { - "smithy.api#documentation": "

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server\n that executes whenever there is a partial upload.

\n

A partial upload occurs when a file is open when the session disconnects.

" + "smithy.api#documentation": "

A trigger that starts a workflow if a file is only partially uploaded. You can attach a workflow to a server\n that executes whenever there is a partial upload.

\n

A partial upload occurs when a file is open when the session disconnects.

\n \n

\n OnPartialUpload can contain a maximum of one WorkflowDetail object.

\n " } } }, diff --git a/codegen/sdk/aws-models/verifiedpermissions.json b/codegen/sdk/aws-models/verifiedpermissions.json index dfcd3abd407..01f3eb95e57 100644 --- a/codegen/sdk/aws-models/verifiedpermissions.json +++ b/codegen/sdk/aws-models/verifiedpermissions.json @@ -151,6 +151,163 @@ "name": "IsAuthorized" }, "smithy.api#documentation": "

Makes a series of decisions about multiple authorization requests for one principal or\n resource. Each request contains the equivalent content of an IsAuthorized\n request: principal, action, resource, and context. Either the principal or\n the resource parameter must be identical across all requests. For example,\n Verified Permissions won't evaluate a pair of requests where bob views\n photo1 and alice views photo2. Authorization\n of bob to view photo1 and photo2, or\n bob and alice to view photo1, are valid\n batches.

\n

The request is evaluated against all policies in the specified policy store that match the\n entities that you declare. The result of the decisions is a series of Allow\n or Deny responses, along with the IDs of the policies that produced each\n decision.

\n

The entities of a BatchIsAuthorized API request can contain\n up to 100 principals and up to 100 resources. The requests of a\n BatchIsAuthorized API request can contain up to 30 requests.

\n \n

The BatchIsAuthorized operation doesn't have its own IAM\n permission. To authorize this operation for Amazon Web Services principals, include the permission\n verifiedpermissions:IsAuthorized in their IAM policies.

\n ", + "smithy.api#examples": [ + { + "title": "Batch - Example 1", + "documentation": "The following example requests two authorization decisions for two principals of type Usernamed Alice and Annalisa.", + "input": { + "requests": [ + { + "principal": { + "entityType": "PhotoFlash::User", + "entityId": "Alice" + }, + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "ViewPhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + } + }, + { + "principal": { + "entityType": "PhotoFlash::User", + "entityId": "Annalisa" + }, + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "DeletePhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + } + } + ], + "entities": { + "entityList": [ + { + "identifier": { + "entityType": "PhotoFlash::User", + "entityId": "Alice" + }, + "attributes": { + "Account": { + "entityIdentifier": { + "entityType": "PhotoFlash::Account", + "entityId": "1234" + } + }, + "Email": { + "string": "" + } + }, + "parents": [] + }, + { + "identifier": { + "entityType": "PhotoFlash::User", + "entityId": "Annalisa" + }, + "attributes": { + "Account": { + "entityIdentifier": { + "entityType": "PhotoFlash::Account", + "entityId": "5678" + } + }, + "Email": { + "string": "" + } + }, + "parents": [] + }, + { + "identifier": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + }, + "attributes": { + "IsPrivate": { + "boolean": false + }, + "Name": { + "string": "" + } + }, + "parents": [ + { + "entityType": "PhotoFlash::Account", + "entityId": "1234" + } + ] + }, + { + "identifier": { + "entityType": "PhotoFlash::Account", + "entityId": "1234" + }, + "attributes": { + "Name": { + "string": "" + } + }, + "parents": [] + } + ] + }, + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "results": [ + { + "request": { + "principal": { + "entityType": "PhotoFlash::User", + "entityId": "alice" + }, + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "ViewPhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + } + }, + "decision": "ALLOW", + "determiningPolicies": [ + { + "policyId": "9wYxMpljbbZQb5fcZHyJhY" + } + ], + "errors": [] + }, + { + "request": { + "principal": { + "entityType": "PhotoFlash::User", + "entityId": "annalisa" + }, + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "DeletePhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + } + }, + "decision": "DENY", + "determiningPolicies": [], + "errors": [] + } + ] + } + } + ], "smithy.api#readonly": {} } }, @@ -301,6 +458,137 @@ "name": "IsAuthorizedWithToken" }, "smithy.api#documentation": "

Makes a series of decisions about multiple authorization requests for one token. The\n principal in this request comes from an external identity source in the form of an identity or\n access token, formatted as a JSON\n web token (JWT). The information in the parameters can also define\n additional context that Verified Permissions can include in the evaluations.

\n

The request is evaluated against all policies in the specified policy store that match the\n entities that you provide in the entities declaration and in the token. The result of\n the decisions is a series of Allow or Deny responses, along\n with the IDs of the policies that produced each decision.

\n

The entities of a BatchIsAuthorizedWithToken API request can\n contain up to 100 resources and up to 99 user groups. The requests of a\n BatchIsAuthorizedWithToken API request can contain up to 30\n requests.

\n \n

The BatchIsAuthorizedWithToken operation doesn't have its own\n IAM permission. To authorize this operation for Amazon Web Services principals, include the\n permission verifiedpermissions:IsAuthorizedWithToken in their IAM\n policies.

\n ", + "smithy.api#examples": [ + { + "title": "Batch - Example 1", + "documentation": "The following example requests three authorization decisions for two resources and two actions in different photo albums.", + "input": { + "identityToken": "eyJra12345EXAMPLE", + "requests": [ + { + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "ViewPhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + } + }, + { + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "SharePhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + } + }, + { + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "ViewPhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "OfficePhoto94.jpg" + } + } + ], + "entities": { + "entityList": [ + { + "identifier": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + }, + "parents": [ + { + "entityType": "PhotoFlash::Album", + "entityId": "MyExampleAlbum1" + } + ] + }, + { + "identifier": { + "entityType": "PhotoFlash::Photo", + "entityId": "OfficePhoto94.jpg" + }, + "parents": [ + { + "entityType": "PhotoFlash::Album", + "entityId": "MyExampleAlbum2" + } + ] + } + ] + }, + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "principal": { + "entityType": "PhotoFlash::User", + "entityId": "us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + }, + "results": [ + { + "request": { + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "ViewPhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + } + }, + "decision": "ALLOW", + "determiningPolicies": [ + { + "policyId": "9wYixMplbbZQb5fcZHyJhY" + } + ], + "errors": [] + }, + { + "request": { + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "SharePhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "VacationPhoto94.jpg" + } + }, + "decision": "ALLOW", + "determiningPolicies": [ + { + "policyId": "9wYixMplbbZQb5fcZHyJhY" + } + ], + "errors": [] + }, + { + "request": { + "action": { + "actionType": "PhotoFlash::Action", + "actionId": "ViewPhoto" + }, + "resource": { + "entityType": "PhotoFlash::Photo", + "entityId": "OfficePhoto94.jpg" + } + }, + "decision": "DENY", + "determiningPolicies": [], + "errors": [] + } + ] + } + } + ], "smithy.api#readonly": {} } }, @@ -754,7 +1042,32 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create a reference to an external identity provider (IdP) that is compatible with OpenID Connect (OIDC) authentication protocol, such as Amazon Cognito" }, - "smithy.api#documentation": "

Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect\n (OIDC) identity provider (IdP).\n

\n

After you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken or\n BatchIsAuthorizedWithToken API operations. These identities take the form\n of tokens that contain claims about the user, such as IDs, attributes and group\n memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions\n derives information about your user and session from token claims. Access tokens provide\n action context to your policies, and ID tokens provide principal\n Attributes.

\n \n

Tokens from an identity source user continue to be usable until they expire. \n Token revocation and resource deletion have no effect on the validity of a token in your policy store

\n \n \n

To reference a user from this identity source in your Cedar policies, refer to the\n following syntax examples.

\n
    \n
  • \n

    Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user\n principal attribute], for example\n MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

    \n
    • \n
  • \n

    OpenID Connect (OIDC) provider: Namespace::[Entity\n type]::[principalIdClaim]|[user principal attribute], for example\n MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

    \n
    • \n
\n \n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#documentation": "

Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect\n (OIDC) identity provider (IdP).\n

\n

After you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken or\n BatchIsAuthorizedWithToken API operations. These identities take the form\n of tokens that contain claims about the user, such as IDs, attributes and group\n memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions\n derives information about your user and session from token claims. Access tokens provide\n action context to your policies, and ID tokens provide principal\n Attributes.

\n \n

Tokens from an identity source user continue to be usable until they expire. \n Token revocation and resource deletion have no effect on the validity of a token in your policy store

\n \n \n

To reference a user from this identity source in your Cedar policies, refer to the\n following syntax examples.

\n
    \n
  • \n

    Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user\n principal attribute], for example\n MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

    \n
    • \n
  • \n

    OpenID Connect (OIDC) provider: Namespace::[Entity\n type]::[entityIdPrefix]|[user principal attribute], for example\n MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

    \n
    • \n
\n \n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "To create an identity source", + "documentation": "The following ``create-identity-source`` example creates an identity source that lets you reference identities stored in the specified Amazon Cognito user pool. Those identities are available in Verified Permissions as entities of type ``User``. ", + "input": { + "configuration": { + "cognitoUserPoolConfiguration": { + "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5", + "clientIds": [ + "a1b2c3d4e5f6g7h8i9j0kalbmc" + ] + } + }, + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "principalEntityType": "User", + "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111" + }, + "output": { + "createdDate": "2024-08-12T18:20:50.99Z", + "identitySourceId": "ISEXAMPLEabcdefg111111", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + } + } + ], "smithy.api#idempotent": {} } }, @@ -853,6 +1166,98 @@ "documentation": "Grants permission to create a Cedar policy and save it in the specified policy store" }, "smithy.api#documentation": "

Creates a Cedar policy and saves it in the specified policy store. You can create either a\n static policy or a policy linked to a policy template.

\n
    \n
  • \n

    To create a static policy, provide the Cedar policy text in the\n StaticPolicy section of the\n PolicyDefinition.

    \n
    • \n
  • \n

    To create a policy that is dynamically linked to a policy template, specify the policy template ID\n and the principal and resource to associate with this policy in the\n templateLinked section of the PolicyDefinition. If the\n policy template is ever updated, any policies linked to the policy template automatically use the\n updated template.

    \n
    • \n
\n \n

Creating a policy causes it to be validated against the schema in the policy store. If the\n policy doesn't pass validation, the operation fails and the policy isn't\n stored.

\n \n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "To create a static policy", + "documentation": "The following example request creates a static policy with a policy scope that specifies both a principal and a resource. The response includes both the Principal and Resource elements because both were specified in the request policy scope.", + "input": { + "definition": { + "static": { + "description": "Grant members of janeFriends UserGroup access to the vacationFolder Album", + "statement": "permit( principal in UserGroup::\"janeFriends\", action, resource in Album::\"vacationFolder\" );" + } + }, + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyType": "STATIC", + "principal": { + "entityId": "janeFriends", + "entityType": "UserGroup" + }, + "resource": { + "entityId": "vacationFolder", + "entityType": "Album" + } + } + }, + { + "title": "To create a static policy", + "documentation": "The following example request creates a static policy with a policy scope that specifies both a principal and a resource. The response includes both the Principal and Resource elements because both were specified in the request policy scope.", + "input": { + "definition": { + "static": { + "description": "Grant members of janeFriends UserGroup access to the vacationFolder Album", + "statement": "permit( principal in UserGroup::\"janeFriends\", action, resource in Album::\"vacationFolder\" );" + } + }, + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyType": "STATIC", + "principal": { + "entityId": "janeFriends", + "entityType": "UserGroup" + }, + "resource": { + "entityId": "vacationFolder", + "entityType": "Album" + } + } + }, + { + "title": "To create a template-linked policy", + "documentation": "The following example creates a template-linked policy using the specified policy template and associates the specified principal to use with the new template-linked policy.", + "input": { + "definition": { + "templateLinked": { + "policyTemplateId": "PTEXAMPLEabcdefg111111", + "principal": { + "entityType": "User", + "entityId": "alice" + } + } + }, + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyId": "Et9KxMplyaDdyurDw8TeFa", + "policyType": "TEMPLATE_LINKED", + "principal": { + "entityType": "User", + "entityId": "alice" + }, + "resource": { + "entityType": "Photo", + "entityId": "VacationPhoto94.jpg" + }, + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z" + } + } + ], "smithy.api#idempotent": {} } }, @@ -973,6 +1378,24 @@ "documentation": "Grants permission to create a Cedar policy and save it in the specified policy store" }, "smithy.api#documentation": "

Creates a policy store. A policy store is a container for policy resources.

\n \n

Although Cedar supports multiple namespaces, Verified Permissions currently supports only one\n namespace per policy store.

\n \n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "To create policy store", + "documentation": "The following example creates a new policy store with strict validation turned on.", + "input": { + "validationSettings": { + "mode": "STRICT" + }, + "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a", + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z" + } + } + ], "smithy.api#idempotent": {} } }, @@ -1064,6 +1487,24 @@ "documentation": "Grants permission to create a policy template" }, "smithy.api#documentation": "

Creates a policy template. A template can use placeholders for the principal and resource. A\n template must be instantiated into a policy by associating it with specific principals\n and resources to use for the placeholders. That instantiated policy can then be\n considered in authorization decisions. The instantiated policy works identically to any\n other policy, except that it is dynamically linked to the template. If the template\n changes, then any policies that are linked to that template are immediately updated as\n well.

\n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "To create a policy template", + "documentation": "The following example creates a policy template that has a placeholder for the principal.", + "input": { + "description": "Template for research dept", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "statement": "\"AccessVacation\"\npermit(\n principal in ?principal,\n action == Action::\"view\",\n resource == Photo::\"VacationPhoto94.jpg\"\n)\nwhen {\n principal has department && principal.department == \"research\"\n};", + "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyTemplateId": "PTEXAMPLEabcdefg111111", + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z" + } + } + ], "smithy.api#idempotent": {} } }, @@ -1176,6 +1617,17 @@ "documentation": "Grants permission to delete an identity source that references an identity provider (IdP) such as Amazon Cognito" }, "smithy.api#documentation": "

Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After\n you delete the identity source, you can no longer use tokens for identities from that identity source to\n represent principals in authorization queries made using IsAuthorizedWithToken.\n operations.

", + "smithy.api#examples": [ + { + "title": "To delete an identity source", + "documentation": "The following example request deletes the specified identity source.", + "input": { + "identitySourceId": "ISEXAMPLEabcdefg111111", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": {} + } + ], "smithy.api#idempotent": {} } }, @@ -1229,6 +1681,17 @@ "documentation": "Grants permission to delete the specified policy from the policy store" }, "smithy.api#documentation": "

Deletes the specified policy from the policy store.

\n

This operation is idempotent; if you specify a policy that doesn't \n exist, the request response returns a successful HTTP 200 status code.

", + "smithy.api#examples": [ + { + "title": "To delete a policy", + "documentation": "The following example deletes the specified policy from its policy store.", + "input": { + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": {} + } + ], "smithy.api#idempotent": {} } }, @@ -1274,6 +1737,16 @@ "documentation": "Grants permission to delete the specified policy store" }, "smithy.api#documentation": "

Deletes the specified policy store.

\n

This operation is idempotent. If you specify a policy store that does not exist, the request\n response will still return a successful HTTP 200 status code.

", + "smithy.api#examples": [ + { + "title": "To delete a policy store", + "documentation": "The following example deletes the specified policy store.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": {} + } + ], "smithy.api#idempotent": {} } }, @@ -1320,6 +1793,17 @@ "documentation": "Grants permission to delete the specified policy template from the policy store" }, "smithy.api#documentation": "

Deletes the specified policy template from the policy store.

\n \n

This operation also deletes any policies that were created from the specified\n policy template. Those policies are immediately removed from all future API responses, and are\n asynchronously deleted from the policy store.

\n ", + "smithy.api#examples": [ + { + "title": "To delete a policy template", + "documentation": "The following example deletes a policy template. Before you can perform this operation, you must first delete any template-linked policies that were instantiated from this policy template. To delete them, use DeletePolicy.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyTemplateId": "PTEXAMPLEabcdefg111111" + }, + "output": {} + } + ], "smithy.api#idempotent": {} } }, @@ -1559,6 +2043,31 @@ "documentation": "Grants permission to retrieve the details about the specified identity source" }, "smithy.api#documentation": "

Retrieves the details about the specified identity source.

", + "smithy.api#examples": [ + { + "title": "To retrieve details about an identity source", + "documentation": "The following example retrieves the details for the specified identity source.", + "input": { + "identitySourceId": "ISEXAMPLEabcdefg111111", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "createdDate": "2024-08-12T18:20:50.99Z", + "details": { + "clientIds": [ + "a1b2c3d4e5f6g7h8i9j0kalbmc" + ], + "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5", + "discoveryUrl": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5", + "openIdIssuer": "COGNITO" + }, + "identitySourceId": "ISEXAMPLEabcdefg111111", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "principalEntityType": "AWS::Cognito" + } + } + ], "smithy.api#readonly": {} } }, @@ -1663,6 +2172,33 @@ "documentation": "Grants permission to retrieve information about the specified policy" }, "smithy.api#documentation": "

Retrieves information about the specified policy.

", + "smithy.api#examples": [ + { + "title": "To retrieve details about a policy", + "documentation": "The following example retrieves information about the specified policy contained in the specified policy store. In this example, the requested policy is a template-linked policy, so it returns the ID of the policy template, and the specific principal and resource used by this policy.", + "input": { + "policyId": "9wYixMplbbZQb5fcZHyJhY", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "policyType": "STATIC", + "resource": { + "entityId": "publicFolder", + "entityType": "Album" + }, + "definition": { + "static": { + "description": "Grant everyone of janeFriends UserGroup access to the vacationFolder Album", + "statement": "permit(principal, action, resource in Album::\"publicFolder\");" + } + }, + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z" + } + } + ], "smithy.api#readonly": {} } }, @@ -1787,6 +2323,24 @@ "documentation": "Grants permission to retrieve details about a policy store" }, "smithy.api#documentation": "

Retrieves details about a policy store.

", + "smithy.api#examples": [ + { + "title": "GetPolicyStore", + "documentation": "The following example retrieves details about the specified policy store.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a", + "validationSettings": { + "mode": "STRICT" + }, + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z" + } + } + ], "smithy.api#readonly": {} } }, @@ -1874,6 +2428,24 @@ "documentation": "Grants permission to retrieve the details for the specified policy template in the specified policy store" }, "smithy.api#documentation": "

Retrieve the details for the specified policy template in the specified policy store.

", + "smithy.api#examples": [ + { + "title": "GetPolicyTemplate", + "documentation": "The following example displays the details of the specified policy template.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyTemplateId": "PTEXAMPLEabcdefg111111" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyTemplateId": "PTEXAMPLEabcdefg111111", + "description": "Template for research dept", + "statement": "permit(\n principal ?principal,\n action == Action::\"view\",\n resource in ?resource\n) when {\n principal has department && principal.department == \"research\" \n};", + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z" + } + } + ], "smithy.api#readonly": {} } }, @@ -1968,6 +2540,21 @@ "documentation": "Grants permission to retrieve the details for the specified schema in the specified policy store" }, "smithy.api#documentation": "

Retrieve the details for the specified schema in the specified policy store.

", + "smithy.api#examples": [ + { + "title": "GetSchema", + "documentation": "The following example retrieves the current schema stored in the specified policy store.\n\nNote\nThe JSON in the parameters of this operation are strings that can contain embedded quotation marks (\") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \\\" ) and combining all lines into a single text line with no line breaks.\n\nExample strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "schema": "{\n\"My::Application\": {\n\"actions\": {\n\"remoteAccess\": {\n\"appliesTo\": {\n\"principalTypes\": [\"Employee\"]\n}\n}\n},\n\"entityTypes\": {\n\"Employee\": {\n\"shape\": {\n\"attributes\": {\n\"jobLevel\": { \"type\": \"Long\" },\n\"name\": { \"type\":\"String\" }\n},\n\"type\": \"Record\"\n}\n}\n}\n}\n }", + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z" + } + } + ], "smithy.api#readonly": {} } }, @@ -2309,6 +2896,60 @@ "documentation": "Grants permission to make an authorization decision about a service request described in the parameters" }, "smithy.api#documentation": "

Makes an authorization decision about a service request described in the parameters.\n The information in the parameters can also define additional context that Verified Permissions can\n include in the evaluation. The request is evaluated against all matching policies in the\n specified policy store. The result of the decision is either Allow or\n Deny, along with a list of the policies that resulted in the\n decision.

", + "smithy.api#examples": [ + { + "title": "IsAuthorized - Example 1", + "documentation": "The following example requests an authorization decision for a principal of type User named Alice, who wants to perform the updatePhoto operation, on a resource of type Photo named VacationPhoto94.jpg.\n\nThe response shows that the request was allowed by one policy.", + "input": { + "principal": { + "entityType": "User", + "entityId": "alice" + }, + "action": { + "actionType": "Action", + "actionId": "view" + }, + "resource": { + "entityType": "Photo", + "entityId": "VacationPhoto94.jpg" + }, + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "decision": "ALLOW", + "determiningPolicies": [ + { + "policyId": "9wYxMpljbbZQb5fcZHyJhY" + } + ], + "errors": [] + } + }, + { + "title": "IsAuthorized - Example 2", + "documentation": "The following example is the same as the previous example, except that the principal is User::\"bob\", and the policy store doesn't contain any policy that allows that user access to Album::\"alice_folder\". The output infers that the Deny was implicit because the list of DeterminingPolicies is empty.", + "input": { + "principal": { + "entityType": "User", + "entityId": "bob" + }, + "action": { + "actionType": "Action", + "actionId": "view" + }, + "resource": { + "entityType": "Photo", + "entityId": "VacationPhoto94.jpg" + }, + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "decision": "DENY", + "determiningPolicies": [], + "errors": [] + } + } + ], "smithy.api#readonly": {} } }, @@ -2403,7 +3044,34 @@ "aws.iam#iamAction": { "documentation": "Grants permission to make an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source" }, - "smithy.api#documentation": "

Makes an authorization decision about a service request described in the parameters.\n The principal in this request comes from an external identity source in the form of an identity\n token formatted as a JSON web\n token (JWT). The information in the parameters can also define additional\n context that Verified Permissions can include in the evaluation. The request is evaluated against all\n matching policies in the specified policy store. The result of the decision is either\n Allow or Deny, along with a list of the policies that\n resulted in the decision.

\n

At this time, Verified Permissions accepts tokens from only Amazon Cognito.

\n

Verified Permissions validates each token that is specified in a request by checking its expiration\n date and its signature.

\n \n

Tokens from an identity source user continue to be usable until they expire. \n Token revocation and resource deletion have no effect on the validity of a token in your policy store

\n ", + "smithy.api#documentation": "

Makes an authorization decision about a service request described in the parameters.\n The principal in this request comes from an external identity source in the form of an identity\n token formatted as a JSON web\n token (JWT). The information in the parameters can also define additional\n context that Verified Permissions can include in the evaluation. The request is evaluated against all\n matching policies in the specified policy store. The result of the decision is either\n Allow or Deny, along with a list of the policies that\n resulted in the decision.

\n

Verified Permissions validates each token that is specified in a request by checking its expiration\n date and its signature.

\n \n

Tokens from an identity source user continue to be usable until they expire. \n Token revocation and resource deletion have no effect on the validity of a token in your policy store

\n ", + "smithy.api#examples": [ + { + "title": "IsAuthorizedWithToken - Example 1", + "documentation": "The following example requests an authorization decision for a user who was authenticated by Amazon Cognito. The request uses the identity token provided by Amazon Cognito instead of the access token. In this example, the specified information store is configured to return principals as entities of type CognitoUser. The policy store contains a policy with the following statement.\n\npermit(\n principal == CognitoUser::\"us-east-1_1a2b3c4d5|a1b2c3d4e5f6g7h8i9j0kalbmc\",\n action,\n resource == Photo::\"VacationPhoto94.jpg\"\n);", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "action": { + "actionId": "View", + "actionType": "Action" + }, + "resource": { + "entityId": "vacationPhoto94.jpg", + "entityType": "Photo" + }, + "identityToken": "EgZjxMPlbWUyBggAEEUYOdIBCDM3NDlqMGo3qAIAsAIA" + }, + "output": { + "decision": "ALLOW", + "determiningPolicies": [ + { + "policyId": "9wYxMpljbbZQb5fcZHyJhY" + } + ], + "errors": [] + } + } + ], "smithy.api#readonly": {} } }, @@ -2521,6 +3189,34 @@ "documentation": "Grants permission to return a paginated list of all of the identity sources defined in the specified policy store" }, "smithy.api#documentation": "

Returns a paginated list of all of the identity sources defined in the specified policy store.

", + "smithy.api#examples": [ + { + "title": "ListIdentitySources", + "documentation": "The following example request creates lists the identity sources currently defined in the specified policy store.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "identitySources": [ + { + "createdDate": "2023-05-19T20:29:23.66812Z", + "details": { + "clientIds": [ + "a1b2c3d4e5f6g7h8i9j0kalbmc" + ], + "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5", + "discoveryUrl": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5", + "openIdIssuer": "COGNITO" + }, + "identitySourceId": "ISEXAMPLEabcdefg111111", + "lastUpdatedDate": "2023-05-19T20:29:23.66812Z", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "principalEntityType": "User" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2610,6 +3306,154 @@ "documentation": "Grants permission to return a paginated list of all policies stored in the specified policy store" }, "smithy.api#documentation": "

Returns a paginated list of all policies stored in the specified policy store.

", + "smithy.api#examples": [ + { + "title": "ListPolicies - Example 1", + "documentation": "The following example lists all policies in the policy store.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "policies": [ + { + "createdDate": "2024-08-12T18:20:50.99Z", + "definition": { + "static": { + "description": "Grant members of janeFriends UserGroup access to the vacationFolder Album" + } + }, + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyType": "STATIC", + "principal": { + "entityId": "janeFriends", + "entityType": "UserGroup" + }, + "resource": { + "entityId": "vacationFolder", + "entityType": "Album" + } + }, + { + "createdDate": "2024-08-12T18:20:50.99Z", + "definition": { + "static": { + "description": "Grant everyone access to the publicFolder Album" + } + }, + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyId": "Et9KxMplyaDdyurDw8TeFa", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyType": "STATIC", + "resource": { + "entityId": "publicFolder", + "entityType": "Album" + } + } + ] + } + }, + { + "title": "ListPolicies - Example 2", + "documentation": "The following example lists all policies for a specified principal.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "filter": { + "principal": { + "identifier": { + "entityType": "User", + "entityId": "alice" + } + } + } + }, + "output": { + "policies": [ + { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyId": "Et9KxMplyaDdyurDw8TeFa", + "policyType": "STATIC", + "principal": { + "entityType": "User", + "entityId": "alice" + }, + "resource": { + "entityType": "Album", + "entityId": "bob_folder" + }, + "definition": { + "static": { + "description": "An example policy" + } + }, + "createdDate": "2022-12-09T22:55:16.067533Z", + "lastUpdatedDate": "2022-12-09T22:55:16.067533Z" + }, + { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "policyType": "STATIC", + "principal": { + "entityType": "User", + "entityId": "alice" + }, + "resource": { + "entityType": "Album", + "entityId": "alice_folder" + }, + "definition": { + "static": {} + }, + "createdDate": "2022-12-09T23:00:24.66266Z", + "lastUpdatedDate": "2022-12-09T23:00:24.66266Z" + } + ] + } + }, + { + "title": "ListPolicies - Example 3", + "documentation": "The following example uses the Filter parameter to list only the template-linked policies in the specified policy store.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "filter": { + "policyType": "TEMPLATE_LINKED" + } + }, + "output": { + "policies": [ + { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "policyType": "TEMPLATE_LINKED", + "principal": { + "entityType": "User", + "entityId": "alice" + }, + "resource": { + "entityType": "Photo", + "entityId": "pic.jpg" + }, + "definition": { + "templateLinked": { + "policyTemplateId": "PTEXAMPLEabcdefg111111", + "principal": { + "entityType": "User", + "entityId": "alice" + }, + "resource": { + "entityType": "Photo", + "entityId": "pic.jpg" + } + } + }, + "createdDate": "2023-06-13T16:03:07.620867Z", + "lastUpdatedDate": "2023-06-13T16:03:07.620867Z" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2686,6 +3530,26 @@ "documentation": "Grants permission to return a paginated list of all policy stores in the calling Amazon Web Services account" }, "smithy.api#documentation": "

Returns a paginated list of all policy stores in the calling Amazon Web Services account.

", + "smithy.api#examples": [ + { + "title": "ListPolicyStores", + "documentation": "The following example lists all policy stores in the AWS account in the AWS Region in which you call the operation.", + "output": { + "policyStores": [ + { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a", + "createdDate": "2023-05-16T17:41:29.103459Z" + }, + { + "policyStoreId": "PSEXAMPLEabcdefg222222", + "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/PSEXAMPLEabcdefg222222", + "createdDate": "2023-05-16T18:23:04.985521Z" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2754,6 +3618,33 @@ "documentation": "Grants permission to return a paginated list of all policy templates in the specified policy store" }, "smithy.api#documentation": "

Returns a paginated list of all policy templates in the specified policy store.

", + "smithy.api#examples": [ + { + "title": "ListPolicyTemplates", + "documentation": "The following example retrieves a list of all of the policy templates in the specified policy store.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "policyTemplates": [ + { + "createdDate": "2024-08-12T18:20:50.99Z", + "description": "Generic template", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyTemplateId": "PTEXAMPLEabcdefg111111" + }, + { + "createdDate": "2024-08-12T18:20:50.99Z", + "description": "Template for research dept", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyTemplateId": "PTEXAMPLEabcdefg222222" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3395,7 +4286,7 @@ "policyType": { "target": "com.amazonaws.verifiedpermissions#PolicyType", "traits": { - "smithy.api#documentation": "

The type of the policy. This is one of the following values:

\n
    \n
  • \n

    \n static\n

    \n
    • \n
  • \n

    \n templateLinked\n

    \n
    • \n
", + "smithy.api#documentation": "

The type of the policy. This is one of the following values:

\n
    \n
  • \n

    \n STATIC\n

    \n
    • \n
  • \n

    \n TEMPLATE_LINKED\n

    \n
    • \n
", "smithy.api#required": {} } }, @@ -3748,6 +4639,26 @@ "documentation": "Grants permission to create or update the policy schema in the specified policy store" }, "smithy.api#documentation": "

Creates or updates the policy schema in the specified policy store. The schema is used to\n validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema\n validate only policies and templates submitted after the schema change. Existing\n policies and templates are not re-evaluated against the changed schema. If you later\n update a policy, then it is evaluated against the new schema at that time.

\n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "PutSchema", + "documentation": "The following example creates a new schema, or updates an existing schema, in the specified policy store. Note that the schema text is shown line wrapped for readability. You should submit the entire schema text as a single line of text.\n\nNote\nThe JSON in the parameters of this operation are strings that can contain embedded quotation marks (\") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \\\" ) and combining all lines into a single text line with no line breaks.\n\nExample strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "definition": { + "cedarJson": "{\"MySampleNamespace\": {\"actions\": {\"remoteAccess\": {\"appliesTo\": {\"principalTypes\": [\"Employee\"]}}},\"entityTypes\": {\"Employee\": {\"shape\": {\"attributes\": {\"jobLevel\": {\"type\": \"Long\"},\"name\": {\"type\": \"String\"}},\"type\": \"Record\"}}}}}" + } + }, + "output": { + "createdDate": "2023-06-13T19:28:06.003726Z", + "lastUpdatedDate": "2023-06-13T19:28:06.003726Z", + "namespaces": [ + "My::Sample::Namespace" + ], + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + } + } + ], "smithy.api#idempotent": {} } }, @@ -3927,7 +4838,7 @@ "cedarJson": { "target": "com.amazonaws.verifiedpermissions#SchemaJson", "traits": { - "smithy.api#documentation": "

A JSON string representation of the schema supported by applications that use this\n policy store. For more information, see Policy store schema in the\n Amazon Verified Permissions User Guide.

" + "smithy.api#documentation": "

A JSON string representation of the schema supported by applications that use this\n policy store. To delete the schema, run PutSchema with {} for this parameter. \n For more information, see Policy store schema in the\n Amazon Verified Permissions User Guide.

" } } }, @@ -3970,7 +4881,7 @@ "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The code for the Amazon Web Service that owns the quota.

" + "smithy.api#documentation": "

The code for the Amazon Web Services service that owns the quota.

" } }, "quotaCode": { @@ -4157,7 +5068,7 @@ "serviceCode": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The code for the Amazon Web Service that owns the quota.

" + "smithy.api#documentation": "

The code for the Amazon Web Services service that owns the quota.

" } }, "quotaCode": { @@ -4276,6 +5187,30 @@ "documentation": "Grants permission to update the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type" }, "smithy.api#documentation": "

Updates the specified identity source to use a new identity provider (IdP), or to change\n the mapping of identities from the IdP to a different principal entity type.

\n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "UpdateIdentitySource", + "documentation": "The following example updates the configuration of the specified identity source with a new configuration.", + "input": { + "identitySourceId": "ISEXAMPLEabcdefg111111", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "updateConfiguration": { + "cognitoUserPoolConfiguration": { + "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5", + "clientIds": [ + "a1b2c3d4e5f6g7h8i9j0kalbmc" + ] + } + } + }, + "output": { + "createdDate": "2023-05-19T20:30:28.173926Z", + "identitySourceId": "ISEXAMPLEabcdefg111111", + "lastUpdatedDate": "2023-05-22T20:45:59.962216Z", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a" + } + } + ], "smithy.api#idempotent": {} } }, @@ -4300,7 +5235,7 @@ "target": "com.amazonaws.verifiedpermissions#UpdateConfiguration", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.

\n \n

At this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.

\n

You must specify a userPoolArn, and optionally, a\n ClientId.

\n ", + "smithy.api#documentation": "

Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.

", "smithy.api#required": {} } }, @@ -4493,6 +5428,32 @@ "documentation": "Grants permission to modify the specified Cedar static policy in the specified policy store" }, "smithy.api#documentation": "

Modifies a Cedar static policy in the specified policy store. You can change only certain elements of\n the UpdatePolicyDefinition parameter. You can directly update only static policies. To\n change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.

\n \n
    \n
  • \n

    If policy validation is enabled in the policy store, then updating a static policy causes\n Verified Permissions to validate the policy against the schema in the policy store. If the updated\n static policy doesn't pass validation, the operation fails and the update isn't\n stored.

    \n
    • \n
  • \n

    When you edit a static policy, you can change only certain elements of a static\n policy:

    \n
      \n
    • \n

      The action referenced by the policy.

      \n
      • \n
    • \n

      A condition clause, such as when and unless.

      \n
      • \n
    \n

    You can't change these elements of a static policy:

    \n
      \n
    • \n

      Changing a policy from a static policy to a template-linked\n policy.

      \n
      • \n
    • \n

      Changing the effect of a static policy from permit or forbid.\n

      \n
      • \n
    • \n

      The principal referenced by a static policy.

      \n
      • \n
    • \n

      The resource referenced by a static policy.

      \n
      • \n
    \n
    • \n
  • \n

    To update a template-linked policy, you must update the template instead.

    \n
    • \n
\n \n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "UpdatePolicy", + "documentation": "The following example replaces the definition of the specified static policy with a new one.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "definition": { + "static": { + "statement": "permit(principal, action, resource in Album::\"public_folder\");" + } + } + }, + "output": { + "createdDate": "2024-08-12T18:20:50.99Z", + "lastUpdatedDate": "2024-08-12T18:20:50.99Z", + "policyId": "9wYxMpljbbZQb5fcZHyJhY", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyType": "STATIC", + "resource": { + "entityType": "Album", + "entityId": "public_folder" + } + } + } + ], "smithy.api#idempotent": {} } }, @@ -4628,6 +5589,24 @@ "documentation": "Grants permission to modify the validation setting for a policy store" }, "smithy.api#documentation": "

Modifies the validation setting for a policy store.

\n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "UpdatePolicyStore", + "documentation": "The following example turns off the validation settings for a policy store.", + "input": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "validationSettings": { + "mode": "OFF" + } + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a", + "createdDate": "2023-05-17T18:36:10.134448Z", + "lastUpdatedDate": "2023-05-23T18:18:12.443083Z" + } + } + ], "smithy.api#idempotent": {} } }, @@ -4716,6 +5695,24 @@ "documentation": "Grants permission to update the specified policy template" }, "smithy.api#documentation": "

Updates the specified policy template. You can update only the description and the some elements\n of the policyBody.

\n \n

Changes you make to the policy template content are immediately (within the constraints of\n eventual consistency) reflected in authorization decisions that involve all template-linked policies\n instantiated from this template.

\n \n \n

Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.

\n ", + "smithy.api#examples": [ + { + "title": "UpdatePolicyTemplate", + "documentation": "The following example updates a policy template with both a new description and a new policy body. The effect, principal, and resource are the same as the original policy template. Only the action in the head, and the when and unless clauses can be different.\n\nNote\nThe JSON in the parameters of this operation are strings that can contain embedded quotation marks (\") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \\\" ) and combining all lines into a single text line with no line breaks.\n\nExample strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.", + "input": { + "description": "My updated template description", + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyTemplateId": "PTEXAMPLEabcdefg111111", + "statement": "\"ResearchAccess\"\npermit(\nprincipal in ?principal,\naction == Action::\"view\",\nresource in ?resource\"\n)\nwhen {\nprincipal has department && principal.department == \"research\"\n};" + }, + "output": { + "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a", + "policyTemplateId": "PTEXAMPLEabcdefg111111", + "createdDate": "2023-05-17T18:58:48.795411Z", + "lastUpdatedDate": "2023-05-17T19:18:48.870209Z" + } + } + ], "smithy.api#idempotent": {} } }, diff --git a/codegen/sdk/aws-models/wafv2.json b/codegen/sdk/aws-models/wafv2.json index 1224f243f78..8b27d438d66 100644 --- a/codegen/sdk/aws-models/wafv2.json +++ b/codegen/sdk/aws-models/wafv2.json @@ -375,7 +375,7 @@ "name": "wafv2" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. You can access your old rules, web ACLs, and\n other WAF resources only through the WAF Classic APIs. The WAF Classic APIs\n have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your WAF resources to this version,\n see the WAF Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync\n GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content,\n to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code\n (Forbidden), or with a custom response.

\n

This API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and guidance for configuring and using \n WAF, see the WAF Developer\n Guide.

\n

You can make calls using the endpoints listed in WAF endpoints and quotas.

\n
    \n
  • \n

    For regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

    \n
    • \n
  • \n

    For Amazon CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.

    \n
    • \n
\n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

\n

We currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older versions,\n with the following major improvements:

\n
    \n
  • \n

    You use one API for both global and regional applications. Where you need to\n distinguish the scope, you specify a Scope parameter and set it to\n CLOUDFRONT or REGIONAL.

    \n
    • \n
  • \n

    You can define a web ACL or rule group with a single call, and update it with a\n single call. You define all rule specifications in JSON format, and pass them to your\n rule group or web ACL calls.

    \n
    • \n
  • \n

    The limits WAF places on the use of rules more closely reflects the cost of\n running each type of rule. Rule groups include capacity settings, so you know the\n maximum cost of a rule group when you use it.

    \n
    • \n
", + "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. WAF Classic support will end on September 30, 2025.

\n

For information about WAF, including how to migrate your WAF Classic resources to this version,\n see the WAF Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync\n GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content,\n to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code\n (Forbidden), or with a custom response.

\n

This API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and guidance for configuring and using \n WAF, see the WAF Developer\n Guide.

\n

You can make calls using the endpoints listed in WAF endpoints and quotas.

\n
    \n
  • \n

    For regional applications, you can use any of the endpoints in the list.\n A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

    \n
    • \n
  • \n

    For Amazon CloudFront applications, you must use the API endpoint listed for\n US East (N. Virginia): us-east-1.

    \n
    • \n
\n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

", "smithy.api#title": "AWS WAFV2", "smithy.api#xmlNamespace": { "uri": "http://waf.amazonaws.com/doc/2019-07-29/" @@ -4581,7 +4581,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes all rule groups that are managed by Firewall Manager for the specified web ACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

" + "smithy.api#documentation": "

Deletes all rule groups that are managed by Firewall Manager from the specified WebACL.

\n

You can only use this if ManagedByFirewallManager and RetrofittedByFirewallManager are both false in the web ACL.

" } }, "com.amazonaws.wafv2#DeleteFirewallManagerRuleGroupsRequest": { @@ -5006,7 +5006,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the specified\n WebACL.

\n \n

Before deleting any web ACL, first disassociate it from all resources.

\n
    \n
  • \n

    To retrieve a list of the resources that are associated with a web ACL, use the\n following calls:

    \n
      \n
    • \n

      For regional resources, call ListResourcesForWebACL.

      \n
      • \n
    • \n

      For Amazon CloudFront distributions, use the CloudFront call\n ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId \n in the Amazon CloudFront API Reference.

      \n
      • \n
    \n
    • \n
  • \n

    To disassociate a resource from a web ACL, use the following calls:

    \n
      \n
    • \n

      For regional resources, call DisassociateWebACL.

      \n
      • \n
    • \n

      For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution\n in the Amazon CloudFront API Reference.

      \n
      • \n
    \n
    • \n
\n " + "smithy.api#documentation": "

Deletes the specified WebACL.

\n

You can only use this if ManagedByFirewallManager is false in the web ACL.

\n \n

Before deleting any web ACL, first disassociate it from all resources.

\n
    \n
  • \n

    To retrieve a list of the resources that are associated with a web ACL, use the\n following calls:

    \n
      \n
    • \n

      For regional resources, call ListResourcesForWebACL.

      \n
      • \n
    • \n

      For Amazon CloudFront distributions, use the CloudFront call\n ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId \n in the Amazon CloudFront API Reference.

      \n
      • \n
    \n
    • \n
  • \n

    To disassociate a resource from a web ACL, use the following calls:

    \n
      \n
    • \n

      For regional resources, call DisassociateWebACL.

      \n
      • \n
    • \n

      For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call\n UpdateDistribution. For information, see UpdateDistribution\n in the Amazon CloudFront API Reference.

      \n
      • \n
    \n
    • \n
\n " } }, "com.amazonaws.wafv2#DeleteWebACLRequest": { @@ -8336,7 +8336,7 @@ "target": "com.amazonaws.wafv2#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether the logging configuration was created by Firewall Manager, as part of an\n WAF policy configuration. If true, only Firewall Manager can modify or delete the\n configuration.

" + "smithy.api#documentation": "

Indicates whether the logging configuration was created by Firewall Manager, as part of an\n WAF policy configuration. If true, only Firewall Manager can modify or delete the\n configuration.

\n

The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. \n Web ACLs that Firewall Manager creates and uses have their ManagedByFirewallManager property set to true. Web ACLs that were created \n by a customer account and then retrofitted by Firewall Manager for use by a policy have their RetrofittedByFirewallManager property set to true. \n For either case, any corresponding logging configuration will indicate ManagedByFirewallManager.

" } }, "LoggingFilter": { @@ -12952,7 +12952,7 @@ "target": "com.amazonaws.wafv2#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can\n delete the web ACL or any Firewall Manager rule groups in the web ACL.

" + "smithy.api#documentation": "

Indicates whether this web ACL was created by Firewall Manager and is being managed by Firewall Manager. If true, then only Firewall Manager can\n delete the web ACL or any Firewall Manager rule groups in the web ACL. \n See also the properties RetrofittedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups.

" } }, "LabelNamespace": { @@ -12990,6 +12990,13 @@ "traits": { "smithy.api#documentation": "

Specifies custom configurations for the associations between the web ACL and protected resources.

\n

Use this to customize the maximum size of the request body that your protected resources forward to WAF for inspection. You can \n customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).

\n \n

You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.

\n \n

For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).

" } + }, + "RetrofittedByFirewallManager": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether this web ACL was created by a customer account and then retrofitted by Firewall Manager. If true, then the web ACL is currently being \n managed by a Firewall Manager WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. \n See also the properties ManagedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups.

" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/worklink.json b/codegen/sdk/aws-models/worklink.json deleted file mode 100644 index fd6548f5abe..00000000000 --- a/codegen/sdk/aws-models/worklink.json +++ /dev/null @@ -1,3965 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.worklink#AcmCertificateArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*$" - } - }, - "com.amazonaws.worklink#AssociateDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#AssociateDomainRequest" - }, - "output": { - "target": "com.amazonaws.worklink#AssociateDomainResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Specifies a domain to be associated to Amazon WorkLink.

", - "smithy.api#http": { - "method": "POST", - "uri": "/associateDomain", - "code": 200 - } - } - }, - "com.amazonaws.worklink#AssociateDomainRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The fully qualified domain name (FQDN).

", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The name to display.

" - } - }, - "AcmCertificateArn": { - "target": "com.amazonaws.worklink#AcmCertificateArn", - "traits": { - "smithy.api#documentation": "

The ARN of an issued ACM certificate that is valid for the domain being associated.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#AssociateDomainResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#AssociateWebsiteAuthorizationProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#AssociateWebsiteAuthorizationProviderRequest" - }, - "output": { - "target": "com.amazonaws.worklink#AssociateWebsiteAuthorizationProviderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

", - "smithy.api#http": { - "method": "POST", - "uri": "/associateWebsiteAuthorizationProvider", - "code": 200 - } - } - }, - "com.amazonaws.worklink#AssociateWebsiteAuthorizationProviderRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "AuthorizationProviderType": { - "target": "com.amazonaws.worklink#AuthorizationProviderType", - "traits": { - "smithy.api#documentation": "

The authorization provider type.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of the authorization provider. This applies only to SAML-based\n authorization providers.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#AssociateWebsiteAuthorizationProviderResponse": { - "type": "structure", - "members": { - "AuthorizationProviderId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

A unique identifier for the authorization provider.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#AssociateWebsiteCertificateAuthority": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#AssociateWebsiteCertificateAuthorityRequest" - }, - "output": { - "target": "com.amazonaws.worklink#AssociateWebsiteCertificateAuthorityResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Imports the root certificate of a certificate authority (CA) used to obtain TLS\n certificates used by associated websites within the company network.

", - "smithy.api#http": { - "method": "POST", - "uri": "/associateWebsiteCertificateAuthority", - "code": 200 - } - } - }, - "com.amazonaws.worklink#AssociateWebsiteCertificateAuthorityRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "Certificate": { - "target": "com.amazonaws.worklink#Certificate", - "traits": { - "smithy.api#documentation": "

The root certificate of the CA.

", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The certificate name to display.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#AssociateWebsiteCertificateAuthorityResponse": { - "type": "structure", - "members": { - "WebsiteCaId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

A unique identifier for the CA.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#AuditStreamArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws:kinesis:.+:[0-9]{12}:stream/AmazonWorkLink-.*$" - } - }, - "com.amazonaws.worklink#AuthorizationProviderType": { - "type": "enum", - "members": { - "SAML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAML" - } - } - } - }, - "com.amazonaws.worklink#Boolean": { - "type": "boolean" - }, - "com.amazonaws.worklink#Certificate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 8192 - }, - "smithy.api#pattern": "^-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?$" - } - }, - "com.amazonaws.worklink#CertificateChain": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32768 - }, - "smithy.api#pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?$" - } - }, - "com.amazonaws.worklink#CompanyCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.worklink#CreateFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#CreateFleetRequest" - }, - "output": { - "target": "com.amazonaws.worklink#CreateFleetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Creates a fleet. A fleet consists of resources and the configuration that delivers\n associated websites to authorized users who download and set up the Amazon WorkLink app.

", - "smithy.api#http": { - "method": "POST", - "uri": "/createFleet", - "code": 200 - } - } - }, - "com.amazonaws.worklink#CreateFleetRequest": { - "type": "structure", - "members": { - "FleetName": { - "target": "com.amazonaws.worklink#FleetName", - "traits": { - "smithy.api#documentation": "

A unique name for the fleet.

", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The fleet name to display.

" - } - }, - "OptimizeForEndUserLocation": { - "target": "com.amazonaws.worklink#Boolean", - "traits": { - "smithy.api#documentation": "

The option to optimize for better performance by routing traffic through the closest\n AWS Region to users, which may be outside of your home Region.

" - } - }, - "Tags": { - "target": "com.amazonaws.worklink#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the resource. A tag is a key-value pair.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#CreateFleetResponse": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DateTime": { - "type": "timestamp" - }, - "com.amazonaws.worklink#DeleteFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DeleteFleetRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DeleteFleetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Deletes a fleet. Prevents users from accessing previously associated websites.

", - "smithy.api#http": { - "method": "POST", - "uri": "/deleteFleet", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DeleteFleetRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DeleteFleetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DescribeAuditStreamConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DescribeAuditStreamConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DescribeAuditStreamConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Describes the configuration for delivering audit streams to the customer account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeAuditStreamConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DescribeAuditStreamConfigurationRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DescribeAuditStreamConfigurationResponse": { - "type": "structure", - "members": { - "AuditStreamArn": { - "target": "com.amazonaws.worklink#AuditStreamArn", - "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Kinesis data stream that will receive the audit events.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DescribeCompanyNetworkConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DescribeCompanyNetworkConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DescribeCompanyNetworkConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Describes the networking configuration to access the internal websites associated with\n the specified fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeCompanyNetworkConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DescribeCompanyNetworkConfigurationRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DescribeCompanyNetworkConfigurationResponse": { - "type": "structure", - "members": { - "VpcId": { - "target": "com.amazonaws.worklink#VpcId", - "traits": { - "smithy.api#documentation": "

The VPC with connectivity to associated websites.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.worklink#SubnetIds", - "traits": { - "smithy.api#documentation": "

The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.worklink#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

The security groups associated with access to the provided subnets.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DescribeDevice": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DescribeDeviceRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DescribeDeviceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Provides information about a user's device.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeDevice", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DescribeDevicePolicyConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DescribeDevicePolicyConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DescribeDevicePolicyConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Describes the device policy configuration for the specified fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeDevicePolicyConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DescribeDevicePolicyConfigurationRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DescribeDevicePolicyConfigurationResponse": { - "type": "structure", - "members": { - "DeviceCaCertificate": { - "target": "com.amazonaws.worklink#Certificate", - "traits": { - "smithy.api#documentation": "

The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DescribeDeviceRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "DeviceId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

A unique identifier for a registered user's device.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DescribeDeviceResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.worklink#DeviceStatus", - "traits": { - "smithy.api#documentation": "

The current state of the device.

" - } - }, - "Model": { - "target": "com.amazonaws.worklink#DeviceModel", - "traits": { - "smithy.api#documentation": "

The model of the device.

" - } - }, - "Manufacturer": { - "target": "com.amazonaws.worklink#DeviceManufacturer", - "traits": { - "smithy.api#documentation": "

The manufacturer of the device.

" - } - }, - "OperatingSystem": { - "target": "com.amazonaws.worklink#DeviceOperatingSystemName", - "traits": { - "smithy.api#documentation": "

The operating system of the device.

" - } - }, - "OperatingSystemVersion": { - "target": "com.amazonaws.worklink#DeviceOperatingSystemVersion", - "traits": { - "smithy.api#documentation": "

The operating system version of the device.

" - } - }, - "PatchLevel": { - "target": "com.amazonaws.worklink#DevicePatchLevel", - "traits": { - "smithy.api#documentation": "

The operating system patch level of the device.

" - } - }, - "FirstAccessedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The date that the device first signed in to Amazon WorkLink.

" - } - }, - "LastAccessedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The date that the device last accessed Amazon WorkLink.

" - } - }, - "Username": { - "target": "com.amazonaws.worklink#Username", - "traits": { - "smithy.api#documentation": "

The user name associated with the device.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DescribeDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DescribeDomainRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DescribeDomainResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Provides information about the domain.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeDomain", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DescribeDomainRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DescribeDomainResponse": { - "type": "structure", - "members": { - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

" - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The name to display.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the domain was added.

" - } - }, - "DomainStatus": { - "target": "com.amazonaws.worklink#DomainStatus", - "traits": { - "smithy.api#documentation": "

The current state for the domain.

" - } - }, - "AcmCertificateArn": { - "target": "com.amazonaws.worklink#AcmCertificateArn", - "traits": { - "smithy.api#documentation": "

The ARN of an issued ACM certificate that is valid for the domain being associated.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DescribeFleetMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DescribeFleetMetadataRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DescribeFleetMetadataResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Provides basic information for the specified fleet, excluding identity provider,\n networking, and device configuration details.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeFleetMetadata", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DescribeFleetMetadataRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DescribeFleetMetadataResponse": { - "type": "structure", - "members": { - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the fleet was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the fleet was last updated.

" - } - }, - "FleetName": { - "target": "com.amazonaws.worklink#FleetName", - "traits": { - "smithy.api#documentation": "

The name of the fleet.

" - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The name to display.

" - } - }, - "OptimizeForEndUserLocation": { - "target": "com.amazonaws.worklink#Boolean", - "traits": { - "smithy.api#documentation": "

The option to optimize for better performance by routing traffic through the closest\n AWS Region to users, which may be outside of your home Region.

" - } - }, - "CompanyCode": { - "target": "com.amazonaws.worklink#CompanyCode", - "traits": { - "smithy.api#documentation": "

The identifier used by users to sign in to the Amazon WorkLink app.

" - } - }, - "FleetStatus": { - "target": "com.amazonaws.worklink#FleetStatus", - "traits": { - "smithy.api#documentation": "

The current state of the fleet.

" - } - }, - "Tags": { - "target": "com.amazonaws.worklink#TagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the resource. A tag is a key-value pair.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DescribeIdentityProviderConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DescribeIdentityProviderConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DescribeIdentityProviderConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Describes the identity provider configuration of the specified fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeIdentityProviderConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DescribeIdentityProviderConfigurationRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DescribeIdentityProviderConfigurationResponse": { - "type": "structure", - "members": { - "IdentityProviderType": { - "target": "com.amazonaws.worklink#IdentityProviderType", - "traits": { - "smithy.api#documentation": "

The type of identity provider.

" - } - }, - "ServiceProviderSamlMetadata": { - "target": "com.amazonaws.worklink#SamlMetadata", - "traits": { - "smithy.api#documentation": "

The SAML metadata document uploaded to the user’s identity provider.

" - } - }, - "IdentityProviderSamlMetadata": { - "target": "com.amazonaws.worklink#SamlMetadata", - "traits": { - "smithy.api#documentation": "

The SAML metadata document provided by the user’s identity provider.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DescribeWebsiteCertificateAuthority": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DescribeWebsiteCertificateAuthorityRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DescribeWebsiteCertificateAuthorityResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Provides information about the certificate authority.

", - "smithy.api#http": { - "method": "POST", - "uri": "/describeWebsiteCertificateAuthority", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DescribeWebsiteCertificateAuthorityRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "WebsiteCaId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

A unique identifier for the certificate authority.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DescribeWebsiteCertificateAuthorityResponse": { - "type": "structure", - "members": { - "Certificate": { - "target": "com.amazonaws.worklink#Certificate", - "traits": { - "smithy.api#documentation": "

The root certificate of the certificate authority.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the certificate authority was added.

" - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The certificate name to display.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DeviceManufacturer": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.worklink#DeviceModel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.worklink#DeviceOperatingSystemName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.worklink#DeviceOperatingSystemVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.worklink#DevicePatchLevel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.worklink#DeviceStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "SIGNED_OUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SIGNED_OUT" - } - } - } - }, - "com.amazonaws.worklink#DeviceSummary": { - "type": "structure", - "members": { - "DeviceId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

The ID of the device.

" - } - }, - "DeviceStatus": { - "target": "com.amazonaws.worklink#DeviceStatus", - "traits": { - "smithy.api#documentation": "

The status of the device.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary of devices.

" - } - }, - "com.amazonaws.worklink#DeviceSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.worklink#DeviceSummary" - } - }, - "com.amazonaws.worklink#DisassociateDomain": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DisassociateDomainRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DisassociateDomainResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

", - "smithy.api#http": { - "method": "POST", - "uri": "/disassociateDomain", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DisassociateDomainRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DisassociateDomainResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DisassociateWebsiteAuthorizationProvider": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DisassociateWebsiteAuthorizationProviderRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DisassociateWebsiteAuthorizationProviderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Disassociates a website authorization provider from a specified fleet. After the\n disassociation, users can't load any associated websites that require this authorization\n provider.

", - "smithy.api#http": { - "method": "POST", - "uri": "/disassociateWebsiteAuthorizationProvider", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DisassociateWebsiteAuthorizationProviderRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "AuthorizationProviderId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

A unique identifier for the authorization provider.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DisassociateWebsiteAuthorizationProviderResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DisassociateWebsiteCertificateAuthority": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#DisassociateWebsiteCertificateAuthorityRequest" - }, - "output": { - "target": "com.amazonaws.worklink#DisassociateWebsiteCertificateAuthorityResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Removes a certificate authority (CA).

", - "smithy.api#http": { - "method": "POST", - "uri": "/disassociateWebsiteCertificateAuthority", - "code": 200 - } - } - }, - "com.amazonaws.worklink#DisassociateWebsiteCertificateAuthorityRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "WebsiteCaId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

A unique identifier for the CA.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#DisassociateWebsiteCertificateAuthorityResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#DisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.worklink#DomainName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 253 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\\.)+[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.worklink#DomainStatus": { - "type": "enum", - "members": { - "PENDING_VALIDATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VALIDATION" - } - }, - "ASSOCIATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSOCIATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "DISASSOCIATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISASSOCIATING" - } - }, - "DISASSOCIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISASSOCIATED" - } - }, - "FAILED_TO_ASSOCIATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_TO_ASSOCIATE" - } - }, - "FAILED_TO_DISASSOCIATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_TO_DISASSOCIATE" - } - } - } - }, - "com.amazonaws.worklink#DomainSummary": { - "type": "structure", - "members": { - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The name to display.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the domain was created.

", - "smithy.api#required": {} - } - }, - "DomainStatus": { - "target": "com.amazonaws.worklink#DomainStatus", - "traits": { - "smithy.api#documentation": "

The status of the domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary of the domain.

" - } - }, - "com.amazonaws.worklink#DomainSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.worklink#DomainSummary" - } - }, - "com.amazonaws.worklink#ExceptionMessage": { - "type": "string" - }, - "com.amazonaws.worklink#FleetArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.worklink#FleetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 48 - }, - "smithy.api#pattern": "^[a-z0-9](?:[a-z0-9\\-]{0,46}[a-z0-9])?$" - } - }, - "com.amazonaws.worklink#FleetStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "FAILED_TO_CREATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_TO_CREATE" - } - }, - "FAILED_TO_DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_TO_DELETE" - } - } - } - }, - "com.amazonaws.worklink#FleetSummary": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time when the fleet was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time when the fleet was last updated.

" - } - }, - "FleetName": { - "target": "com.amazonaws.worklink#FleetName", - "traits": { - "smithy.api#documentation": "

The name of the fleet.

" - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The name of the fleet to display.

" - } - }, - "CompanyCode": { - "target": "com.amazonaws.worklink#CompanyCode", - "traits": { - "smithy.api#documentation": "

The identifier used by users to sign into the Amazon WorkLink app.

" - } - }, - "FleetStatus": { - "target": "com.amazonaws.worklink#FleetStatus", - "traits": { - "smithy.api#documentation": "

The status of the fleet.

" - } - }, - "Tags": { - "target": "com.amazonaws.worklink#TagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the resource. A tag is a key-value pair.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary of the fleet.

" - } - }, - "com.amazonaws.worklink#FleetSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.worklink#FleetSummary" - } - }, - "com.amazonaws.worklink#Id": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.worklink#IdentityProviderType": { - "type": "enum", - "members": { - "SAML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAML" - } - } - } - }, - "com.amazonaws.worklink#InternalServerErrorException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.worklink#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The service is temporarily unavailable.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.worklink#InvalidRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.worklink#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The request is not valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.worklink#ListDevices": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#ListDevicesRequest" - }, - "output": { - "target": "com.amazonaws.worklink#ListDevicesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Retrieves a list of devices registered with the specified fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listDevices", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.worklink#ListDevicesRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation. If\n this value is null, it retrieves the first page.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be included in the next page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#ListDevicesResponse": { - "type": "structure", - "members": { - "Devices": { - "target": "com.amazonaws.worklink#DeviceSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the devices.

" - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation. If\n there are no more pages, this value is null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#ListDomains": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#ListDomainsRequest" - }, - "output": { - "target": "com.amazonaws.worklink#ListDomainsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Retrieves a list of domains associated to a specified fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listDomains", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.worklink#ListDomainsRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation. If\n this value is null, it retrieves the first page.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be included in the next page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#ListDomainsResponse": { - "type": "structure", - "members": { - "Domains": { - "target": "com.amazonaws.worklink#DomainSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the domains.

" - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation. If\n there are no more pages, this value is null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#ListFleets": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#ListFleetsRequest" - }, - "output": { - "target": "com.amazonaws.worklink#ListFleetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Retrieves a list of fleets for the current account and Region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listFleets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.worklink#ListFleetsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation. If\n this value is null, it retrieves the first page.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be included in the next page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#ListFleetsResponse": { - "type": "structure", - "members": { - "FleetSummaryList": { - "target": "com.amazonaws.worklink#FleetSummaryList", - "traits": { - "smithy.api#documentation": "

The summary list of the fleets.

" - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation. If\n there are no more pages, this value is null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.worklink#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InvalidRequestException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Retrieves a list of tags for the specified resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.worklink#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.worklink#TagMap", - "traits": { - "smithy.api#documentation": "

The tags attached to the resource. A tag is a key-value pair.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#ListWebsiteAuthorizationProviders": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#ListWebsiteAuthorizationProvidersRequest" - }, - "output": { - "target": "com.amazonaws.worklink#ListWebsiteAuthorizationProvidersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Retrieves a list of website authorization providers associated with a specified fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listWebsiteAuthorizationProviders", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.worklink#ListWebsiteAuthorizationProvidersRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be included in the next page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#ListWebsiteAuthorizationProvidersResponse": { - "type": "structure", - "members": { - "WebsiteAuthorizationProviders": { - "target": "com.amazonaws.worklink#WebsiteAuthorizationProvidersSummaryList", - "traits": { - "smithy.api#documentation": "

The website authorization providers.

" - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#ListWebsiteCertificateAuthorities": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#ListWebsiteCertificateAuthoritiesRequest" - }, - "output": { - "target": "com.amazonaws.worklink#ListWebsiteCertificateAuthoritiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Retrieves a list of certificate authorities added for the current account and\n Region.

", - "smithy.api#http": { - "method": "POST", - "uri": "/listWebsiteCertificateAuthorities", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.worklink#ListWebsiteCertificateAuthoritiesRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.worklink#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be included in the next page.

" - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation. If\n this value is null, it retrieves the first page.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#ListWebsiteCertificateAuthoritiesResponse": { - "type": "structure", - "members": { - "WebsiteCertificateAuthorities": { - "target": "com.amazonaws.worklink#WebsiteCaSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the certificates.

" - } - }, - "NextToken": { - "target": "com.amazonaws.worklink#NextToken", - "traits": { - "smithy.api#documentation": "

The pagination token used to retrieve the next page of results for this operation. If\n there are no more pages, this value is null.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.worklink#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - }, - "smithy.api#pattern": "^[\\w\\-]+$" - } - }, - "com.amazonaws.worklink#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.worklink#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The resource already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.worklink#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.worklink#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The requested resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.worklink#RestoreDomainAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#RestoreDomainAccessRequest" - }, - "output": { - "target": "com.amazonaws.worklink#RestoreDomainAccessResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Moves a domain to ACTIVE status if it was in the INACTIVE status.

", - "smithy.api#http": { - "method": "POST", - "uri": "/restoreDomainAccess", - "code": 200 - } - } - }, - "com.amazonaws.worklink#RestoreDomainAccessRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#RestoreDomainAccessResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#RevokeDomainAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#RevokeDomainAccessRequest" - }, - "output": { - "target": "com.amazonaws.worklink#RevokeDomainAccessResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Moves a domain to INACTIVE status if it was in the ACTIVE status.

", - "smithy.api#http": { - "method": "POST", - "uri": "/revokeDomainAccess", - "code": 200 - } - } - }, - "com.amazonaws.worklink#RevokeDomainAccessRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#RevokeDomainAccessResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#SamlMetadata": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 204800 - } - } - }, - "com.amazonaws.worklink#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^sg-([0-9a-f]{8}|[0-9a-f]{17})$" - } - }, - "com.amazonaws.worklink#SecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.worklink#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.worklink#SignOutUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#SignOutUserRequest" - }, - "output": { - "target": "com.amazonaws.worklink#SignOutUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Signs the user out from all of their devices. The user can sign in again if they have\n valid credentials.

", - "smithy.api#http": { - "method": "POST", - "uri": "/signOutUser", - "code": 200 - } - } - }, - "com.amazonaws.worklink#SignOutUserRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "Username": { - "target": "com.amazonaws.worklink#Username", - "traits": { - "smithy.api#documentation": "

The name of the user.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#SignOutUserResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#SubnetId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^subnet-([0-9a-f]{8}|[0-9a-f]{17})$" - } - }, - "com.amazonaws.worklink#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.worklink#SubnetId" - } - }, - "com.amazonaws.worklink#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.worklink#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.worklink#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.worklink#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.worklink#TagKey" - }, - "value": { - "target": "com.amazonaws.worklink#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.worklink#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.worklink#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InvalidRequestException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.worklink#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.worklink#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the resource. A tag is a key-value pair.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.worklink#TooManyRequestsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.worklink#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

The number of requests exceeds the limit.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.worklink#UnauthorizedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.worklink#ExceptionMessage" - } - }, - "traits": { - "smithy.api#documentation": "

You are not authorized to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.worklink#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.worklink#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InvalidRequestException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Removes one or more tags from the specified resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.worklink#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the fleet.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.worklink#TagKeyList", - "traits": { - "smithy.api#documentation": "

The list of tag keys to remove from the resource.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#UpdateAuditStreamConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#UpdateAuditStreamConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.worklink#UpdateAuditStreamConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Updates the audit stream configuration for the fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/updateAuditStreamConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.worklink#UpdateAuditStreamConfigurationRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "AuditStreamArn": { - "target": "com.amazonaws.worklink#AuditStreamArn", - "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Kinesis data stream that receives the audit events.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#UpdateAuditStreamConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#UpdateCompanyNetworkConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#UpdateCompanyNetworkConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.worklink#UpdateCompanyNetworkConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Updates the company network configuration for the fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/updateCompanyNetworkConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.worklink#UpdateCompanyNetworkConfigurationRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.worklink#VpcId", - "traits": { - "smithy.api#documentation": "

The VPC with connectivity to associated websites.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.worklink#SubnetIds", - "traits": { - "smithy.api#documentation": "

The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

", - "smithy.api#required": {} - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.worklink#SecurityGroupIds", - "traits": { - "smithy.api#documentation": "

The security groups associated with access to the provided subnets.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#UpdateCompanyNetworkConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#UpdateDevicePolicyConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#UpdateDevicePolicyConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.worklink#UpdateDevicePolicyConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Updates the device policy configuration for the fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/updateDevicePolicyConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.worklink#UpdateDevicePolicyConfigurationRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "DeviceCaCertificate": { - "target": "com.amazonaws.worklink#CertificateChain", - "traits": { - "smithy.api#documentation": "

The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#UpdateDevicePolicyConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#UpdateDomainMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#UpdateDomainMetadataRequest" - }, - "output": { - "target": "com.amazonaws.worklink#UpdateDomainMetadataResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Updates domain metadata, such as DisplayName.

", - "smithy.api#http": { - "method": "POST", - "uri": "/updateDomainMetadata", - "code": 200 - } - } - }, - "com.amazonaws.worklink#UpdateDomainMetadataRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The name of the domain.

", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The name to display.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#UpdateDomainMetadataResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#UpdateFleetMetadata": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#UpdateFleetMetadataRequest" - }, - "output": { - "target": "com.amazonaws.worklink#UpdateFleetMetadataResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Updates fleet metadata, such as DisplayName.

", - "smithy.api#http": { - "method": "POST", - "uri": "/UpdateFleetMetadata", - "code": 200 - } - } - }, - "com.amazonaws.worklink#UpdateFleetMetadataRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The fleet name to display. The existing DisplayName is unset if null is passed.

" - } - }, - "OptimizeForEndUserLocation": { - "target": "com.amazonaws.worklink#Boolean", - "traits": { - "smithy.api#documentation": "

The option to optimize for better performance by routing traffic through the closest\n AWS Region to users, which may be outside of your home Region.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#UpdateFleetMetadataResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#UpdateIdentityProviderConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.worklink#UpdateIdentityProviderConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.worklink#UpdateIdentityProviderConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.worklink#InternalServerErrorException" - }, - { - "target": "com.amazonaws.worklink#InvalidRequestException" - }, - { - "target": "com.amazonaws.worklink#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.worklink#TooManyRequestsException" - }, - { - "target": "com.amazonaws.worklink#UnauthorizedException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "Amazon WorkLink is no longer supported. This will be removed in a future version of the SDK." - }, - "smithy.api#documentation": "

Updates the identity provider configuration for the fleet.

", - "smithy.api#http": { - "method": "POST", - "uri": "/updateIdentityProviderConfiguration", - "code": 200 - } - } - }, - "com.amazonaws.worklink#UpdateIdentityProviderConfigurationRequest": { - "type": "structure", - "members": { - "FleetArn": { - "target": "com.amazonaws.worklink#FleetArn", - "traits": { - "smithy.api#documentation": "

The ARN of the fleet.

", - "smithy.api#required": {} - } - }, - "IdentityProviderType": { - "target": "com.amazonaws.worklink#IdentityProviderType", - "traits": { - "smithy.api#documentation": "

The type of identity provider.

", - "smithy.api#required": {} - } - }, - "IdentityProviderSamlMetadata": { - "target": "com.amazonaws.worklink#SamlMetadata", - "traits": { - "smithy.api#documentation": "

The SAML metadata document provided by the customer’s identity provider. The existing\n IdentityProviderSamlMetadata is unset if null is passed.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.worklink#UpdateIdentityProviderConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.worklink#Username": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.worklink#VpcId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^vpc-([0-9a-f]{8}|[0-9a-f]{17})$" - } - }, - "com.amazonaws.worklink#WebsiteAuthorizationProviderSummary": { - "type": "structure", - "members": { - "AuthorizationProviderId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

A unique identifier for the authorization provider.

" - } - }, - "AuthorizationProviderType": { - "target": "com.amazonaws.worklink#AuthorizationProviderType", - "traits": { - "smithy.api#documentation": "

The authorization provider type.

", - "smithy.api#required": {} - } - }, - "DomainName": { - "target": "com.amazonaws.worklink#DomainName", - "traits": { - "smithy.api#documentation": "

The domain name of the authorization provider. This applies only to SAML-based\n authorization providers.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time of creation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary of the website authorization provider.

" - } - }, - "com.amazonaws.worklink#WebsiteAuthorizationProvidersSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.worklink#WebsiteAuthorizationProviderSummary" - } - }, - "com.amazonaws.worklink#WebsiteCaSummary": { - "type": "structure", - "members": { - "WebsiteCaId": { - "target": "com.amazonaws.worklink#Id", - "traits": { - "smithy.api#documentation": "

A unique identifier for the CA.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.worklink#DateTime", - "traits": { - "smithy.api#documentation": "

The time when the CA was added.

" - } - }, - "DisplayName": { - "target": "com.amazonaws.worklink#DisplayName", - "traits": { - "smithy.api#documentation": "

The name to display.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary of the certificate authority (CA).

" - } - }, - "com.amazonaws.worklink#WebsiteCaSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.worklink#WebsiteCaSummary" - } - }, - "com.amazonaws.worklink#WorkLink": { - "type": "service", - "version": "2018-09-25", - "operations": [ - { - "target": "com.amazonaws.worklink#AssociateDomain" - }, - { - "target": "com.amazonaws.worklink#AssociateWebsiteAuthorizationProvider" - }, - { - "target": "com.amazonaws.worklink#AssociateWebsiteCertificateAuthority" - }, - { - "target": "com.amazonaws.worklink#CreateFleet" - }, - { - "target": "com.amazonaws.worklink#DeleteFleet" - }, - { - "target": "com.amazonaws.worklink#DescribeAuditStreamConfiguration" - }, - { - "target": "com.amazonaws.worklink#DescribeCompanyNetworkConfiguration" - }, - { - "target": "com.amazonaws.worklink#DescribeDevice" - }, - { - "target": "com.amazonaws.worklink#DescribeDevicePolicyConfiguration" - }, - { - "target": "com.amazonaws.worklink#DescribeDomain" - }, - { - "target": "com.amazonaws.worklink#DescribeFleetMetadata" - }, - { - "target": "com.amazonaws.worklink#DescribeIdentityProviderConfiguration" - }, - { - "target": "com.amazonaws.worklink#DescribeWebsiteCertificateAuthority" - }, - { - "target": "com.amazonaws.worklink#DisassociateDomain" - }, - { - "target": "com.amazonaws.worklink#DisassociateWebsiteAuthorizationProvider" - }, - { - "target": "com.amazonaws.worklink#DisassociateWebsiteCertificateAuthority" - }, - { - "target": "com.amazonaws.worklink#ListDevices" - }, - { - "target": "com.amazonaws.worklink#ListDomains" - }, - { - "target": "com.amazonaws.worklink#ListFleets" - }, - { - "target": "com.amazonaws.worklink#ListTagsForResource" - }, - { - "target": "com.amazonaws.worklink#ListWebsiteAuthorizationProviders" - }, - { - "target": "com.amazonaws.worklink#ListWebsiteCertificateAuthorities" - }, - { - "target": "com.amazonaws.worklink#RestoreDomainAccess" - }, - { - "target": "com.amazonaws.worklink#RevokeDomainAccess" - }, - { - "target": "com.amazonaws.worklink#SignOutUser" - }, - { - "target": "com.amazonaws.worklink#TagResource" - }, - { - "target": "com.amazonaws.worklink#UntagResource" - }, - { - "target": "com.amazonaws.worklink#UpdateAuditStreamConfiguration" - }, - { - "target": "com.amazonaws.worklink#UpdateCompanyNetworkConfiguration" - }, - { - "target": "com.amazonaws.worklink#UpdateDevicePolicyConfiguration" - }, - { - "target": "com.amazonaws.worklink#UpdateDomainMetadata" - }, - { - "target": "com.amazonaws.worklink#UpdateFleetMetadata" - }, - { - "target": "com.amazonaws.worklink#UpdateIdentityProviderConfiguration" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "WorkLink", - "arnNamespace": "worklink", - "cloudFormationName": "WorkLink", - "cloudTrailEventSource": "worklink.amazonaws.com", - "endpointPrefix": "worklink" - }, - "aws.auth#sigv4": { - "name": "worklink" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon WorkLink is a cloud-based service that provides secure access\n to internal websites and web apps from iOS and Android phones. In a single step, your users, such as\n employees, can access internal websites as efficiently as they access any other public website.\n They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink\n authenticates the user's access and securely renders authorized internal web content in a secure\n rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on\n mobile devices.

", - "smithy.api#title": "Amazon WorkLink", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://worklink-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://worklink-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://worklink.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://worklink.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://worklink-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://worklink.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://worklink-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://worklink.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://worklink-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://worklink.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://worklink.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - } - } -} diff --git a/codegen/sdk/aws-models/workspaces.json b/codegen/sdk/aws-models/workspaces.json index 664f150e199..b2815bb5f5f 100644 --- a/codegen/sdk/aws-models/workspaces.json +++ b/codegen/sdk/aws-models/workspaces.json @@ -2478,7 +2478,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates one or more WorkSpaces.

\n

This operation is asynchronous and returns before the WorkSpaces are created.

\n \n
    \n
  • \n

    The MANUAL running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see Amazon WorkSpaces\n Core.

    \n
    • \n
  • \n

    You don't need to specify the PCOIP protocol for Linux bundles\n because WSP is the default protocol for those bundles.

    \n
    • \n
  • \n

    User-decoupled WorkSpaces are only supported by Amazon WorkSpaces\n Core.

    \n
    • \n
  • \n

    Review your running mode to ensure you are using one that is optimal for your needs and budget.\n For more information on switching running modes, see \n \n Can I switch between hourly and monthly billing?\n

    \n
    • \n
\n " + "smithy.api#documentation": "

Creates one or more WorkSpaces.

\n

This operation is asynchronous and returns before the WorkSpaces are created.

\n \n
    \n
  • \n

    The MANUAL running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see Amazon WorkSpaces\n Core.

    \n
    • \n
  • \n

    You don't need to specify the PCOIP protocol for Linux bundles\n because DCV (formerly WSP) is the default protocol for those bundles.

    \n
    • \n
  • \n

    User-decoupled WorkSpaces are only supported by Amazon WorkSpaces\n Core.

    \n
    • \n
  • \n

    Review your running mode to ensure you are using one that is optimal for your needs and budget.\n For more information on switching running modes, see \n \n Can I switch between hourly and monthly billing?\n

    \n
    • \n
\n " } }, "com.amazonaws.workspaces#CreateWorkspacesPool": { @@ -5464,7 +5464,7 @@ "com.amazonaws.workspaces#DomainName": { "type": "string", "traits": { - "smithy.api#pattern": "^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+$" + "smithy.api#pattern": "^([a-zA-Z0-9]+[.-])+([a-zA-Z0-9])+$" } }, "com.amazonaws.workspaces#Ec2ImageId": { @@ -5996,7 +5996,7 @@ "IngestionProcess": { "target": "com.amazonaws.workspaces#WorkspaceImageIngestionProcess", "traits": { - "smithy.api#documentation": "

The ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol \n (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in \n _WSP. To use PCoIP, specify a value that does not end in _WSP. \n To use BYOP, specify a value that ends in _BYOP.

\n

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify \n BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, \n depending on the protocol.

\n \n

The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values\n are only supported by Amazon WorkSpaces Core. Contact your account team to be\n allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

\n ", + "smithy.api#documentation": "

The ingestion process to be used when importing the image, depending on which protocol\n you want to use for your BYOL Workspace image, either PCoIP, DCV, or \n bring your own protocol (BYOP). To use WSP, specify a value that ends in \n _DCV. To use PCoIP, specify a value that does not end in _DCV. \n To use BYOP, specify a value that ends in _BYOP.

\n

For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify \n BYOL_REGULAR, BYOL_REGULAR_DCV, or BYOL_REGULAR_BYOP, \n depending on the protocol.

\n \n

The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values\n are only supported by Amazon WorkSpaces Core. Contact your account team to be\n allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

\n ", "smithy.api#required": {} } }, @@ -6023,7 +6023,7 @@ "Applications": { "target": "com.amazonaws.workspaces#ApplicationList", "traits": { - "smithy.api#documentation": "

If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.

\n \n
    \n
  • \n

    Although this parameter is an array, only one item is allowed at this\n time.

    \n
    • \n
  • \n

    During the image import process, non-GPU WSP WorkSpaces with Windows 11 support\n only Microsoft_Office_2019. GPU WSP WorkSpaces with Windows 11 do not\n support Office installation.

    \n
    • \n
\n " + "smithy.api#documentation": "

If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11\n BYOL images. For more information about subscribing to Office for BYOL images, see Bring\n Your Own Windows Desktop Licenses.

\n \n
    \n
  • \n

    Although this parameter is an array, only one item is allowed at this\n time.

    \n
    • \n
  • \n

    During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support\n only Microsoft_Office_2019. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not\n support Office installation.

    \n
    • \n
\n " } } }, @@ -11023,7 +11023,7 @@ "Protocols": { "target": "com.amazonaws.workspaces#ProtocolList", "traits": { - "smithy.api#documentation": "

The protocol. For more information, see \n \n Protocols for Amazon WorkSpaces.

\n \n
    \n
  • \n

    Only available for WorkSpaces created with PCoIP bundles.

    \n
    • \n
  • \n

    The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

    \n
    • \n
  • \n

    Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles \n (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

    \n
    • \n
\n " + "smithy.api#documentation": "

The protocol. For more information, see \n \n Protocols for Amazon WorkSpaces.

\n \n
    \n
  • \n

    Only available for WorkSpaces created with PCoIP bundles.

    \n
    • \n
  • \n

    The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).

    \n
    • \n
  • \n

    Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles \n (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

    \n
    • \n
\n " } }, "OperatingSystemName": { diff --git a/codegen/sdk/packages.json b/codegen/sdk/packages.json index e37b2af647a..31ae492dac6 100644 --- a/codegen/sdk/packages.json +++ b/codegen/sdk/packages.json @@ -1260,6 +1260,12 @@ "artifactName": "marketplacemetering", "brazilName": "AwsSdkKotlinMarketplaceMetering" }, + { + "sdkId": "Marketplace Reporting", + "namespace": "aws.sdk.kotlin.services.marketplacereporting", + "artifactName": "marketplacereporting", + "brazilName": "AwsSdkKotlinMarketplaceReporting" + }, { "sdkId": "MediaConnect", "namespace": "aws.sdk.kotlin.services.mediaconnect", @@ -1938,6 +1944,12 @@ "artifactName": "snowball", "brazilName": "AwsSdkKotlinSnowball" }, + { + "sdkId": "SocialMessaging", + "namespace": "aws.sdk.kotlin.services.socialmessaging", + "artifactName": "socialmessaging", + "brazilName": "AwsSdkKotlinSocialmessaging" + }, { "sdkId": "Ssm Sap", "namespace": "aws.sdk.kotlin.services.ssmsap", @@ -2082,12 +2094,6 @@ "artifactName": "workdocs", "brazilName": "AwsSdkKotlinWorkdocs" }, - { - "sdkId": "WorkLink", - "namespace": "aws.sdk.kotlin.services.worklink", - "artifactName": "worklink", - "brazilName": "AwsSdkKotlinWorklink" - }, { "sdkId": "WorkMail", "namespace": "aws.sdk.kotlin.services.workmail", diff --git a/gradle.properties b/gradle.properties index 33b154849ab..429d4153548 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true org.gradle.jvmargs=-Xmx6g -XX:MaxMetaspaceSize=2G # sdk -sdkVersion=1.3.39-SNAPSHOT +sdkVersion=1.3.59-SNAPSHOT # dokka config (values specified at build-time as needed) smithyKotlinDocBaseUrl=https://sdk.amazonaws.com/kotlin/api/smithy-kotlin/api/$smithyKotlinRuntimeVersion/ diff --git a/gradle/init-codeartifact.gradle b/gradle/init-codeartifact.gradle deleted file mode 100644 index 7f879e0d840..00000000000 --- a/gradle/init-codeartifact.gradle +++ /dev/null @@ -1,14 +0,0 @@ -// Add code artifact as a repository (used for CI/CD) -// `./gradlew --init-script gradle/init-codeartifact.gradle -q showRepos` -allprojects { - repositories { - maven { - name = "awsCodeArtifact" - url = project.findProperty("codeartifact.url") - credentials { - username = "aws" - password = project.findProperty("codeartifact.token") ?: System.getenv("CODEARTIFACT_TOKEN") - } - } - } -} diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 51cc7d96d88..ff7f078ab27 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -1,27 +1,27 @@ [versions] -kotlin-version = "2.0.10" +kotlin-version = "2.0.21" dokka-version = "1.9.10" -aws-kotlin-repo-tools-version = "0.4.10" +aws-kotlin-repo-tools-version = "0.4.13" # libs coroutines-version = "1.9.0" -atomicfu-version = "0.24.0" +atomicfu-version = "0.25.0" # smithy-kotlin codegen and runtime are versioned separately -smithy-kotlin-runtime-version = "1.3.12" -smithy-kotlin-codegen-version = "0.33.12" +smithy-kotlin-runtime-version = "1.3.17" +smithy-kotlin-codegen-version = "0.33.17" # codegen -smithy-version = "1.50.0" +smithy-version = "1.51.0" # testing -junit-version = "5.10.1" -kotest-version = "5.8.0" -kotlinx-benchmark-version = "0.4.9" -kotlinx-serialization-version = "1.6.2" -mockk-version = "1.13.7" -slf4j-version = "2.0.9" +junit-version = "5.10.5" +kotest-version = "5.9.1" +kotlinx-benchmark-version = "0.4.12" +kotlinx-serialization-version = "1.7.3" +mockk-version = "1.13.13" +slf4j-version = "2.0.16" [libraries] aws-kotlin-repo-tools-build-support = { module="aws.sdk.kotlin.gradle:build-support", version.ref = "aws-kotlin-repo-tools-version" } diff --git a/services/route53/common/src/aws/sdk/kotlin/services/route53/internal/ChangeResourceRecordSetsUnmarshalling.kt b/services/route53/common/src/aws/sdk/kotlin/services/route53/internal/ChangeResourceRecordSetsUnmarshalling.kt deleted file mode 100644 index e61e2a62021..00000000000 --- a/services/route53/common/src/aws/sdk/kotlin/services/route53/internal/ChangeResourceRecordSetsUnmarshalling.kt +++ /dev/null @@ -1,49 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ -package aws.sdk.kotlin.services.route53.internal - -import aws.sdk.kotlin.services.route53.model.InvalidChangeBatch -import aws.smithy.kotlin.runtime.awsprotocol.ErrorDetails -import aws.smithy.kotlin.runtime.serde.xml.* - -internal fun parseRestXmlInvalidChangeBatchResponse(payload: ByteArray): InvalidChangeBatchErrorResponse? = - deserializeInvalidChangeBatchError(InvalidChangeBatch.Builder(), payload) - -internal fun deserializeInvalidChangeBatchError(builder: InvalidChangeBatch.Builder, payload: ByteArray): InvalidChangeBatchErrorResponse? { - val root = xmlTagReader(payload) - var requestId: String? = null - - loop@while (true) { - val curr = root.nextTag() ?: break@loop - when (curr.tagName) { - "Message", "message" -> builder.message = curr.data() - "Messages", "messages" -> builder.messages = deserializeMessages(curr) - "RequestId" -> requestId = curr.data() - } - curr.drop() - } - - return InvalidChangeBatchErrorResponse(ErrorDetails("InvalidChangeBatch", builder.message, requestId), builder.build()) -} - -private fun deserializeMessages(root: XmlTagReader): List { - val result = mutableListOf() - loop@while (true) { - val curr = root.nextTag() ?: break@loop - when (curr.tagName) { - "Message" -> { - val el = curr.tryData().getOrNull() ?: continue@loop - result.add(el) - } - } - } - - return result -} - -internal data class InvalidChangeBatchErrorResponse( - val errorDetails: ErrorDetails, - val exception: InvalidChangeBatch, -) diff --git a/services/route53/common/test/aws/sdk/kotlin/services/route53/internal/ChangeResourceRecordSetsUnmarshallingTest.kt b/services/route53/common/test/aws/sdk/kotlin/services/route53/internal/ChangeResourceRecordSetsUnmarshallingTest.kt deleted file mode 100644 index 3b4ecff446d..00000000000 --- a/services/route53/common/test/aws/sdk/kotlin/services/route53/internal/ChangeResourceRecordSetsUnmarshallingTest.kt +++ /dev/null @@ -1,109 +0,0 @@ -/* - * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. - * SPDX-License-Identifier: Apache-2.0 - */ -package aws.sdk.kotlin.services.route53.internal - -import aws.sdk.kotlin.services.route53.model.InvalidChangeBatch -import aws.sdk.kotlin.services.route53.serde.ChangeResourceRecordSetsOperationDeserializer -import aws.smithy.kotlin.runtime.http.Headers -import aws.smithy.kotlin.runtime.http.HttpBody -import aws.smithy.kotlin.runtime.http.HttpCall -import aws.smithy.kotlin.runtime.http.HttpStatusCode -import aws.smithy.kotlin.runtime.http.request.HttpRequestBuilder -import aws.smithy.kotlin.runtime.http.response.HttpResponse -import aws.smithy.kotlin.runtime.operation.ExecutionContext -import kotlinx.coroutines.runBlocking -import kotlin.test.Test -import kotlin.test.assertEquals -import kotlin.test.assertFailsWith - -class ChangeResourceRecordSetsUnmarshallingTest { - @Test - fun invalidChangeBatchMessage() { - val bodyText = """ - - - - InvalidChangeBatch message - - b25f48e8-84fd-11e6-80d9-574e0c4664cb - - """.trimIndent() - - val response = HttpResponse( - HttpStatusCode.BadRequest, - Headers.Empty, - HttpBody.fromBytes(bodyText.encodeToByteArray()), - ) - - val call = HttpCall(HttpRequestBuilder().build(), response) - - val exception = assertFailsWith { - runBlocking { - ChangeResourceRecordSetsOperationDeserializer().deserialize(ExecutionContext(), call, bodyText.encodeToByteArray()) - } - } - assertEquals(listOf("InvalidChangeBatch message"), exception.messages) - } - - @Test - fun invalidChangeBatchMessage2() { - val bodyText = """ - - - - InvalidChangeBatch message 1 - InvalidChangeBatch message 2 - - b25f48e8-84fd-11e6-80d9-574e0c4664cb - - """.trimIndent() - - val response: HttpResponse = HttpResponse( - HttpStatusCode.BadRequest, - Headers.Empty, - HttpBody.fromBytes(bodyText.encodeToByteArray()), - ) - - val call = HttpCall(HttpRequestBuilder().build(), response) - - val exception = assertFailsWith { - runBlocking { - ChangeResourceRecordSetsOperationDeserializer().deserialize(ExecutionContext(), call, bodyText.encodeToByteArray()) - } - } - assertEquals(listOf("InvalidChangeBatch message 1", "InvalidChangeBatch message 2"), exception.messages) - } - - @Test - fun invalidChangeBatchMessage3() { - val bodyText = """ - - - - InvalidChangeBatch message 1 - InvalidChangeBatch message 2 - - InvalidChangeBatch message 3 - b25f48e8-84fd-11e6-80d9-574e0c4664cb - - """.trimIndent() - - val response: HttpResponse = HttpResponse( - HttpStatusCode.BadRequest, - Headers.Empty, - HttpBody.fromBytes(bodyText.encodeToByteArray()), - ) - - val call = HttpCall(HttpRequestBuilder().build(), response) - - val exception = assertFailsWith { - runBlocking { - ChangeResourceRecordSetsOperationDeserializer().deserialize(ExecutionContext(), call, bodyText.encodeToByteArray()) - } - } - assertEquals(listOf("InvalidChangeBatch message 1", "InvalidChangeBatch message 2"), exception.messages) - assertEquals("InvalidChangeBatch message 3", exception.message) - } -} diff --git a/services/route53/e2eTest/src/InvalidChangeBatchTest.kt b/services/route53/e2eTest/src/InvalidChangeBatchTest.kt new file mode 100644 index 00000000000..cf5e50a1fa7 --- /dev/null +++ b/services/route53/e2eTest/src/InvalidChangeBatchTest.kt @@ -0,0 +1,74 @@ +/* + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. + * SPDX-License-Identifier: Apache-2.0 + */ +package aws.sdk.kotlin.services.route53 + +import aws.sdk.kotlin.services.route53.model.* +import aws.smithy.kotlin.runtime.util.Uuid +import kotlinx.coroutines.test.runTest +import kotlin.test.Test +import kotlin.test.assertFailsWith +import kotlin.test.assertNotNull + +// https://github.com/awslabs/aws-sdk-kotlin/issues/1433 +class InvalidChangeBatchTest { + @Test + fun testMessageIsPopulated() = runTest { + Route53Client { + region = "us-east-1" + }.use { client -> + val createHostedZoneResp = client.createHostedZone { + this.callerReference = Uuid.random().toString() + this.name = "this-is-a-test-hosted-zone-for-aws-sdk-kotlin.com" + } + + val hostedZoneId = checkNotNull(createHostedZoneResp.hostedZone?.id) { "Hosted zone is unexpectedly null" } + + try { + val exception = assertFailsWith { + client.changeResourceRecordSets { + this.hostedZoneId = hostedZoneId + this.changeBatch = ChangeBatch { + this.changes = listOf( + Change { + this.action = ChangeAction.Delete + this.resourceRecordSet = ResourceRecordSet { + this.name = "test.blerg.com" + this.type = RrType.Cname + this.ttl = 300 + this.resourceRecords = listOf( + ResourceRecord { + value = "test.blerg.com" + }, + ) + } + }, + Change { + this.action = ChangeAction.Create + this.resourceRecordSet = ResourceRecordSet { + this.name = "test.blerg.com" + this.type = RrType.Cname + this.ttl = 300 + this.resourceRecords = listOf( + ResourceRecord { + value = "test.blerg.com" + }, + ) + } + }, + ) + this.comment = "testing..." + } + } + } + + assertNotNull(exception.message) + } finally { + client.deleteHostedZone { + id = hostedZoneId + } + } + } + } +} diff --git a/services/s3/e2eTest/src/MutliRegionAccessPointTest.kt b/services/s3/e2eTest/src/MutliRegionAccessPointTest.kt index 9c3cb087fa6..49630763536 100644 --- a/services/s3/e2eTest/src/MutliRegionAccessPointTest.kt +++ b/services/s3/e2eTest/src/MutliRegionAccessPointTest.kt @@ -8,8 +8,8 @@ import aws.sdk.kotlin.e2etest.S3TestUtils.createMultiRegionAccessPoint import aws.sdk.kotlin.e2etest.S3TestUtils.deleteBucketAndAllContents import aws.sdk.kotlin.e2etest.S3TestUtils.deleteMultiRegionAccessPoint import aws.sdk.kotlin.e2etest.S3TestUtils.getAccountId +import aws.sdk.kotlin.e2etest.S3TestUtils.getBucketWithPrefix import aws.sdk.kotlin.e2etest.S3TestUtils.getMultiRegionAccessPointArn -import aws.sdk.kotlin.e2etest.S3TestUtils.getTestBucket import aws.sdk.kotlin.e2etest.S3TestUtils.multiRegionAccessPointWasCreated import aws.sdk.kotlin.services.s3.S3Client import aws.sdk.kotlin.services.s3.deleteObject @@ -27,6 +27,8 @@ import kotlin.test.Test import kotlin.test.assertEquals import kotlin.test.assertFailsWith +private const val MRAP_BUCKET_PREFIX = "s3-mrap-test-bucket-" + @TestInstance(TestInstance.Lifecycle.PER_CLASS) class MutliRegionAccessPointTest { private val s3West = S3Client { region = "us-west-2" } @@ -45,8 +47,8 @@ class MutliRegionAccessPointTest { @BeforeAll private fun setUp(): Unit = runBlocking { accountId = getAccountId() - usWestBucket = getTestBucket(s3West, "us-west-2", accountId) - usEastBucket = getTestBucket(s3East, "us-east-2", accountId) + usWestBucket = getBucketWithPrefix(s3West, MRAP_BUCKET_PREFIX, "us-west-2", accountId) + usEastBucket = getBucketWithPrefix(s3East, MRAP_BUCKET_PREFIX, "us-east-2", accountId) createMultiRegionAccessPoint( s3Control, diff --git a/services/s3/e2eTest/src/S3TestUtils.kt b/services/s3/e2eTest/src/S3TestUtils.kt index 91f8b846261..6247ac2f129 100644 --- a/services/s3/e2eTest/src/S3TestUtils.kt +++ b/services/s3/e2eTest/src/S3TestUtils.kt @@ -10,7 +10,6 @@ import aws.sdk.kotlin.services.s3.model.* import aws.sdk.kotlin.services.s3.model.BucketLocationConstraint import aws.sdk.kotlin.services.s3.model.ExpirationStatus import aws.sdk.kotlin.services.s3.model.LifecycleRule -import aws.sdk.kotlin.services.s3.model.LifecycleRuleFilter import aws.sdk.kotlin.services.s3.paginators.listObjectsV2Paginated import aws.sdk.kotlin.services.s3.waiters.waitUntilBucketExists import aws.sdk.kotlin.services.s3.waiters.waitUntilBucketNotExists @@ -46,11 +45,11 @@ object S3TestUtils { accountId: String? = null, ): String = getBucketWithPrefix(client, TEST_BUCKET_PREFIX, region, accountId) - private suspend fun getBucketWithPrefix( + suspend fun getBucketWithPrefix( client: S3Client, prefix: String, - region: String?, - accountId: String?, + region: String? = null, + accountId: String? = null, ): String = withTimeout(60.seconds) { val buckets = client.listBuckets() .buckets @@ -88,7 +87,7 @@ object S3TestUtils { rules = listOf( LifecycleRule { expiration { days = 1 } - filter = LifecycleRuleFilter.Prefix("") + filter { this.prefix = "" } status = ExpirationStatus.Enabled id = "delete-old" },